Interface ClusterOrBuilder (0.1.0) 

public interface ClusterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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 abstract boolean containsLabels(String key)

Labels as key value pairs

map<string, string> labels = 7;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations()

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.v1alpha.AutomatedBackupPolicy automated_backup_policy = 17;

Returns
Type Description
AutomatedBackupPolicy

The automatedBackupPolicy.

getAutomatedBackupPolicyOrBuilder()

public abstract 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.v1alpha.AutomatedBackupPolicy automated_backup_policy = 17;

Returns
Type Description
AutomatedBackupPolicyOrBuilder

getBackupSource()

public abstract BackupSource getBackupSource()

Output only. Cluster created from backup.

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

Returns
Type Description
BackupSource

The backupSource.

getBackupSourceOrBuilder()

public abstract BackupSourceOrBuilder getBackupSourceOrBuilder()

Output only. Cluster created from backup.

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

Returns
Type Description
BackupSourceOrBuilder

getClusterType()

public abstract 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.v1alpha.Cluster.ClusterType cluster_type = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.ClusterType

The clusterType.

getClusterTypeValue()

public abstract 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.v1alpha.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 abstract ContinuousBackupConfig getContinuousBackupConfig()

Optional. Continuous backup configuration for this cluster.

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

Returns
Type Description
ContinuousBackupConfig

The continuousBackupConfig.

getContinuousBackupConfigOrBuilder()

public abstract ContinuousBackupConfigOrBuilder getContinuousBackupConfigOrBuilder()

Optional. Continuous backup configuration for this cluster.

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

Returns
Type Description
ContinuousBackupConfigOrBuilder

getContinuousBackupInfo()

public abstract ContinuousBackupInfo getContinuousBackupInfo()

Output only. Continuous backup properties for this cluster.

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

Returns
Type Description
ContinuousBackupInfo

The continuousBackupInfo.

getContinuousBackupInfoOrBuilder()

public abstract ContinuousBackupInfoOrBuilder getContinuousBackupInfoOrBuilder()

Output only. Continuous backup properties for this cluster.

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

Returns
Type Description
ContinuousBackupInfoOrBuilder

getCreateTime()

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

getCreateTimeOrBuilder()

public abstract 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 abstract DatabaseVersion getDatabaseVersion()

Output only. The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

.google.cloud.alloydb.v1alpha.DatabaseVersion database_version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DatabaseVersion

The databaseVersion.

getDatabaseVersionValue()

public abstract int getDatabaseVersionValue()

Output only. The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

.google.cloud.alloydb.v1alpha.DatabaseVersion database_version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for databaseVersion.

getDeleteTime()

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

getDeleteTimeOrBuilder()

public abstract TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. Delete time stamp

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

Returns
Type Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

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

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract 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 abstract 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.v1alpha.EncryptionConfig encryption_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionConfig

The encryptionConfig.

getEncryptionConfigOrBuilder()

public abstract 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.v1alpha.EncryptionConfig encryption_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EncryptionConfigOrBuilder

getEncryptionInfo()

public abstract EncryptionInfo getEncryptionInfo()

Output only. The encryption information for the cluster.

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

Returns
Type Description
EncryptionInfo

The encryptionInfo.

getEncryptionInfoOrBuilder()

public abstract EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()

Output only. The encryption information for the cluster.

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

Returns
Type Description
EncryptionInfoOrBuilder

getEtag()

public abstract String getEtag()

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

string etag = 11;

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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

string etag = 11;

Returns
Type Description
ByteString

The bytes for etag.

getInitialUser()

public abstract UserPassword getInitialUser()

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

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

Returns
Type Description
UserPassword

The initialUser.

getInitialUserOrBuilder()

public abstract UserPasswordOrBuilder getInitialUserOrBuilder()

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

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

Returns
Type Description
UserPasswordOrBuilder

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels as key value pairs

map<string, string> labels = 7;

Returns
Type Description
int

getLabelsMap()

public abstract 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 abstract 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 abstract 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 abstract MigrationSource getMigrationSource()

Output only. Cluster created via DMS migration.

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

Returns
Type Description
MigrationSource

The migrationSource.

getMigrationSourceOrBuilder()

public abstract MigrationSourceOrBuilder getMigrationSourceOrBuilder()

Output only. Cluster created via DMS migration.

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

Returns
Type Description
MigrationSourceOrBuilder

getName()

public abstract 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 abstract 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()

public abstract String 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_number}/global/networks/{network_id}". This is required to create a cluster. It can be updated, but it cannot be removed.

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

Returns
Type Description
String

The network.

getNetworkBytes()

public abstract ByteString getNetworkBytes()

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_number}/global/networks/{network_id}". This is required to create a cluster. It can be updated, but it cannot be removed.

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

Returns
Type Description
ByteString

The bytes for network.

getPrimaryConfig()

public abstract Cluster.PrimaryConfig getPrimaryConfig()

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

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

Returns
Type Description
Cluster.PrimaryConfig

The primaryConfig.

getPrimaryConfigOrBuilder()

public abstract Cluster.PrimaryConfigOrBuilder getPrimaryConfigOrBuilder()

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

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

Returns
Type Description
Cluster.PrimaryConfigOrBuilder

getReconciling()

public abstract 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 abstract Cluster.SecondaryConfig getSecondaryConfig()

Cross Region replication config specific to SECONDARY cluster.

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

Returns
Type Description
Cluster.SecondaryConfig

The secondaryConfig.

getSecondaryConfigOrBuilder()

public abstract Cluster.SecondaryConfigOrBuilder getSecondaryConfigOrBuilder()

Cross Region replication config specific to SECONDARY cluster.

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

Returns
Type Description
Cluster.SecondaryConfigOrBuilder

getSourceCase()

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

getSslConfig()

public abstract SslConfig getSslConfig()

SSL configuration for this AlloyDB Cluster.

.google.cloud.alloydb.v1alpha.SslConfig ssl_config = 18;

Returns
Type Description
SslConfig

The sslConfig.

getSslConfigOrBuilder()

public abstract SslConfigOrBuilder getSslConfigOrBuilder()

SSL configuration for this AlloyDB Cluster.

.google.cloud.alloydb.v1alpha.SslConfig ssl_config = 18;

Returns
Type Description
SslConfigOrBuilder

getState()

public abstract Cluster.State getState()

Output only. The current serving state of the cluster.

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

Returns
Type Description
Cluster.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The current serving state of the cluster.

.google.cloud.alloydb.v1alpha.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 abstract 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 abstract 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 abstract 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.

getUpdateTimeOrBuilder()

public abstract 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 abstract 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.v1alpha.AutomatedBackupPolicy automated_backup_policy = 17;

Returns
Type Description
boolean

Whether the automatedBackupPolicy field is set.

hasBackupSource()

public abstract boolean hasBackupSource()

Output only. Cluster created from backup.

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

Returns
Type Description
boolean

Whether the backupSource field is set.

hasContinuousBackupConfig()

public abstract boolean hasContinuousBackupConfig()

Optional. Continuous backup configuration for this cluster.

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

Returns
Type Description
boolean

Whether the continuousBackupConfig field is set.

hasContinuousBackupInfo()

public abstract boolean hasContinuousBackupInfo()

Output only. Continuous backup properties for this cluster.

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

Returns
Type Description
boolean

Whether the continuousBackupInfo field is set.

hasCreateTime()

public abstract 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 abstract 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 abstract 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.v1alpha.EncryptionConfig encryption_config = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the encryptionConfig field is set.

hasEncryptionInfo()

public abstract boolean hasEncryptionInfo()

Output only. The encryption information for the cluster.

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

Returns
Type Description
boolean

Whether the encryptionInfo field is set.

hasInitialUser()

public abstract boolean hasInitialUser()

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

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

Returns
Type Description
boolean

Whether the initialUser field is set.

hasMigrationSource()

public abstract boolean hasMigrationSource()

Output only. Cluster created via DMS migration.

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

Returns
Type Description
boolean

Whether the migrationSource field is set.

hasPrimaryConfig()

public abstract boolean hasPrimaryConfig()

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

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

Returns
Type Description
boolean

Whether the primaryConfig field is set.

hasSecondaryConfig()

public abstract boolean hasSecondaryConfig()

Cross Region replication config specific to SECONDARY cluster.

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

Returns
Type Description
boolean

Whether the secondaryConfig field is set.

hasSslConfig()

public abstract boolean hasSslConfig()

SSL configuration for this AlloyDB Cluster.

.google.cloud.alloydb.v1alpha.SslConfig ssl_config = 18;

Returns
Type Description
boolean

Whether the sslConfig field is set.

hasUpdateTime()

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