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

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

Per-model Agent Search TPM subscription status. One entry per active core_subscription.agent_search_token_subscriptions[*] entry in the customer-provided config; populated by UpdateProject and GetProject.

The lifecycle scalars on this message (start_time, terminate_time, update_type, tpm_threshold_next_update_time) are per (project, model_version) — siblings of the whole-relationship start_time / terminate_time / update_type on the enclosing ConfigurableBillingStatus, but scoped to this specific Agent Search TPM subscription instead of to the overall customer-configurable- pricing relationship. This per-instance granularity is intentional: the underlying SubV3 storage is per-(project, model_version), so each model has its own activation, termination, and deferred-update clock; surfacing that on the response gives customers the granularity they need to manage per-model commitments independently. QPM / IndexingCore differ — their storage is one row per (project, location), so their lifecycle is represented only by the whole- relationship scalars on ConfigurableBillingStatus.

Generated from protobuf message google.cloud.discoveryengine.v1.Project.ConfigurableBillingStatus.AgentSearchTokenSubscriptionStatus

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ Project \ ConfigurableBillingStatus

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ model_version string

Output only. The Gemini model version this status corresponds to. Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).

↳ effective_tpm_threshold int|string

Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching effective_search_qpm_threshold semantics.

↳ tpm_threshold_next_update_time Google\Protobuf\Timestamp

Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.

↳ start_time Google\Protobuf\Timestamp

Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship start_time on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.

↳ terminate_time Google\Protobuf\Timestamp

Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate. Populated when the customer removes this entry from core_subscription.agent_search_token_subscriptions[*]. Does NOT move the whole-relationship terminate_time on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.

↳ update_type int

Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. UPDATE_TYPE_UNSPECIFIED indicates this model_version was not touched by the most recent UpdateProject (its effective_tpm_threshold reflects an earlier update). The whole-relationship update_type on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).

getModelVersion

Output only. The Gemini model version this status corresponds to.

Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).

Returns
Type Description
string

setModelVersion

Output only. The Gemini model version this status corresponds to.

Matches CoreSubscription.AgentSearchTokenSubscription.model_version (a stable Gemini model version from the Gemini Enterprise Agent Platform model-versions registry; see https://docs.cloud.google.com/gemini-enterprise-agent-platform/models/model-versions#gemini-models).

Parameter
Name Description
var string
Returns
Type Description
$this

getEffectiveTpmThreshold

Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching effective_search_qpm_threshold semantics.

Returns
Type Description
int|string

setEffectiveTpmThreshold

Output only. The currently effective TPM threshold. Reflects scale-up immediately and scale-down at the next billing cycle, matching effective_search_qpm_threshold semantics.

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

getTpmThresholdNextUpdateTime

Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasTpmThresholdNextUpdateTime

clearTpmThresholdNextUpdateTime

setTpmThresholdNextUpdateTime

Output only. The earliest next update time for the TPM subscription threshold for this (project, model_version). Populated only after a successful update.

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

getStartTime

Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship start_time on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Output only. When this (project, model_version) Agent Search TPM subscription was first activated. Set once on first activation of this model version and never moved by subsequent threshold updates; on termination + re-activation a new value is recorded. Does NOT move the whole-relationship start_time on the enclosing ConfigurableBillingStatus, which continues to represent the first activation of the overall customer-configurable-pricing relationship.

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

getTerminateTime

Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate.

Populated when the customer removes this entry from core_subscription.agent_search_token_subscriptions[*]. Does NOT move the whole-relationship terminate_time on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasTerminateTime

clearTerminateTime

setTerminateTime

Output only. If set, the scheduled effective time at which this (project, model_version) Agent Search TPM subscription will terminate.

Populated when the customer removes this entry from core_subscription.agent_search_token_subscriptions[*]. Does NOT move the whole-relationship terminate_time on the enclosing ConfigurableBillingStatus, which is populated only when the entire customer-configurable-pricing relationship is being torn down.

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

getUpdateType

Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. UPDATE_TYPE_UNSPECIFIED indicates this model_version was not touched by the most recent UpdateProject (its effective_tpm_threshold reflects an earlier update). The whole-relationship update_type on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).

Returns
Type Description
int Enum of type UpdateType.

setUpdateType

Output only. The type of the most recent update to this (project, model_version) subscription, as performed by the most recent UpdateProject call. UPDATE_TYPE_UNSPECIFIED indicates this model_version was not touched by the most recent UpdateProject (its effective_tpm_threshold reflects an earlier update). The whole-relationship update_type on the enclosing ConfigurableBillingStatus continues to summarize the direction of the most recent update across all surfaces in the project (QPM, IndexingCore, and Agent Search TPM together).

Parameter
Name Description
var int

Enum of type UpdateType.

Returns
Type Description
$this