Close httplib2 connections.
distributeLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)
Distributes a LicenseConfig from billing account level to project level.
Gets a BillingAccountLicenseConfig.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all BillingAccountLicenseConfigs for a given billing account.
Retrieves the next page of results.
retractLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)
This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.
close()
Close httplib2 connections.
distributeLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)
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.
},
}
get(name, x__xgafv=None)
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.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
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.
}
list_next()
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.
retractLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)
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.
},
}