public final class Cluster extends GeneratedMessageV3 implements ClusterOrBuilderA 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.v1.Cluster
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ClusterImplements
ClusterOrBuilderStatic Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
AUTOMATED_BACKUP_POLICY_FIELD_NUMBER
public static final int AUTOMATED_BACKUP_POLICY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
BACKUP_SOURCE_FIELD_NUMBER
public static final int BACKUP_SOURCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CLUSTER_TYPE_FIELD_NUMBER
public static final int CLUSTER_TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CONTINUOUS_BACKUP_CONFIG_FIELD_NUMBER
public static final int CONTINUOUS_BACKUP_CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CONTINUOUS_BACKUP_INFO_FIELD_NUMBER
public static final int CONTINUOUS_BACKUP_INFO_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DATABASE_VERSION_FIELD_NUMBER
public static final int DATABASE_VERSION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ENCRYPTION_CONFIG_FIELD_NUMBER
public static final int ENCRYPTION_CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ENCRYPTION_INFO_FIELD_NUMBER
public static final int ENCRYPTION_INFO_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INITIAL_USER_FIELD_NUMBER
public static final int INITIAL_USER_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MIGRATION_SOURCE_FIELD_NUMBER
public static final int MIGRATION_SOURCE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NETWORK_CONFIG_FIELD_NUMBER
public static final int NETWORK_CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PRIMARY_CONFIG_FIELD_NUMBER
public static final int PRIMARY_CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SECONDARY_CONFIG_FIELD_NUMBER
public static final int SECONDARY_CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SSL_CONFIG_FIELD_NUMBER
public static final int SSL_CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Cluster getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Cluster |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Cluster.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
newBuilder(Cluster prototype)
public static Cluster.Builder newBuilder(Cluster prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Cluster |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
parseDelimitedFrom(InputStream input)
public static Cluster parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Cluster |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Cluster parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Cluster |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Cluster parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Cluster |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Cluster |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Cluster parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Cluster |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Cluster |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Cluster parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Cluster |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Cluster |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Cluster parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Cluster |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Cluster |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Cluster parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Cluster |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Cluster |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Cluster> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Cluster> |
|
Methods
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 |
|
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAnnotations()
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.v1.AutomatedBackupPolicy automated_backup_policy = 17;
| Returns | |
|---|---|
| Type | Description |
AutomatedBackupPolicy |
The automatedBackupPolicy. |
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.v1.AutomatedBackupPolicy automated_backup_policy = 17;
| Returns | |
|---|---|
| Type | Description |
AutomatedBackupPolicyOrBuilder |
|
getBackupSource()
public BackupSource getBackupSource()Output only. Cluster created from backup.
.google.cloud.alloydb.v1.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
BackupSource |
The backupSource. |
getBackupSourceOrBuilder()
public BackupSourceOrBuilder getBackupSourceOrBuilder()Output only. Cluster created from backup.
.google.cloud.alloydb.v1.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.v1.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.v1.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.v1.ContinuousBackupConfig continuous_backup_config = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ContinuousBackupConfig |
The continuousBackupConfig. |
getContinuousBackupConfigOrBuilder()
public ContinuousBackupConfigOrBuilder getContinuousBackupConfigOrBuilder()Optional. Continuous backup configuration for this cluster.
.google.cloud.alloydb.v1.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.v1.ContinuousBackupInfo continuous_backup_info = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ContinuousBackupInfo |
The continuousBackupInfo. |
getContinuousBackupInfoOrBuilder()
public ContinuousBackupInfoOrBuilder getContinuousBackupInfoOrBuilder()Output only. Continuous backup properties for this cluster.
.google.cloud.alloydb.v1.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. |
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.v1.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.v1.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. |
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 |
|
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.v1.EncryptionConfig encryption_config = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EncryptionConfig |
The encryptionConfig. |
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.v1.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.v1.EncryptionInfo encryption_info = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
EncryptionInfo |
The encryptionInfo. |
getEncryptionInfoOrBuilder()
public EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()Output only. The encryption information for the cluster.
.google.cloud.alloydb.v1.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.v1.UserPassword initial_user = 14 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
UserPassword |
The initialUser. |
getInitialUserOrBuilder()
public UserPasswordOrBuilder getInitialUserOrBuilder() Input only. Initial user to setup during cluster creation. Required.
If used in RestoreCluster this is ignored.
.google.cloud.alloydb.v1.UserPassword initial_user = 14 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
UserPasswordOrBuilder |
|
getLabels()
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.v1.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
MigrationSource |
The migrationSource. |
getMigrationSourceOrBuilder()
public MigrationSourceOrBuilder getMigrationSourceOrBuilder()Output only. Cluster created via DMS migration.
.google.cloud.alloydb.v1.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
MigrationSourceOrBuilder |
|
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.v1.Cluster.network is deprecated. See google/cloud/alloydb/v1/resources.proto;l=543
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.v1.Cluster.network is deprecated. See google/cloud/alloydb/v1/resources.proto;l=543
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.v1.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Cluster.NetworkConfig |
The networkConfig. |
getNetworkConfigOrBuilder()
public Cluster.NetworkConfigOrBuilder getNetworkConfigOrBuilder()
.google.cloud.alloydb.v1.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Cluster.NetworkConfigOrBuilder |
|
getParserForType()
public Parser<Cluster> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Cluster> |
|
getPrimaryConfig()
public Cluster.PrimaryConfig getPrimaryConfig()Output only. Cross Region replication config specific to PRIMARY cluster.
.google.cloud.alloydb.v1.Cluster.PrimaryConfig primary_config = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Cluster.PrimaryConfig |
The primaryConfig. |
getPrimaryConfigOrBuilder()
public Cluster.PrimaryConfigOrBuilder getPrimaryConfigOrBuilder()Output only. Cross Region replication config specific to PRIMARY cluster.
.google.cloud.alloydb.v1.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.v1.Cluster.SecondaryConfig secondary_config = 22;
| Returns | |
|---|---|
| Type | Description |
Cluster.SecondaryConfig |
The secondaryConfig. |
getSecondaryConfigOrBuilder()
public Cluster.SecondaryConfigOrBuilder getSecondaryConfigOrBuilder()Cross Region replication config specific to SECONDARY cluster.
.google.cloud.alloydb.v1.Cluster.SecondaryConfig secondary_config = 22;
| Returns | |
|---|---|
| Type | Description |
Cluster.SecondaryConfigOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getSourceCase()
public Cluster.SourceCase getSourceCase()| Returns | |
|---|---|
| Type | Description |
Cluster.SourceCase |
|
getSslConfig() (deprecated)
public SslConfig getSslConfig()Deprecated. google.cloud.alloydb.v1.Cluster.ssl_config is deprecated. See google/cloud/alloydb/v1/resources.proto;l=578
SSL configuration for this AlloyDB cluster.
.google.cloud.alloydb.v1.SslConfig ssl_config = 18 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
SslConfig |
The sslConfig. |
getSslConfigOrBuilder()
public SslConfigOrBuilder getSslConfigOrBuilder()SSL configuration for this AlloyDB cluster.
.google.cloud.alloydb.v1.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.v1.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.v1.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. |
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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.Cluster.SecondaryConfig secondary_config = 22;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the secondaryConfig field is set. |
hasSslConfig() (deprecated)
public boolean hasSslConfig()Deprecated. google.cloud.alloydb.v1.Cluster.ssl_config is deprecated. See google/cloud/alloydb/v1/resources.proto;l=578
SSL configuration for this AlloyDB cluster.
.google.cloud.alloydb.v1.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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Cluster.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Cluster.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public Cluster.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Cluster.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|