Class Cluster.Builder (0.22.0)

public static final class Cluster.Builder extends GeneratedMessageV3.Builder<Cluster.Builder> implements ClusterOrBuilder

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.

Protobuf type google.cloud.alloydb.v1beta.Cluster

Implements

ClusterOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Cluster.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Cluster.Builder
Overrides

build()

public Cluster build()
Returns
Type Description
Cluster

buildPartial()

public Cluster buildPartial()
Returns
Type Description
Cluster

clear()

public Cluster.Builder clear()
Returns
Type Description
Cluster.Builder
Overrides

clearAnnotations()

public Cluster.Builder clearAnnotations()
Returns
Type Description
Cluster.Builder

clearAutomatedBackupPolicy()

public Cluster.Builder clearAutomatedBackupPolicy()

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.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy automated_backup_policy = 17;

Returns
Type Description
Cluster.Builder

clearBackupSource()

public Cluster.Builder clearBackupSource()

Output only. Cluster created from backup.

.google.cloud.alloydb.v1beta.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

clearClusterType()

public Cluster.Builder clearClusterType()

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

.google.cloud.alloydb.v1beta.Cluster.ClusterType cluster_type = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearContinuousBackupConfig()

public Cluster.Builder clearContinuousBackupConfig()

Optional. Continuous backup configuration for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupConfig continuous_backup_config = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.Builder

clearContinuousBackupInfo()

public Cluster.Builder clearContinuousBackupInfo()

Output only. Continuous backup properties for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupInfo continuous_backup_info = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

clearCreateTime()

public Cluster.Builder clearCreateTime()

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

clearDatabaseVersion()

public Cluster.Builder clearDatabaseVersion()

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.

.google.cloud.alloydb.v1beta.DatabaseVersion database_version = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearDeleteTime()

public Cluster.Builder clearDeleteTime()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

clearDisplayName()

public Cluster.Builder clearDisplayName()

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

string display_name = 2;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearEncryptionConfig()

public Cluster.Builder clearEncryptionConfig()

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.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.Builder

clearEncryptionInfo()

public Cluster.Builder clearEncryptionInfo()

Output only. The encryption information for the cluster.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

clearEtag()

public Cluster.Builder clearEtag()

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

string etag = 11;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Cluster.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Cluster.Builder
Overrides

clearInitialUser()

public Cluster.Builder clearInitialUser()

Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

.google.cloud.alloydb.v1beta.UserPassword initial_user = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
Cluster.Builder

clearLabels()

public Cluster.Builder clearLabels()
Returns
Type Description
Cluster.Builder

clearMigrationSource()

public Cluster.Builder clearMigrationSource()

Output only. Cluster created via DMS migration.

.google.cloud.alloydb.v1beta.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

clearName()

public Cluster.Builder clearName()

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}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearNetwork() (deprecated)

public Cluster.Builder clearNetwork()

Deprecated. google.cloud.alloydb.v1beta.Cluster.network is deprecated. See google/cloud/alloydb/v1beta/resources.proto;l=546

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.

string network = 10 [deprecated = true, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearNetworkConfig()

public Cluster.Builder clearNetworkConfig()

.google.cloud.alloydb.v1beta.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Cluster.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Cluster.Builder
Overrides

clearPrimaryConfig()

public Cluster.Builder clearPrimaryConfig()

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

.google.cloud.alloydb.v1beta.Cluster.PrimaryConfig primary_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

clearReconciling()

public Cluster.Builder clearReconciling()

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.

bool reconciling = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearSecondaryConfig()

public Cluster.Builder clearSecondaryConfig()

Cross Region replication config specific to SECONDARY cluster.

.google.cloud.alloydb.v1beta.Cluster.SecondaryConfig secondary_config = 22;

Returns
Type Description
Cluster.Builder

clearSource()

public Cluster.Builder clearSource()
Returns
Type Description
Cluster.Builder

clearSslConfig() (deprecated)

public Cluster.Builder clearSslConfig()

SSL configuration for this AlloyDB cluster.

.google.cloud.alloydb.v1beta.SslConfig ssl_config = 18 [deprecated = true];

Returns
Type Description
Cluster.Builder

clearState()

public Cluster.Builder clearState()

Output only. The current serving state of the cluster.

.google.cloud.alloydb.v1beta.Cluster.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearUid()

public Cluster.Builder clearUid()

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.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearUpdateTime()

public Cluster.Builder clearUpdateTime()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

clone()

public Cluster.Builder clone()
Returns
Type Description
Cluster.Builder
Overrides

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 12;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 12;

Returns
Type Description
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 12;

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 12;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 12;

Parameter
Name Description
key String
Returns
Type Description
String

getAutomatedBackupPolicy()

public AutomatedBackupPolicy 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.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy automated_backup_policy = 17;

Returns
Type Description
AutomatedBackupPolicy

The automatedBackupPolicy.

getAutomatedBackupPolicyBuilder()

public AutomatedBackupPolicy.Builder getAutomatedBackupPolicyBuilder()

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.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy automated_backup_policy = 17;

Returns
Type Description
AutomatedBackupPolicy.Builder

getAutomatedBackupPolicyOrBuilder()

public AutomatedBackupPolicyOrBuilder getAutomatedBackupPolicyOrBuilder()

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.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy automated_backup_policy = 17;

Returns
Type Description
AutomatedBackupPolicyOrBuilder

getBackupSource()

public BackupSource getBackupSource()

Output only. Cluster created from backup.

.google.cloud.alloydb.v1beta.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackupSource

The backupSource.

getBackupSourceBuilder()

public BackupSource.Builder getBackupSourceBuilder()

Output only. Cluster created from backup.

.google.cloud.alloydb.v1beta.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackupSource.Builder

getBackupSourceOrBuilder()

public BackupSourceOrBuilder getBackupSourceOrBuilder()

Output only. Cluster created from backup.

.google.cloud.alloydb.v1beta.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BackupSourceOrBuilder

getClusterType()

public Cluster.ClusterType 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

.google.cloud.alloydb.v1beta.Cluster.ClusterType cluster_type = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.ClusterType

The clusterType.

getClusterTypeValue()

public int getClusterTypeValue()

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

.google.cloud.alloydb.v1beta.Cluster.ClusterType cluster_type = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for clusterType.

getContinuousBackupConfig()

public ContinuousBackupConfig getContinuousBackupConfig()

Optional. Continuous backup configuration for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupConfig continuous_backup_config = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ContinuousBackupConfig

The continuousBackupConfig.

getContinuousBackupConfigBuilder()

public ContinuousBackupConfig.Builder getContinuousBackupConfigBuilder()

Optional. Continuous backup configuration for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupConfig continuous_backup_config = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ContinuousBackupConfig.Builder

getContinuousBackupConfigOrBuilder()

public ContinuousBackupConfigOrBuilder getContinuousBackupConfigOrBuilder()

Optional. Continuous backup configuration for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupConfig continuous_backup_config = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ContinuousBackupConfigOrBuilder

getContinuousBackupInfo()

public ContinuousBackupInfo getContinuousBackupInfo()

Output only. Continuous backup properties for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupInfo continuous_backup_info = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ContinuousBackupInfo

The continuousBackupInfo.

getContinuousBackupInfoBuilder()

public ContinuousBackupInfo.Builder getContinuousBackupInfoBuilder()

Output only. Continuous backup properties for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupInfo continuous_backup_info = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ContinuousBackupInfo.Builder

getContinuousBackupInfoOrBuilder()

public ContinuousBackupInfoOrBuilder getContinuousBackupInfoOrBuilder()

Output only. Continuous backup properties for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupInfo continuous_backup_info = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ContinuousBackupInfoOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDatabaseVersion()

public DatabaseVersion 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.

.google.cloud.alloydb.v1beta.DatabaseVersion database_version = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DatabaseVersion

The databaseVersion.

getDatabaseVersionValue()

public int getDatabaseVersionValue()

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.

.google.cloud.alloydb.v1beta.DatabaseVersion database_version = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for databaseVersion.

getDefaultInstanceForType()

public Cluster getDefaultInstanceForType()
Returns
Type Description
Cluster

getDeleteTime()

public Timestamp getDeleteTime()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

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

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getEncryptionConfig()

public EncryptionConfig 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.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionConfig

The encryptionConfig.

getEncryptionConfigBuilder()

public EncryptionConfig.Builder getEncryptionConfigBuilder()

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.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionConfig.Builder

getEncryptionConfigOrBuilder()

public EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

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.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionConfigOrBuilder

getEncryptionInfo()

public EncryptionInfo getEncryptionInfo()

Output only. The encryption information for the cluster.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionInfo

The encryptionInfo.

getEncryptionInfoBuilder()

public EncryptionInfo.Builder getEncryptionInfoBuilder()

Output only. The encryption information for the cluster.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionInfo.Builder

getEncryptionInfoOrBuilder()

public EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()

Output only. The encryption information for the cluster.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionInfoOrBuilder

getEtag()

public String getEtag()

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

string etag = 11;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 11;

Returns
Type Description
ByteString

The bytes for etag.

getInitialUser()

public UserPassword getInitialUser()

Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

.google.cloud.alloydb.v1beta.UserPassword initial_user = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
UserPassword

The initialUser.

getInitialUserBuilder()

public UserPassword.Builder getInitialUserBuilder()

Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

.google.cloud.alloydb.v1beta.UserPassword initial_user = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
UserPassword.Builder

getInitialUserOrBuilder()

public UserPasswordOrBuilder getInitialUserOrBuilder()

Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

.google.cloud.alloydb.v1beta.UserPassword initial_user = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
UserPasswordOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs

map<string, string> labels = 7;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs

map<string, string> labels = 7;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs

map<string, string> labels = 7;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
String

getMigrationSource()

public MigrationSource getMigrationSource()

Output only. Cluster created via DMS migration.

.google.cloud.alloydb.v1beta.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MigrationSource

The migrationSource.

getMigrationSourceBuilder()

public MigrationSource.Builder getMigrationSourceBuilder()

Output only. Cluster created via DMS migration.

.google.cloud.alloydb.v1beta.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MigrationSource.Builder

getMigrationSourceOrBuilder()

public MigrationSourceOrBuilder getMigrationSourceOrBuilder()

Output only. Cluster created via DMS migration.

.google.cloud.alloydb.v1beta.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MigrationSourceOrBuilder

getMutableAnnotations() (deprecated)

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String 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}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getNetwork() (deprecated)

public String getNetwork()

Deprecated. google.cloud.alloydb.v1beta.Cluster.network is deprecated. See google/cloud/alloydb/v1beta/resources.proto;l=546

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.

string network = 10 [deprecated = true, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The network.

getNetworkBytes() (deprecated)

public ByteString getNetworkBytes()

Deprecated. google.cloud.alloydb.v1beta.Cluster.network is deprecated. See google/cloud/alloydb/v1beta/resources.proto;l=546

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.

string network = 10 [deprecated = true, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for network.

getNetworkConfig()

public Cluster.NetworkConfig getNetworkConfig()

.google.cloud.alloydb.v1beta.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.NetworkConfig

The networkConfig.

getNetworkConfigBuilder()

public Cluster.NetworkConfig.Builder getNetworkConfigBuilder()

.google.cloud.alloydb.v1beta.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.NetworkConfig.Builder

getNetworkConfigOrBuilder()

public Cluster.NetworkConfigOrBuilder getNetworkConfigOrBuilder()

.google.cloud.alloydb.v1beta.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Cluster.NetworkConfigOrBuilder

getPrimaryConfig()

public Cluster.PrimaryConfig getPrimaryConfig()

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

.google.cloud.alloydb.v1beta.Cluster.PrimaryConfig primary_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.PrimaryConfig

The primaryConfig.

getPrimaryConfigBuilder()

public Cluster.PrimaryConfig.Builder getPrimaryConfigBuilder()

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

.google.cloud.alloydb.v1beta.Cluster.PrimaryConfig primary_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.PrimaryConfig.Builder

getPrimaryConfigOrBuilder()

public Cluster.PrimaryConfigOrBuilder getPrimaryConfigOrBuilder()

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

.google.cloud.alloydb.v1beta.Cluster.PrimaryConfig primary_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.PrimaryConfigOrBuilder

getReconciling()

public boolean 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.

bool reconciling = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The reconciling.

getSecondaryConfig()

public Cluster.SecondaryConfig getSecondaryConfig()

Cross Region replication config specific to SECONDARY cluster.

.google.cloud.alloydb.v1beta.Cluster.SecondaryConfig secondary_config = 22;

Returns
Type Description
Cluster.SecondaryConfig

The secondaryConfig.

getSecondaryConfigBuilder()

public Cluster.SecondaryConfig.Builder getSecondaryConfigBuilder()

Cross Region replication config specific to SECONDARY cluster.

.google.cloud.alloydb.v1beta.Cluster.SecondaryConfig secondary_config = 22;

Returns
Type Description
Cluster.SecondaryConfig.Builder

getSecondaryConfigOrBuilder()

public Cluster.SecondaryConfigOrBuilder getSecondaryConfigOrBuilder()

Cross Region replication config specific to SECONDARY cluster.

.google.cloud.alloydb.v1beta.Cluster.SecondaryConfig secondary_config = 22;

Returns
Type Description
Cluster.SecondaryConfigOrBuilder

getSourceCase()

public Cluster.SourceCase getSourceCase()
Returns
Type Description
Cluster.SourceCase

getSslConfig() (deprecated)

public SslConfig getSslConfig()

Deprecated. google.cloud.alloydb.v1beta.Cluster.ssl_config is deprecated. See google/cloud/alloydb/v1beta/resources.proto;l=581

SSL configuration for this AlloyDB cluster.

.google.cloud.alloydb.v1beta.SslConfig ssl_config = 18 [deprecated = true];

Returns
Type Description
SslConfig

The sslConfig.

getSslConfigBuilder() (deprecated)

public SslConfig.Builder getSslConfigBuilder()

SSL configuration for this AlloyDB cluster.

.google.cloud.alloydb.v1beta.SslConfig ssl_config = 18 [deprecated = true];

Returns
Type Description
SslConfig.Builder

getSslConfigOrBuilder() (deprecated)

public SslConfigOrBuilder getSslConfigOrBuilder()

SSL configuration for this AlloyDB cluster.

.google.cloud.alloydb.v1beta.SslConfig ssl_config = 18 [deprecated = true];

Returns
Type Description
SslConfigOrBuilder

getState()

public Cluster.State getState()

Output only. The current serving state of the cluster.

.google.cloud.alloydb.v1beta.Cluster.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.State

The state.

getStateValue()

public int getStateValue()

Output only. The current serving state of the cluster.

.google.cloud.alloydb.v1beta.Cluster.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUid()

public String 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.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

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.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAutomatedBackupPolicy()

public boolean hasAutomatedBackupPolicy()

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.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy automated_backup_policy = 17;

Returns
Type Description
boolean

Whether the automatedBackupPolicy field is set.

hasBackupSource()

public boolean hasBackupSource()

Output only. Cluster created from backup.

.google.cloud.alloydb.v1beta.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the backupSource field is set.

hasContinuousBackupConfig()

public boolean hasContinuousBackupConfig()

Optional. Continuous backup configuration for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupConfig continuous_backup_config = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the continuousBackupConfig field is set.

hasContinuousBackupInfo()

public boolean hasContinuousBackupInfo()

Output only. Continuous backup properties for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupInfo continuous_backup_info = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the continuousBackupInfo field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteTime field is set.

hasEncryptionConfig()

public boolean hasEncryptionConfig()

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.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the encryptionConfig field is set.

hasEncryptionInfo()

public boolean hasEncryptionInfo()

Output only. The encryption information for the cluster.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the encryptionInfo field is set.

hasInitialUser()

public boolean hasInitialUser()

Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

.google.cloud.alloydb.v1beta.UserPassword initial_user = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the initialUser field is set.

hasMigrationSource()

public boolean hasMigrationSource()

Output only. Cluster created via DMS migration.

.google.cloud.alloydb.v1beta.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the migrationSource field is set.

hasNetworkConfig()

public boolean hasNetworkConfig()

.google.cloud.alloydb.v1beta.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the networkConfig field is set.

hasPrimaryConfig()

public boolean hasPrimaryConfig()

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

.google.cloud.alloydb.v1beta.Cluster.PrimaryConfig primary_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the primaryConfig field is set.

hasSecondaryConfig()

public boolean hasSecondaryConfig()

Cross Region replication config specific to SECONDARY cluster.

.google.cloud.alloydb.v1beta.Cluster.SecondaryConfig secondary_config = 22;

Returns
Type Description
boolean

Whether the secondaryConfig field is set.

hasSslConfig() (deprecated)

public boolean hasSslConfig()

Deprecated. google.cloud.alloydb.v1beta.Cluster.ssl_config is deprecated. See google/cloud/alloydb/v1beta/resources.proto;l=581

SSL configuration for this AlloyDB cluster.

.google.cloud.alloydb.v1beta.SslConfig ssl_config = 18 [deprecated = true];

Returns
Type Description
boolean

Whether the sslConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAutomatedBackupPolicy(AutomatedBackupPolicy value)

public Cluster.Builder mergeAutomatedBackupPolicy(AutomatedBackupPolicy value)

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.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy automated_backup_policy = 17;

Parameter
Name Description
value AutomatedBackupPolicy
Returns
Type Description
Cluster.Builder

mergeBackupSource(BackupSource value)

public Cluster.Builder mergeBackupSource(BackupSource value)

Output only. Cluster created from backup.

.google.cloud.alloydb.v1beta.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value BackupSource
Returns
Type Description
Cluster.Builder

mergeContinuousBackupConfig(ContinuousBackupConfig value)

public Cluster.Builder mergeContinuousBackupConfig(ContinuousBackupConfig value)

Optional. Continuous backup configuration for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupConfig continuous_backup_config = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ContinuousBackupConfig
Returns
Type Description
Cluster.Builder

mergeContinuousBackupInfo(ContinuousBackupInfo value)

public Cluster.Builder mergeContinuousBackupInfo(ContinuousBackupInfo value)

Output only. Continuous backup properties for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupInfo continuous_backup_info = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ContinuousBackupInfo
Returns
Type Description
Cluster.Builder

mergeCreateTime(Timestamp value)

public Cluster.Builder mergeCreateTime(Timestamp value)

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Cluster.Builder

mergeDeleteTime(Timestamp value)

public Cluster.Builder mergeDeleteTime(Timestamp value)

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Cluster.Builder

mergeEncryptionConfig(EncryptionConfig value)

public Cluster.Builder mergeEncryptionConfig(EncryptionConfig value)

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.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EncryptionConfig
Returns
Type Description
Cluster.Builder

mergeEncryptionInfo(EncryptionInfo value)

public Cluster.Builder mergeEncryptionInfo(EncryptionInfo value)

Output only. The encryption information for the cluster.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value EncryptionInfo
Returns
Type Description
Cluster.Builder

mergeFrom(Cluster other)

public Cluster.Builder mergeFrom(Cluster other)
Parameter
Name Description
other Cluster
Returns
Type Description
Cluster.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Cluster.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Cluster.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Cluster.Builder
Overrides

mergeInitialUser(UserPassword value)

public Cluster.Builder mergeInitialUser(UserPassword value)

Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

.google.cloud.alloydb.v1beta.UserPassword initial_user = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value UserPassword
Returns
Type Description
Cluster.Builder

mergeMigrationSource(MigrationSource value)

public Cluster.Builder mergeMigrationSource(MigrationSource value)

Output only. Cluster created via DMS migration.

.google.cloud.alloydb.v1beta.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value MigrationSource
Returns
Type Description
Cluster.Builder

mergeNetworkConfig(Cluster.NetworkConfig value)

public Cluster.Builder mergeNetworkConfig(Cluster.NetworkConfig value)

.google.cloud.alloydb.v1beta.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Cluster.NetworkConfig
Returns
Type Description
Cluster.Builder

mergePrimaryConfig(Cluster.PrimaryConfig value)

public Cluster.Builder mergePrimaryConfig(Cluster.PrimaryConfig value)

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

.google.cloud.alloydb.v1beta.Cluster.PrimaryConfig primary_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Cluster.PrimaryConfig
Returns
Type Description
Cluster.Builder

mergeSecondaryConfig(Cluster.SecondaryConfig value)

public Cluster.Builder mergeSecondaryConfig(Cluster.SecondaryConfig value)

Cross Region replication config specific to SECONDARY cluster.

.google.cloud.alloydb.v1beta.Cluster.SecondaryConfig secondary_config = 22;

Parameter
Name Description
value Cluster.SecondaryConfig
Returns
Type Description
Cluster.Builder

mergeSslConfig(SslConfig value) (deprecated)

public Cluster.Builder mergeSslConfig(SslConfig value)

SSL configuration for this AlloyDB cluster.

.google.cloud.alloydb.v1beta.SslConfig ssl_config = 18 [deprecated = true];

Parameter
Name Description
value SslConfig
Returns
Type Description
Cluster.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Cluster.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Cluster.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Cluster.Builder mergeUpdateTime(Timestamp value)

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Cluster.Builder

putAllAnnotations(Map<String,String> values)

public Cluster.Builder putAllAnnotations(Map<String,String> values)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 12;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Cluster.Builder

putAllLabels(Map<String,String> values)

public Cluster.Builder putAllLabels(Map<String,String> values)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Cluster.Builder

putAnnotations(String key, String value)

public Cluster.Builder putAnnotations(String key, String value)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 12;

Parameters
Name Description
key String
value String
Returns
Type Description
Cluster.Builder

putLabels(String key, String value)

public Cluster.Builder putLabels(String key, String value)

Labels as key value pairs

map<string, string> labels = 7;

Parameters
Name Description
key String
value String
Returns
Type Description
Cluster.Builder

removeAnnotations(String key)

public Cluster.Builder removeAnnotations(String key)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

map<string, string> annotations = 12;

Parameter
Name Description
key String
Returns
Type Description
Cluster.Builder

removeLabels(String key)

public Cluster.Builder removeLabels(String key)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
Cluster.Builder

setAutomatedBackupPolicy(AutomatedBackupPolicy value)

public Cluster.Builder setAutomatedBackupPolicy(AutomatedBackupPolicy value)

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.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy automated_backup_policy = 17;

Parameter
Name Description
value AutomatedBackupPolicy
Returns
Type Description
Cluster.Builder

setAutomatedBackupPolicy(AutomatedBackupPolicy.Builder builderForValue)

public Cluster.Builder setAutomatedBackupPolicy(AutomatedBackupPolicy.Builder builderForValue)

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.

.google.cloud.alloydb.v1beta.AutomatedBackupPolicy automated_backup_policy = 17;

Parameter
Name Description
builderForValue AutomatedBackupPolicy.Builder
Returns
Type Description
Cluster.Builder

setBackupSource(BackupSource value)

public Cluster.Builder setBackupSource(BackupSource value)

Output only. Cluster created from backup.

.google.cloud.alloydb.v1beta.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value BackupSource
Returns
Type Description
Cluster.Builder

setBackupSource(BackupSource.Builder builderForValue)

public Cluster.Builder setBackupSource(BackupSource.Builder builderForValue)

Output only. Cluster created from backup.

.google.cloud.alloydb.v1beta.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue BackupSource.Builder
Returns
Type Description
Cluster.Builder

setClusterType(Cluster.ClusterType value)

public Cluster.Builder setClusterType(Cluster.ClusterType value)

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

.google.cloud.alloydb.v1beta.Cluster.ClusterType cluster_type = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Cluster.ClusterType

The clusterType to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setClusterTypeValue(int value)

public Cluster.Builder setClusterTypeValue(int value)

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

.google.cloud.alloydb.v1beta.Cluster.ClusterType cluster_type = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for clusterType to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setContinuousBackupConfig(ContinuousBackupConfig value)

public Cluster.Builder setContinuousBackupConfig(ContinuousBackupConfig value)

Optional. Continuous backup configuration for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupConfig continuous_backup_config = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ContinuousBackupConfig
Returns
Type Description
Cluster.Builder

setContinuousBackupConfig(ContinuousBackupConfig.Builder builderForValue)

public Cluster.Builder setContinuousBackupConfig(ContinuousBackupConfig.Builder builderForValue)

Optional. Continuous backup configuration for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupConfig continuous_backup_config = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ContinuousBackupConfig.Builder
Returns
Type Description
Cluster.Builder

setContinuousBackupInfo(ContinuousBackupInfo value)

public Cluster.Builder setContinuousBackupInfo(ContinuousBackupInfo value)

Output only. Continuous backup properties for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupInfo continuous_backup_info = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ContinuousBackupInfo
Returns
Type Description
Cluster.Builder

setContinuousBackupInfo(ContinuousBackupInfo.Builder builderForValue)

public Cluster.Builder setContinuousBackupInfo(ContinuousBackupInfo.Builder builderForValue)

Output only. Continuous backup properties for this cluster.

.google.cloud.alloydb.v1beta.ContinuousBackupInfo continuous_backup_info = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue ContinuousBackupInfo.Builder
Returns
Type Description
Cluster.Builder

setCreateTime(Timestamp value)

public Cluster.Builder setCreateTime(Timestamp value)

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Cluster.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Cluster.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Create time stamp

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Cluster.Builder

setDatabaseVersion(DatabaseVersion value)

public Cluster.Builder setDatabaseVersion(DatabaseVersion value)

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.

.google.cloud.alloydb.v1beta.DatabaseVersion database_version = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DatabaseVersion

The databaseVersion to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setDatabaseVersionValue(int value)

public Cluster.Builder setDatabaseVersionValue(int value)

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.

.google.cloud.alloydb.v1beta.DatabaseVersion database_version = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for databaseVersion to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setDeleteTime(Timestamp value)

public Cluster.Builder setDeleteTime(Timestamp value)

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Cluster.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public Cluster.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. Delete time stamp

.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Cluster.Builder

setDisplayName(String value)

public Cluster.Builder setDisplayName(String value)

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

string display_name = 2;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Cluster.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 2;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setEncryptionConfig(EncryptionConfig value)

public Cluster.Builder setEncryptionConfig(EncryptionConfig value)

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.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value EncryptionConfig
Returns
Type Description
Cluster.Builder

setEncryptionConfig(EncryptionConfig.Builder builderForValue)

public Cluster.Builder setEncryptionConfig(EncryptionConfig.Builder builderForValue)

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.

.google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue EncryptionConfig.Builder
Returns
Type Description
Cluster.Builder

setEncryptionInfo(EncryptionInfo value)

public Cluster.Builder setEncryptionInfo(EncryptionInfo value)

Output only. The encryption information for the cluster.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value EncryptionInfo
Returns
Type Description
Cluster.Builder

setEncryptionInfo(EncryptionInfo.Builder builderForValue)

public Cluster.Builder setEncryptionInfo(EncryptionInfo.Builder builderForValue)

Output only. The encryption information for the cluster.

.google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue EncryptionInfo.Builder
Returns
Type Description
Cluster.Builder

setEtag(String value)

public Cluster.Builder setEtag(String value)

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

string etag = 11;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Cluster.Builder setEtagBytes(ByteString value)

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

string etag = 11;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Cluster.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Cluster.Builder
Overrides

setInitialUser(UserPassword value)

public Cluster.Builder setInitialUser(UserPassword value)

Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

.google.cloud.alloydb.v1beta.UserPassword initial_user = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
value UserPassword
Returns
Type Description
Cluster.Builder

setInitialUser(UserPassword.Builder builderForValue)

public Cluster.Builder setInitialUser(UserPassword.Builder builderForValue)

Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

.google.cloud.alloydb.v1beta.UserPassword initial_user = 14 [(.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
builderForValue UserPassword.Builder
Returns
Type Description
Cluster.Builder

setMigrationSource(MigrationSource value)

public Cluster.Builder setMigrationSource(MigrationSource value)

Output only. Cluster created via DMS migration.

.google.cloud.alloydb.v1beta.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value MigrationSource
Returns
Type Description
Cluster.Builder

setMigrationSource(MigrationSource.Builder builderForValue)

public Cluster.Builder setMigrationSource(MigrationSource.Builder builderForValue)

Output only. Cluster created via DMS migration.

.google.cloud.alloydb.v1beta.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue MigrationSource.Builder
Returns
Type Description
Cluster.Builder

setName(String value)

public Cluster.Builder setName(String value)

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}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Cluster.Builder setNameBytes(ByteString value)

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}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setNetwork(String value) (deprecated)

public Cluster.Builder setNetwork(String value)

Deprecated. google.cloud.alloydb.v1beta.Cluster.network is deprecated. See google/cloud/alloydb/v1beta/resources.proto;l=546

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.

string network = 10 [deprecated = true, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The network to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setNetworkBytes(ByteString value) (deprecated)

public Cluster.Builder setNetworkBytes(ByteString value)

Deprecated. google.cloud.alloydb.v1beta.Cluster.network is deprecated. See google/cloud/alloydb/v1beta/resources.proto;l=546

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.

string network = 10 [deprecated = true, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for network to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setNetworkConfig(Cluster.NetworkConfig value)

public Cluster.Builder setNetworkConfig(Cluster.NetworkConfig value)

.google.cloud.alloydb.v1beta.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Cluster.NetworkConfig
Returns
Type Description
Cluster.Builder

setNetworkConfig(Cluster.NetworkConfig.Builder builderForValue)

public Cluster.Builder setNetworkConfig(Cluster.NetworkConfig.Builder builderForValue)

.google.cloud.alloydb.v1beta.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Cluster.NetworkConfig.Builder
Returns
Type Description
Cluster.Builder

setPrimaryConfig(Cluster.PrimaryConfig value)

public Cluster.Builder setPrimaryConfig(Cluster.PrimaryConfig value)

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

.google.cloud.alloydb.v1beta.Cluster.PrimaryConfig primary_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Cluster.PrimaryConfig
Returns
Type Description
Cluster.Builder

setPrimaryConfig(Cluster.PrimaryConfig.Builder builderForValue)

public Cluster.Builder setPrimaryConfig(Cluster.PrimaryConfig.Builder builderForValue)

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

.google.cloud.alloydb.v1beta.Cluster.PrimaryConfig primary_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Cluster.PrimaryConfig.Builder
Returns
Type Description
Cluster.Builder

setReconciling(boolean value)

public Cluster.Builder setReconciling(boolean value)

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.

bool reconciling = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The reconciling to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Cluster.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Cluster.Builder
Overrides

setSecondaryConfig(Cluster.SecondaryConfig value)

public Cluster.Builder setSecondaryConfig(Cluster.SecondaryConfig value)

Cross Region replication config specific to SECONDARY cluster.

.google.cloud.alloydb.v1beta.Cluster.SecondaryConfig secondary_config = 22;

Parameter
Name Description
value Cluster.SecondaryConfig
Returns
Type Description
Cluster.Builder

setSecondaryConfig(Cluster.SecondaryConfig.Builder builderForValue)

public Cluster.Builder setSecondaryConfig(Cluster.SecondaryConfig.Builder builderForValue)

Cross Region replication config specific to SECONDARY cluster.

.google.cloud.alloydb.v1beta.Cluster.SecondaryConfig secondary_config = 22;

Parameter
Name Description
builderForValue Cluster.SecondaryConfig.Builder
Returns
Type Description
Cluster.Builder

setSslConfig(SslConfig value) (deprecated)

public Cluster.Builder setSslConfig(SslConfig value)

SSL configuration for this AlloyDB cluster.

.google.cloud.alloydb.v1beta.SslConfig ssl_config = 18 [deprecated = true];

Parameter
Name Description
value SslConfig
Returns
Type Description
Cluster.Builder

setSslConfig(SslConfig.Builder builderForValue) (deprecated)

public Cluster.Builder setSslConfig(SslConfig.Builder builderForValue)

SSL configuration for this AlloyDB cluster.

.google.cloud.alloydb.v1beta.SslConfig ssl_config = 18 [deprecated = true];

Parameter
Name Description
builderForValue SslConfig.Builder
Returns
Type Description
Cluster.Builder

setState(Cluster.State value)

public Cluster.Builder setState(Cluster.State value)

Output only. The current serving state of the cluster.

.google.cloud.alloydb.v1beta.Cluster.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Cluster.State

The state to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setStateValue(int value)

public Cluster.Builder setStateValue(int value)

Output only. The current serving state of the cluster.

.google.cloud.alloydb.v1beta.Cluster.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setUid(String value)

public Cluster.Builder setUid(String value)

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.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The uid to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setUidBytes(ByteString value)

public Cluster.Builder setUidBytes(ByteString value)

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.

string uid = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for uid to set.

Returns
Type Description
Cluster.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Cluster.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Cluster.Builder
Overrides

setUpdateTime(Timestamp value)

public Cluster.Builder setUpdateTime(Timestamp value)

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Cluster.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Cluster.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Update time stamp

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Cluster.Builder