AlloyDB V1 API - Class Google::Cloud::AlloyDB::V1::Cluster (v0.11.0)

Reference documentation and code samples for the AlloyDB V1 API class Google::Cloud::AlloyDB::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

#automated_backup_policy

def automated_backup_policy() -> ::Google::Cloud::AlloyDB::V1::AutomatedBackupPolicy
Returns
  • (::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.

#automated_backup_policy=

def automated_backup_policy=(value) -> ::Google::Cloud::AlloyDB::V1::AutomatedBackupPolicy
Parameter
  • value (::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.

Returns
  • (::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.

#backup_source

def backup_source() -> ::Google::Cloud::AlloyDB::V1::BackupSource
Returns

#cluster_type

def cluster_type() -> ::Google::Cloud::AlloyDB::V1::Cluster::ClusterType
Returns
  • (::Google::Cloud::AlloyDB::V1::Cluster::ClusterType) — 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

#continuous_backup_config

def continuous_backup_config() -> ::Google::Cloud::AlloyDB::V1::ContinuousBackupConfig
Returns

#continuous_backup_config=

def continuous_backup_config=(value) -> ::Google::Cloud::AlloyDB::V1::ContinuousBackupConfig
Parameter
Returns

#continuous_backup_info

def continuous_backup_info() -> ::Google::Cloud::AlloyDB::V1::ContinuousBackupInfo
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#database_version

def database_version() -> ::Google::Cloud::AlloyDB::V1::DatabaseVersion
Returns
  • (::Google::Cloud::AlloyDB::V1::DatabaseVersion) — 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.

#database_version=

def database_version=(value) -> ::Google::Cloud::AlloyDB::V1::DatabaseVersion
Parameter
  • value (::Google::Cloud::AlloyDB::V1::DatabaseVersion) — 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
  • (::Google::Cloud::AlloyDB::V1::DatabaseVersion) — 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.

#delete_time

def delete_time() -> ::Google::Protobuf::Timestamp
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — User-settable and human-readable display name for the Cluster.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — User-settable and human-readable display name for the Cluster.
Returns
  • (::String) — User-settable and human-readable display name for the Cluster.

#encryption_config

def encryption_config() -> ::Google::Cloud::AlloyDB::V1::EncryptionConfig
Returns
  • (::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_config=

def encryption_config=(value) -> ::Google::Cloud::AlloyDB::V1::EncryptionConfig
Parameter
  • value (::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.
Returns
  • (::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

def encryption_info() -> ::Google::Cloud::AlloyDB::V1::EncryptionInfo
Returns

#etag

def etag() -> ::String
Returns
  • (::String) — For Resource freshness validation (https://google.aip.dev/154)

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — For Resource freshness validation (https://google.aip.dev/154)
Returns
  • (::String) — For Resource freshness validation (https://google.aip.dev/154)

#initial_user

def initial_user() -> ::Google::Cloud::AlloyDB::V1::UserPassword
Returns

#initial_user=

def initial_user=(value) -> ::Google::Cloud::AlloyDB::V1::UserPassword
Parameter
Returns

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels as key value pairs

#maintenance_schedule

def maintenance_schedule() -> ::Google::Cloud::AlloyDB::V1::MaintenanceSchedule
Returns

#maintenance_update_policy

def maintenance_update_policy() -> ::Google::Cloud::AlloyDB::V1::MaintenanceUpdatePolicy
Returns

#maintenance_update_policy=

def maintenance_update_policy=(value) -> ::Google::Cloud::AlloyDB::V1::MaintenanceUpdatePolicy
Parameter
Returns

#migration_source

def migration_source() -> ::Google::Cloud::AlloyDB::V1::MigrationSource
Returns

#name

def name() -> ::String
Returns
  • (::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}

#network

def network() -> ::String
Returns
  • (::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.

#network=

def network=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#network_config

def network_config() -> ::Google::Cloud::AlloyDB::V1::Cluster::NetworkConfig
Returns

#network_config=

def network_config=(value) -> ::Google::Cloud::AlloyDB::V1::Cluster::NetworkConfig
Parameter
Returns

#primary_config

def primary_config() -> ::Google::Cloud::AlloyDB::V1::Cluster::PrimaryConfig
Returns

#psc_config

def psc_config() -> ::Google::Cloud::AlloyDB::V1::Cluster::PscConfig
Returns

#psc_config=

def psc_config=(value) -> ::Google::Cloud::AlloyDB::V1::Cluster::PscConfig
Parameter
Returns

#reconciling

def reconciling() -> ::Boolean
Returns
  • (::Boolean) — 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.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#secondary_config

def secondary_config() -> ::Google::Cloud::AlloyDB::V1::Cluster::SecondaryConfig
Returns

#secondary_config=

def secondary_config=(value) -> ::Google::Cloud::AlloyDB::V1::Cluster::SecondaryConfig
Parameter
Returns

#ssl_config

def ssl_config() -> ::Google::Cloud::AlloyDB::V1::SslConfig
Returns

#ssl_config=

def ssl_config=(value) -> ::Google::Cloud::AlloyDB::V1::SslConfig
Parameter
Returns

#state

def state() -> ::Google::Cloud::AlloyDB::V1::Cluster::State
Returns

#subscription_type

def subscription_type() -> ::Google::Cloud::AlloyDB::V1::SubscriptionType
Returns

#subscription_type=

def subscription_type=(value) -> ::Google::Cloud::AlloyDB::V1::SubscriptionType
Parameter
Returns

#tags

def tags() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

#tags=

def tags=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

#trial_metadata

def trial_metadata() -> ::Google::Cloud::AlloyDB::V1::Cluster::TrialMetadata
Returns

#uid

def uid() -> ::String
Returns
  • (::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns