Google Cloud Discovery Engine V1 Client - Class RetractLicenseConfigRequest (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class RetractLicenseConfigRequest.

Request message for LicenseConfigService.RetractLicenseConfig method.

Generated from protobuf message google.cloud.discoveryengine.v1.RetractLicenseConfigRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ billing_account_license_config string

Required. Full resource name of BillingAccountLicenseConfig. Format: billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}.

↳ license_config string

Required. Full resource name of LicenseConfig. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config_id}.

↳ full_retract bool

Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.

↳ license_count int|string

Optional. The number of licenses to retract. Only used when full_retract is false.

getBillingAccountLicenseConfig

Required. Full resource name of BillingAccountLicenseConfig.

Format: billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}.

Returns
Type Description
string

setBillingAccountLicenseConfig

Required. Full resource name of BillingAccountLicenseConfig.

Format: billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getLicenseConfig

Required. Full resource name of LicenseConfig.

Format: projects/{project}/locations/{location}/licenseConfigs/{license_config_id}.

Returns
Type Description
string

setLicenseConfig

Required. Full resource name of LicenseConfig.

Format: projects/{project}/locations/{location}/licenseConfigs/{license_config_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getFullRetract

Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.

Returns
Type Description
bool

setFullRetract

Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.

Parameter
Name Description
var bool
Returns
Type Description
$this

getLicenseCount

Optional. The number of licenses to retract. Only used when full_retract is false.

Returns
Type Description
int|string

setLicenseCount

Optional. The number of licenses to retract. Only used when full_retract is false.

Parameter
Name Description
var int|string
Returns
Type Description
$this

static::build

Parameters
Name Description
billingAccountLicenseConfig string

Required. Full resource name of BillingAccountLicenseConfig.

Format: billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}. Please see LicenseConfigServiceClient::billingAccountLicenseConfigName() for help formatting this field.

licenseConfig string

Required. Full resource name of LicenseConfig.

Format: projects/{project}/locations/{location}/licenseConfigs/{license_config_id}. Please see LicenseConfigServiceClient::licenseConfigName() for help formatting this field.

fullRetract bool

Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.

licenseCount int

Optional. The number of licenses to retract. Only used when full_retract is false.

Returns
Type Description
RetractLicenseConfigRequest