Google Cloud AlloyDB for PostgreSQL V1 Client - Class Cluster (1.1.0)

Version 1.1.0

• 1.1.2 (latest)
• 1.1.1
• 1.0.0
• 0.10.3
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.3

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class Cluster.

A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances.

All cluster resources share a storage layer, which scales as needed.

Generated from protobuf message google.cloud.alloydb.v1.Cluster

Namespace

Google \ Cloud \ AlloyDb \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ backup_source	Google\Cloud\AlloyDb\V1\BackupSource Output only. Cluster created from backup.
↳ migration_source	Google\Cloud\AlloyDb\V1\MigrationSource Output only. Cluster created via DMS migration.
↳ name	string Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
↳ display_name	string User-settable and human-readable display name for the Cluster.
↳ uid	string Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
↳ create_time	Google\Protobuf\Timestamp Output only. Create time stamp
↳ update_time	Google\Protobuf\Timestamp Output only. Update time stamp
↳ delete_time	Google\Protobuf\Timestamp Output only. Delete time stamp
↳ labels	array|Google\Protobuf\Internal\MapField Labels as key value pairs
↳ state	int Output only. The current serving state of the cluster.
↳ cluster_type	int Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. CreateCluster vs. CreateSecondaryCluster
↳ database_version	int Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
↳ network_config	Google\Cloud\AlloyDb\V1\Cluster\NetworkConfig
↳ network	string Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: projects/{project}/global/networks/{network_id}. This is required to create a cluster. Deprecated, use network_config.network instead.
↳ etag	string For Resource freshness validation (https://google.aip.dev/154)
↳ annotations	array|Google\Protobuf\Internal\MapField Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
↳ reconciling	bool Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
↳ initial_user	Google\Cloud\AlloyDb\V1\UserPassword Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.
↳ automated_backup_policy	Google\Cloud\AlloyDb\V1\AutomatedBackupPolicy The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
↳ ssl_config	Google\Cloud\AlloyDb\V1\SslConfig SSL configuration for this AlloyDB cluster.
↳ encryption_config	Google\Cloud\AlloyDb\V1\EncryptionConfig Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
↳ encryption_info	Google\Cloud\AlloyDb\V1\EncryptionInfo Output only. The encryption information for the cluster.
↳ continuous_backup_config	Google\Cloud\AlloyDb\V1\ContinuousBackupConfig Optional. Continuous backup configuration for this cluster.
↳ continuous_backup_info	Google\Cloud\AlloyDb\V1\ContinuousBackupInfo Output only. Continuous backup properties for this cluster.
↳ secondary_config	Google\Cloud\AlloyDb\V1\Cluster\SecondaryConfig Cross Region replication config specific to SECONDARY cluster.
↳ primary_config	Google\Cloud\AlloyDb\V1\Cluster\PrimaryConfig Output only. Cross Region replication config specific to PRIMARY cluster.
↳ satisfies_pzs	bool Output only. Reserved for future use.
↳ psc_config	Google\Cloud\AlloyDb\V1\Cluster\PscConfig Optional. The configuration for Private Service Connect (PSC) for the cluster.
↳ maintenance_update_policy	Google\Cloud\AlloyDb\V1\MaintenanceUpdatePolicy Optional. The maintenance update policy determines when to allow or deny updates.
↳ maintenance_schedule	Google\Cloud\AlloyDb\V1\MaintenanceSchedule Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.
↳ subscription_type	int Optional. Subscription type of the cluster.
↳ trial_metadata	Google\Cloud\AlloyDb\V1\Cluster\TrialMetadata Output only. Metadata for free trial clusters
↳ tags	array|Google\Protobuf\Internal\MapField Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

getBackupSource

Output only. Cluster created from backup.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\BackupSource|null

hasBackupSource

setBackupSource

Output only. Cluster created from backup.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\BackupSource

Returns
Type	Description
$this

getMigrationSource

Output only. Cluster created via DMS migration.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\MigrationSource|null

hasMigrationSource

setMigrationSource

Output only. Cluster created via DMS migration.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\MigrationSource

Returns
Type	Description
$this

getName

Output only. The name of the cluster resource with the format:

• projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https://google.aip.dev/122.

The prefix of the cluster resource name is the name of the parent resource:

• projects/{project}/locations/{region}

Returns
Type	Description
string

setName

Output only. The name of the cluster resource with the format:

• projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https://google.aip.dev/122.

The prefix of the cluster resource name is the name of the parent resource:

• projects/{project}/locations/{region}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

User-settable and human-readable display name for the Cluster.

Returns
Type	Description
string

setDisplayName

User-settable and human-readable display name for the Cluster.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getUid

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

Returns
Type	Description
string

setUid

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. Create time stamp

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Create time stamp

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. Update time stamp

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Update time stamp

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getDeleteTime

Output only. Delete time stamp

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. Delete time stamp

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getLabels

Labels as key value pairs

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

Labels as key value pairs

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getState

Output only. The current serving state of the cluster.

Returns
Type	Description
int

setState

Output only. The current serving state of the cluster.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getClusterType

Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. CreateCluster vs. CreateSecondaryCluster

Returns
Type	Description
int

setClusterType

Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. CreateCluster vs. CreateSecondaryCluster

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getDatabaseVersion

Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.

Returns
Type	Description
int

setDatabaseVersion

Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getNetworkConfig

Generated from protobuf field .google.cloud.alloydb.v1.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Google\Cloud\AlloyDb\V1\Cluster\NetworkConfig|null

hasNetworkConfig

clearNetworkConfig

setNetworkConfig

Generated from protobuf field .google.cloud.alloydb.v1.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\Cluster\NetworkConfig

Returns
Type	Description
$this

getNetwork

Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: projects/{project}/global/networks/{network_id}. This is required to create a cluster. Deprecated, use network_config.network instead.

Returns
Type	Description
string

setNetwork

Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: projects/{project}/global/networks/{network_id}. This is required to create a cluster. Deprecated, use network_config.network instead.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEtag

For Resource freshness validation (https://google.aip.dev/154)

Returns
Type	Description
string

setEtag

For Resource freshness validation (https://google.aip.dev/154)

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAnnotations

Annotations to allow client tools to store small amount of arbitrary data.

This is distinct from labels. https://google.aip.dev/128

Returns
Type	Description
Google\Protobuf\Internal\MapField

setAnnotations

Annotations to allow client tools to store small amount of arbitrary data.

This is distinct from labels. https://google.aip.dev/128

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getReconciling

Output only. Reconciling (https://google.aip.dev/128#reconciliation).

Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

Returns
Type	Description
bool

setReconciling

Output only. Reconciling (https://google.aip.dev/128#reconciliation).

Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getInitialUser

Input only. Initial user to setup during cluster creation. Required.

If used in RestoreCluster this is ignored.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\UserPassword|null

hasInitialUser

clearInitialUser

setInitialUser

Input only. Initial user to setup during cluster creation. Required.

If used in RestoreCluster this is ignored.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\UserPassword

Returns
Type	Description
$this

getAutomatedBackupPolicy

The automated backup policy for this cluster.

If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\AutomatedBackupPolicy|null

hasAutomatedBackupPolicy

clearAutomatedBackupPolicy

setAutomatedBackupPolicy

The automated backup policy for this cluster.

If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\AutomatedBackupPolicy

Returns
Type	Description
$this

getSslConfig

SSL configuration for this AlloyDB cluster.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\SslConfig|null

hasSslConfig

clearSslConfig

setSslConfig

SSL configuration for this AlloyDB cluster.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\SslConfig

Returns
Type	Description
$this

getEncryptionConfig

Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\EncryptionConfig|null

hasEncryptionConfig

clearEncryptionConfig

setEncryptionConfig

Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\EncryptionConfig

Returns
Type	Description
$this

getEncryptionInfo

Output only. The encryption information for the cluster.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\EncryptionInfo|null

hasEncryptionInfo

clearEncryptionInfo

setEncryptionInfo

Output only. The encryption information for the cluster.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\EncryptionInfo

Returns
Type	Description
$this

getContinuousBackupConfig

Optional. Continuous backup configuration for this cluster.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\ContinuousBackupConfig|null

hasContinuousBackupConfig

clearContinuousBackupConfig

setContinuousBackupConfig

Optional. Continuous backup configuration for this cluster.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\ContinuousBackupConfig

Returns
Type	Description
$this

getContinuousBackupInfo

Output only. Continuous backup properties for this cluster.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\ContinuousBackupInfo|null

hasContinuousBackupInfo

clearContinuousBackupInfo

setContinuousBackupInfo

Output only. Continuous backup properties for this cluster.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\ContinuousBackupInfo

Returns
Type	Description
$this

getSecondaryConfig

Cross Region replication config specific to SECONDARY cluster.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\Cluster\SecondaryConfig|null

hasSecondaryConfig

clearSecondaryConfig

setSecondaryConfig

Cross Region replication config specific to SECONDARY cluster.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\Cluster\SecondaryConfig

Returns
Type	Description
$this

getPrimaryConfig

Output only. Cross Region replication config specific to PRIMARY cluster.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\Cluster\PrimaryConfig|null

hasPrimaryConfig

clearPrimaryConfig

setPrimaryConfig

Output only. Cross Region replication config specific to PRIMARY cluster.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\Cluster\PrimaryConfig

Returns
Type	Description
$this

getSatisfiesPzs

Output only. Reserved for future use.

Returns
Type	Description
bool

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getPscConfig

Optional. The configuration for Private Service Connect (PSC) for the cluster.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\Cluster\PscConfig|null

hasPscConfig

clearPscConfig

setPscConfig

Optional. The configuration for Private Service Connect (PSC) for the cluster.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\Cluster\PscConfig

Returns
Type	Description
$this

getMaintenanceUpdatePolicy

Optional. The maintenance update policy determines when to allow or deny updates.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\MaintenanceUpdatePolicy|null

hasMaintenanceUpdatePolicy

clearMaintenanceUpdatePolicy

setMaintenanceUpdatePolicy

Optional. The maintenance update policy determines when to allow or deny updates.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\MaintenanceUpdatePolicy

Returns
Type	Description
$this

getMaintenanceSchedule

Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.

Returns
Type	Description
Google\Cloud\AlloyDb\V1\MaintenanceSchedule|null

hasMaintenanceSchedule

clearMaintenanceSchedule

setMaintenanceSchedule

Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\MaintenanceSchedule

Returns
Type	Description
$this

getSubscriptionType

Optional. Subscription type of the cluster.

Returns
Type	Description
int

setSubscriptionType

Optional. Subscription type of the cluster.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getTrialMetadata

Output only. Metadata for free trial clusters

Returns
Type	Description
Google\Cloud\AlloyDb\V1\Cluster\TrialMetadata|null

hasTrialMetadata

clearTrialMetadata

setTrialMetadata

Output only. Metadata for free trial clusters

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1\Cluster\TrialMetadata

Returns
Type	Description
$this

getTags

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example:

"123/environment": "production",
"123/costCenter": "marketing"

Returns
Type	Description
Google\Protobuf\Internal\MapField

setTags

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example:

"123/environment": "production",
"123/costCenter": "marketing"

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getSource

Returns
Type	Description
string