File: licensing_v1.licenseAssignments.html

package info (click to toggle)
python-googleapi 1.5.5-1
  • links: PTS
  • area: main
  • in suites: buster, stretch
  • size: 39,832 kB
  • ctags: 5,921
  • sloc: python: 7,176; makefile: 64; sh: 53; xml: 5
file content (323 lines) | stat: -rw-r--r-- 11,517 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="licensing_v1.html">Enterprise License Manager API</a> . <a href="licensing_v1.licenseAssignments.html">licenseAssignments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#delete">delete(productId, skuId, userId)</a></code></p>
<p class="firstline">Revoke License.</p>
<p class="toc_element">
  <code><a href="#get">get(productId, skuId, userId)</a></code></p>
<p class="firstline">Get license assignment of a particular product and sku for a user</p>
<p class="toc_element">
  <code><a href="#insert">insert(productId, skuId, body)</a></code></p>
<p class="firstline">Assign License.</p>
<p class="toc_element">
  <code><a href="#listForProduct">listForProduct(productId, customerId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List license assignments for given product of the customer.</p>
<p class="toc_element">
  <code><a href="#listForProductAndSku">listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List license assignments for given product and sku of the customer.</p>
<p class="toc_element">
  <code><a href="#listForProductAndSku_next">listForProductAndSku_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#listForProduct_next">listForProduct_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(productId, skuId, userId, body)</a></code></p>
<p class="firstline">Assign License. This method supports patch semantics.</p>
<p class="toc_element">
  <code><a href="#update">update(productId, skuId, userId, body)</a></code></p>
<p class="firstline">Assign License.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="delete">delete(productId, skuId, userId)</code>
  <pre>Revoke License.

Args:
  productId: string, Name for product (required)
  skuId: string, Name for sku (required)
  userId: string, email id or unique Id of the user (required)
</pre>
</div>

<div class="method">
    <code class="details" id="get">get(productId, skuId, userId)</code>
  <pre>Get license assignment of a particular product and sku for a user

Args:
  productId: string, Name for product (required)
  skuId: string, Name for sku (required)
  userId: string, email id or unique Id of the user (required)

Returns:
  An object of the form:

    { # Template for LiscenseAssignment Resource
    "skuId": "A String", # Name of the sku of the product.
    "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
    "userId": "A String", # Email id of the user.
    "etags": "A String", # ETag of the resource.
    "selfLink": "A String", # Link to this page.
    "productId": "A String", # Name of the product.
  }</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(productId, skuId, body)</code>
  <pre>Assign License.

Args:
  productId: string, Name for product (required)
  skuId: string, Name for sku (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Template for LicenseAssignment Insert request
    "userId": "A String", # Email id of the user
  }


Returns:
  An object of the form:

    { # Template for LiscenseAssignment Resource
    "skuId": "A String", # Name of the sku of the product.
    "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
    "userId": "A String", # Email id of the user.
    "etags": "A String", # ETag of the resource.
    "selfLink": "A String", # Link to this page.
    "productId": "A String", # Name of the product.
  }</pre>
</div>

<div class="method">
    <code class="details" id="listForProduct">listForProduct(productId, customerId, pageToken=None, maxResults=None)</code>
  <pre>List license assignments for given product of the customer.

Args:
  productId: string, Name for product (required)
  customerId: string, CustomerId represents the customer for whom licenseassignments are queried (required)
  pageToken: string, Token to fetch the next page.Optional. By default server will return first page
  maxResults: integer, Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.

Returns:
  An object of the form:

    { # LicesnseAssignment List for a given product/sku for a customer.
    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
    "items": [ # The LicenseAssignments in this page of results.
      { # Template for LiscenseAssignment Resource
        "skuId": "A String", # Name of the sku of the product.
        "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
        "userId": "A String", # Email id of the user.
        "etags": "A String", # ETag of the resource.
        "selfLink": "A String", # Link to this page.
        "productId": "A String", # Name of the product.
      },
    ],
    "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
    "etag": "A String", # ETag of the resource.
  }</pre>
</div>

<div class="method">
    <code class="details" id="listForProductAndSku">listForProductAndSku(productId, skuId, customerId, pageToken=None, maxResults=None)</code>
  <pre>List license assignments for given product and sku of the customer.

Args:
  productId: string, Name for product (required)
  skuId: string, Name for sku (required)
  customerId: string, CustomerId represents the customer for whom licenseassignments are queried (required)
  pageToken: string, Token to fetch the next page.Optional. By default server will return first page
  maxResults: integer, Maximum number of campaigns to return at one time. Must be positive. Optional. Default value is 100.

Returns:
  An object of the form:

    { # LicesnseAssignment List for a given product/sku for a customer.
    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
    "items": [ # The LicenseAssignments in this page of results.
      { # Template for LiscenseAssignment Resource
        "skuId": "A String", # Name of the sku of the product.
        "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
        "userId": "A String", # Email id of the user.
        "etags": "A String", # ETag of the resource.
        "selfLink": "A String", # Link to this page.
        "productId": "A String", # Name of the product.
      },
    ],
    "kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
    "etag": "A String", # ETag of the resource.
  }</pre>
</div>

<div class="method">
    <code class="details" id="listForProductAndSku_next">listForProductAndSku_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

<div class="method">
    <code class="details" id="listForProduct_next">listForProduct_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(productId, skuId, userId, body)</code>
  <pre>Assign License. This method supports patch semantics.

Args:
  productId: string, Name for product (required)
  skuId: string, Name for sku for which license would be revoked (required)
  userId: string, email id or unique Id of the user (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Template for LiscenseAssignment Resource
  "skuId": "A String", # Name of the sku of the product.
  "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
  "userId": "A String", # Email id of the user.
  "etags": "A String", # ETag of the resource.
  "selfLink": "A String", # Link to this page.
  "productId": "A String", # Name of the product.
}


Returns:
  An object of the form:

    { # Template for LiscenseAssignment Resource
    "skuId": "A String", # Name of the sku of the product.
    "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
    "userId": "A String", # Email id of the user.
    "etags": "A String", # ETag of the resource.
    "selfLink": "A String", # Link to this page.
    "productId": "A String", # Name of the product.
  }</pre>
</div>

<div class="method">
    <code class="details" id="update">update(productId, skuId, userId, body)</code>
  <pre>Assign License.

Args:
  productId: string, Name for product (required)
  skuId: string, Name for sku for which license would be revoked (required)
  userId: string, email id or unique Id of the user (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Template for LiscenseAssignment Resource
  "skuId": "A String", # Name of the sku of the product.
  "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
  "userId": "A String", # Email id of the user.
  "etags": "A String", # ETag of the resource.
  "selfLink": "A String", # Link to this page.
  "productId": "A String", # Name of the product.
}


Returns:
  An object of the form:

    { # Template for LiscenseAssignment Resource
    "skuId": "A String", # Name of the sku of the product.
    "kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
    "userId": "A String", # Email id of the user.
    "etags": "A String", # ETag of the resource.
    "selfLink": "A String", # Link to this page.
    "productId": "A String", # Name of the product.
  }</pre>
</div>

</body></html>