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
324
325
326
327
328
329
330
331
332
333
334
335
|
<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="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.billingAccounts.html">billingAccounts</a> . <a href="discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html">billingAccountLicenseConfigs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#distributeLicenseConfig">distributeLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Distributes a LicenseConfig from billing account level to project level.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a BillingAccountLicenseConfig.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all BillingAccountLicenseConfigs for a given billing account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#retractLicenseConfig">retractLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="distributeLicenseConfig">distributeLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)</code>
<pre>Distributes a LicenseConfig from billing account level to project level.
Args:
billingAccountLicenseConfig: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for LicenseConfigService.DistributeLicenseConfig method.
"licenseConfigId": "A String", # Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config.
"licenseCount": "A String", # Required. The number of licenses to distribute.
"location": "A String", # Required. The target GCP project region to distribute the license config to.
"projectNumber": "A String", # Required. The target GCP project number to distribute the license config to.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for LicenseConfigService.DistributeLicenseConfig method.
"licenseConfig": { # Information about users' licenses. # The updated or created LicenseConfig.
"alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
"alertEnrollments": [ # Optional. The enrollment state of each alert.
{ # The alert enrollment status.
"alertId": "A String", # Immutable. The id of an alert.
"enrollState": "A String", # Required. The enrollment status of a customer.
"notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
"a_key": "A String",
},
},
],
"alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
"contactDetails": [ # Optional. The contact details for each alert policy.
{ # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
"emailAddress": "A String", # Optional. The email address of the contact.
},
],
"languageCode": "A String", # Optional. The language code used for notifications
},
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"freeTrial": True or False, # Optional. Whether the license config is for free trial.
"geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle.
"licenseCount": "A String", # Required. Number of licenses purchased.
"name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"state": "A String", # Output only. The state of the license config.
"subscriptionTerm": "A String", # Required. Subscription term.
"subscriptionTier": "A String", # Required. Subscription tier information for the license config.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a BillingAccountLicenseConfig.
Args:
name: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Information about license configs at billing account level.
"autoRenew": True or False, # Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed subscription end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"geminiBundle": True or False, # Whether the license config is for Gemini bundle.
"licenseConfigDistributions": { # A map of LicenseConfig names to the number of licenses distributed to each. The key is the full resource name of the LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/{license_config}`. The value is the count of licenses allocated to it.
"a_key": "A String",
},
"licenseCount": "A String", # Required. The number of licenses purchased under this billing account license config.
"name": "A String", # Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config}`.
"procurementEntitlementId": "A String", # The procurement entitlement id of the subscription.
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The subscription start date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"state": "A String", # Output only. The state of the BillingAccountLicenseConfig.
"subscriptionDisplayName": "A String", # The subscription display name.
"subscriptionName": "A String", # Output only. The corresponding SubV3 subscription name.
"subscriptionTerm": "A String", # Required. The subscription term.
"subscriptionTier": "A String", # Required. The subscription tier.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all BillingAccountLicenseConfigs for a given billing account.
Args:
parent: string, Required. Format: `billingAccounts/{billing_account}`. (required)
pageSize: integer, Optional. Not supported.
pageToken: string, Optional. Not supported.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for LicenseConfigService.ListBillingAccountLicenseConfigs method.
"billingAccountLicenseConfigs": [ # All BillingAccountLicenseConfigs for the given billing account.
{ # Information about license configs at billing account level.
"autoRenew": True or False, # Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed subscription end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"geminiBundle": True or False, # Whether the license config is for Gemini bundle.
"licenseConfigDistributions": { # A map of LicenseConfig names to the number of licenses distributed to each. The key is the full resource name of the LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/{license_config}`. The value is the count of licenses allocated to it.
"a_key": "A String",
},
"licenseCount": "A String", # Required. The number of licenses purchased under this billing account license config.
"name": "A String", # Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config}`.
"procurementEntitlementId": "A String", # The procurement entitlement id of the subscription.
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The subscription start date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"state": "A String", # Output only. The state of the BillingAccountLicenseConfig.
"subscriptionDisplayName": "A String", # The subscription display name.
"subscriptionName": "A String", # Output only. The corresponding SubV3 subscription name.
"subscriptionTerm": "A String", # Required. The subscription term.
"subscriptionTier": "A String", # Required. The subscription tier.
},
],
"nextPageToken": "A String", # A token that can be sent as ListBillingAccountLicenseConfigsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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="retractLicenseConfig">retractLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)</code>
<pre>This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.
Args:
billingAccountLicenseConfig: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for LicenseConfigService.RetractLicenseConfig method.
"fullRetract": True or False, # Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.
"licenseConfig": "A String", # Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.
"licenseCount": "A String", # Optional. The number of licenses to retract. Only used when full_retract is false.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for LicenseConfigService.RetractLicenseConfig method.
"licenseConfig": { # Information about users' licenses. # The updated LicenseConfig.
"alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
"alertEnrollments": [ # Optional. The enrollment state of each alert.
{ # The alert enrollment status.
"alertId": "A String", # Immutable. The id of an alert.
"enrollState": "A String", # Required. The enrollment status of a customer.
"notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
"a_key": "A String",
},
},
],
"alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
"contactDetails": [ # Optional. The contact details for each alert policy.
{ # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
"emailAddress": "A String", # Optional. The email address of the contact.
},
],
"languageCode": "A String", # Optional. The language code used for notifications
},
"autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The planed end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"freeTrial": True or False, # Optional. Whether the license config is for free trial.
"geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle.
"licenseCount": "A String", # Required. Number of licenses purchased.
"name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The start date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"state": "A String", # Output only. The state of the license config.
"subscriptionTerm": "A String", # Required. Subscription term.
"subscriptionTier": "A String", # Required. Subscription tier information for the license config.
},
}</pre>
</div>
</body></html>
|
