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

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

Information about users' licenses.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Immutable. Identifier. The fully qualified resource name of the license config. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}

↳ license_count int|string

Required. Number of licenses purchased.

↳ subscription_tier int

Required. Subscription tier information for the license config.

↳ state int

Output only. The state of the license config.

↳ auto_renew bool

Optional. Whether the license config should be auto renewed when it reaches the end date.

↳ start_date Google\Type\Date

Required. The start date.

↳ end_date Google\Type\Date

Optional. The planed end date.

↳ subscription_term int

Required. Subscription term.

↳ free_trial bool

Optional. Whether the license config is for free trial.

↳ gemini_bundle bool

Output only. Whether the license config is for Gemini bundle.

↳ early_terminated bool

Output only. Indication of whether the subscription is terminated earlier than the expiration date.

↳ early_termination_date Google\Type\Date

Output only. The date when the subscription is terminated earlier than the expiration date.

↳ last_user_update_time Google\Protobuf\Timestamp

Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike update_time, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).

getName

Immutable. Identifier. The fully qualified resource name of the license config. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}

Returns
Type Description
string

setName

Immutable. Identifier. The fully qualified resource name of the license config. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}

Parameter
Name Description
var string
Returns
Type Description
$this

getLicenseCount

Required. Number of licenses purchased.

Returns
Type Description
int|string

setLicenseCount

Required. Number of licenses purchased.

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

getSubscriptionTier

Required. Subscription tier information for the license config.

Returns
Type Description
int Enum of type SubscriptionTier.

setSubscriptionTier

Required. Subscription tier information for the license config.

Parameter
Name Description
var int

Enum of type SubscriptionTier.

Returns
Type Description
$this

getState

Output only. The state of the license config.

Returns
Type Description
int Enum of type State.

setState

Output only. The state of the license config.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getAutoRenew

Optional. Whether the license config should be auto renewed when it reaches the end date.

Returns
Type Description
bool

setAutoRenew

Optional. Whether the license config should be auto renewed when it reaches the end date.

Parameter
Name Description
var bool
Returns
Type Description
$this

getStartDate

Required. The start date.

Returns
Type Description
Google\Type\Date|null

hasStartDate

clearStartDate

setStartDate

Required. The start date.

Parameter
Name Description
var Google\Type\Date
Returns
Type Description
$this

getEndDate

Optional. The planed end date.

Returns
Type Description
Google\Type\Date|null

hasEndDate

clearEndDate

setEndDate

Optional. The planed end date.

Parameter
Name Description
var Google\Type\Date
Returns
Type Description
$this

getSubscriptionTerm

Required. Subscription term.

Returns
Type Description
int Enum of type SubscriptionTerm.

setSubscriptionTerm

Required. Subscription term.

Parameter
Name Description
var int

Enum of type SubscriptionTerm.

Returns
Type Description
$this

getFreeTrial

Optional. Whether the license config is for free trial.

Returns
Type Description
bool

setFreeTrial

Optional. Whether the license config is for free trial.

Parameter
Name Description
var bool
Returns
Type Description
$this

getGeminiBundle

Output only. Whether the license config is for Gemini bundle.

Returns
Type Description
bool

setGeminiBundle

Output only. Whether the license config is for Gemini bundle.

Parameter
Name Description
var bool
Returns
Type Description
$this

getEarlyTerminated

Output only. Indication of whether the subscription is terminated earlier than the expiration date.

Returns
Type Description
bool

setEarlyTerminated

Output only. Indication of whether the subscription is terminated earlier than the expiration date.

Parameter
Name Description
var bool
Returns
Type Description
$this

getEarlyTerminationDate

Output only. The date when the subscription is terminated earlier than the expiration date.

Returns
Type Description
Google\Type\Date|null

hasEarlyTerminationDate

clearEarlyTerminationDate

setEarlyTerminationDate

Output only. The date when the subscription is terminated earlier than the expiration date.

Parameter
Name Description
var Google\Type\Date
Returns
Type Description
$this

getLastUserUpdateTime

Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike update_time, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLastUserUpdateTime

clearLastUserUpdateTime

setLastUserUpdateTime

Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike update_time, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this