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

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

Represents the currently effective configurable billing parameters.

These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in customer_provided_config due to billing rules (e.g., scale-downs taking effect only at the start of a new month). We also include the update type to indicate the type of update performed on the configurable billing configuration in the UpdateProject operation.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ Project

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ effective_search_qpm_threshold int|string

Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.

↳ effective_indexing_core_threshold int|string

Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.

↳ start_time Google\Protobuf\Timestamp

Optional. The start time of the currently active billing subscription.

↳ terminate_time Google\Protobuf\Timestamp

Output only. The latest terminate effective time of search qpm and indexing core subscriptions.

↳ search_qpm_threshold_next_update_time Google\Protobuf\Timestamp

Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded.

↳ indexing_core_threshold_next_update_time Google\Protobuf\Timestamp

Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.

↳ update_type int

Output only. The type of update performed in this operation. This field is populated in the response of UpdateProject.

↳ agent_search_token_subscription_statuses array<ConfigurableBillingStatus\AgentSearchTokenSubscriptionStatus>

Output only. Per-model Agent Search TPM subscription status.

getEffectiveSearchQpmThreshold

Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.

Returns
Type Description
int|string

setEffectiveSearchQpmThreshold

Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.

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

getEffectiveIndexingCoreThreshold

Optional. The currently effective Indexing Core threshold.

This is the threshold against which Indexing Core usage is compared for overage calculations.

Returns
Type Description
int|string

setEffectiveIndexingCoreThreshold

Optional. The currently effective Indexing Core threshold.

This is the threshold against which Indexing Core usage is compared for overage calculations.

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

getStartTime

Optional. The start time of the currently active billing subscription.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Optional. The start time of the currently active billing subscription.

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

getTerminateTime

Output only. The latest terminate effective time of search qpm and indexing core subscriptions.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasTerminateTime

clearTerminateTime

setTerminateTime

Output only. The latest terminate effective time of search qpm and indexing core subscriptions.

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

getSearchQpmThresholdNextUpdateTime

Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasSearchQpmThresholdNextUpdateTime

clearSearchQpmThresholdNextUpdateTime

setSearchQpmThresholdNextUpdateTime

Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded.

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

getIndexingCoreThresholdNextUpdateTime

Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasIndexingCoreThresholdNextUpdateTime

clearIndexingCoreThresholdNextUpdateTime

setIndexingCoreThresholdNextUpdateTime

Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.

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

getUpdateType

Output only. The type of update performed in this operation.

This field is populated in the response of UpdateProject.

Returns
Type Description
int Enum of type UpdateType.

setUpdateType

Output only. The type of update performed in this operation.

This field is populated in the response of UpdateProject.

Parameter
Name Description
var int

Enum of type UpdateType.

Returns
Type Description
$this

getAgentSearchTokenSubscriptionStatuses

Output only. Per-model Agent Search TPM subscription status.

Returns
Type Description
Google\Protobuf\RepeatedField<ConfigurableBillingStatus\AgentSearchTokenSubscriptionStatus>

setAgentSearchTokenSubscriptionStatuses

Output only. Per-model Agent Search TPM subscription status.

Parameter
Name Description
var array<ConfigurableBillingStatus\AgentSearchTokenSubscriptionStatus>
Returns
Type Description
$this