| <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_v1.html">Discovery Engine API</a> . <a href="discoveryengine_v1.billingAccounts.html">billingAccounts</a> . <a href="discoveryengine_v1.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="#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. |
| "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date. |
| "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3. |
| "earlyTerminationDate": { # 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 # Output only. The date when the subscription is terminated earlier than the expiration 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. |
| }, |
| "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="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. |
| "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date. |
| "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3. |
| "earlyTerminationDate": { # 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 # Output only. The date when the subscription is terminated earlier than the expiration 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. |
| }, |
| "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> |
