Cloud Spanner V1 Client - Class FreeInstanceMetadata (1.92.0)

Version latest

• 1.92.0 (latest)
• 1.91.0
• 1.90.0
• 1.89.0
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

Reference documentation and code samples for the Cloud Spanner V1 Client class FreeInstanceMetadata.

Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes.

Generated from protobuf message google.spanner.admin.instance.v1.FreeInstanceMetadata

Namespace

Google \ Cloud \ Spanner \ Admin \ Instance \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ expire_time	Google\Protobuf\Timestamp Output only. Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.
↳ upgrade_time	Google\Protobuf\Timestamp Output only. If present, the timestamp at which the free instance was upgraded to a provisioned instance.
↳ expire_behavior	int Specifies the expiration behavior of a free instance. The default of ExpireBehavior is REMOVE_AFTER_GRACE_PERIOD. This can be modified during or after creation, and before expiration.

getExpireTime

Output only. Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasExpireTime

clearExpireTime

setExpireTime

Output only. Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpgradeTime

Output only. If present, the timestamp at which the free instance was upgraded to a provisioned instance.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpgradeTime

clearUpgradeTime

setUpgradeTime

Output only. If present, the timestamp at which the free instance was upgraded to a provisioned instance.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getExpireBehavior

Specifies the expiration behavior of a free instance. The default of ExpireBehavior is REMOVE_AFTER_GRACE_PERIOD. This can be modified during or after creation, and before expiration.

Returns
Type	Description
int

setExpireBehavior

Specifies the expiration behavior of a free instance. The default of ExpireBehavior is REMOVE_AFTER_GRACE_PERIOD. This can be modified during or after creation, and before expiration.

Parameter
Name	Description
var	int

Returns
Type	Description
$this