Package com.google.cloud.alloydb.v1
Class Cluster
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.alloydb.v1.Cluster
-
- All Implemented Interfaces:
ClusterOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class Cluster extends com.google.protobuf.GeneratedMessageV3 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 typegoogle.cloud.alloydb.v1.Cluster
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Cluster.Builder
A cluster is a collection of regional AlloyDB resources.static class
Cluster.ClusterType
Type of Clusterstatic class
Cluster.PrimaryConfig
Configuration for the primary cluster.static interface
Cluster.PrimaryConfigOrBuilder
static class
Cluster.SecondaryConfig
Configuration information for the secondary cluster.static interface
Cluster.SecondaryConfigOrBuilder
static class
Cluster.SourceCase
static class
Cluster.State
Cluster State-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
ANNOTATIONS_FIELD_NUMBER
static int
AUTOMATED_BACKUP_POLICY_FIELD_NUMBER
static int
BACKUP_SOURCE_FIELD_NUMBER
static int
CLUSTER_TYPE_FIELD_NUMBER
static int
CONTINUOUS_BACKUP_CONFIG_FIELD_NUMBER
static int
CONTINUOUS_BACKUP_INFO_FIELD_NUMBER
static int
CREATE_TIME_FIELD_NUMBER
static int
DATABASE_VERSION_FIELD_NUMBER
static int
DELETE_TIME_FIELD_NUMBER
static int
DISPLAY_NAME_FIELD_NUMBER
static int
ENCRYPTION_CONFIG_FIELD_NUMBER
static int
ENCRYPTION_INFO_FIELD_NUMBER
static int
ETAG_FIELD_NUMBER
static int
INITIAL_USER_FIELD_NUMBER
static int
LABELS_FIELD_NUMBER
static int
MIGRATION_SOURCE_FIELD_NUMBER
static int
NAME_FIELD_NUMBER
static int
NETWORK_FIELD_NUMBER
static int
PRIMARY_CONFIG_FIELD_NUMBER
static int
RECONCILING_FIELD_NUMBER
static int
SECONDARY_CONFIG_FIELD_NUMBER
static int
SSL_CONFIG_FIELD_NUMBER
static int
STATE_FIELD_NUMBER
static int
UID_FIELD_NUMBER
static int
UPDATE_TIME_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
containsAnnotations(String key)
Annotations to allow client tools to store small amount of arbitrary data.boolean
containsLabels(String key)
Labels as key value pairsboolean
equals(Object obj)
Map<String,String>
getAnnotations()
Deprecated.int
getAnnotationsCount()
Annotations to allow client tools to store small amount of arbitrary data.Map<String,String>
getAnnotationsMap()
Annotations to allow client tools to store small amount of arbitrary data.String
getAnnotationsOrDefault(String key, String defaultValue)
Annotations to allow client tools to store small amount of arbitrary data.String
getAnnotationsOrThrow(String key)
Annotations to allow client tools to store small amount of arbitrary data.AutomatedBackupPolicy
getAutomatedBackupPolicy()
The automated backup policy for this cluster.AutomatedBackupPolicyOrBuilder
getAutomatedBackupPolicyOrBuilder()
The automated backup policy for this cluster.BackupSource
getBackupSource()
Output only.BackupSourceOrBuilder
getBackupSourceOrBuilder()
Output only.Cluster.ClusterType
getClusterType()
Output only.int
getClusterTypeValue()
Output only.ContinuousBackupConfig
getContinuousBackupConfig()
Optional.ContinuousBackupConfigOrBuilder
getContinuousBackupConfigOrBuilder()
Optional.ContinuousBackupInfo
getContinuousBackupInfo()
Output only.ContinuousBackupInfoOrBuilder
getContinuousBackupInfoOrBuilder()
Output only.com.google.protobuf.Timestamp
getCreateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getCreateTimeOrBuilder()
Output only.DatabaseVersion
getDatabaseVersion()
Output only.int
getDatabaseVersionValue()
Output only.static Cluster
getDefaultInstance()
Cluster
getDefaultInstanceForType()
com.google.protobuf.Timestamp
getDeleteTime()
Output only.com.google.protobuf.TimestampOrBuilder
getDeleteTimeOrBuilder()
Output only.static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
String
getDisplayName()
User-settable and human-readable display name for the Cluster.com.google.protobuf.ByteString
getDisplayNameBytes()
User-settable and human-readable display name for the Cluster.EncryptionConfig
getEncryptionConfig()
Optional.EncryptionConfigOrBuilder
getEncryptionConfigOrBuilder()
Optional.EncryptionInfo
getEncryptionInfo()
Output only.EncryptionInfoOrBuilder
getEncryptionInfoOrBuilder()
Output only.String
getEtag()
For Resource freshness validation (https://google.aip.dev/154)com.google.protobuf.ByteString
getEtagBytes()
For Resource freshness validation (https://google.aip.dev/154)UserPassword
getInitialUser()
Input only.UserPasswordOrBuilder
getInitialUserOrBuilder()
Input only.Map<String,String>
getLabels()
Deprecated.int
getLabelsCount()
Labels as key value pairsMap<String,String>
getLabelsMap()
Labels as key value pairsString
getLabelsOrDefault(String key, String defaultValue)
Labels as key value pairsString
getLabelsOrThrow(String key)
Labels as key value pairsMigrationSource
getMigrationSource()
Output only.MigrationSourceOrBuilder
getMigrationSourceOrBuilder()
Output only.String
getName()
Output only.com.google.protobuf.ByteString
getNameBytes()
Output only.String
getNetwork()
Required.com.google.protobuf.ByteString
getNetworkBytes()
Required.com.google.protobuf.Parser<Cluster>
getParserForType()
Cluster.PrimaryConfig
getPrimaryConfig()
Output only.Cluster.PrimaryConfigOrBuilder
getPrimaryConfigOrBuilder()
Output only.boolean
getReconciling()
Output only.Cluster.SecondaryConfig
getSecondaryConfig()
Cross Region replication config specific to SECONDARY cluster.Cluster.SecondaryConfigOrBuilder
getSecondaryConfigOrBuilder()
Cross Region replication config specific to SECONDARY cluster.int
getSerializedSize()
Cluster.SourceCase
getSourceCase()
SslConfig
getSslConfig()
Deprecated.google.cloud.alloydb.v1.Cluster.ssl_config is deprecated.SslConfigOrBuilder
getSslConfigOrBuilder()
Deprecated.Cluster.State
getState()
Output only.int
getStateValue()
Output only.String
getUid()
Output only.com.google.protobuf.ByteString
getUidBytes()
Output only.com.google.protobuf.Timestamp
getUpdateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getUpdateTimeOrBuilder()
Output only.boolean
hasAutomatedBackupPolicy()
The automated backup policy for this cluster.boolean
hasBackupSource()
Output only.boolean
hasContinuousBackupConfig()
Optional.boolean
hasContinuousBackupInfo()
Output only.boolean
hasCreateTime()
Output only.boolean
hasDeleteTime()
Output only.boolean
hasEncryptionConfig()
Optional.boolean
hasEncryptionInfo()
Output only.int
hashCode()
boolean
hasInitialUser()
Input only.boolean
hasMigrationSource()
Output only.boolean
hasPrimaryConfig()
Output only.boolean
hasSecondaryConfig()
Cross Region replication config specific to SECONDARY cluster.boolean
hasSslConfig()
Deprecated.google.cloud.alloydb.v1.Cluster.ssl_config is deprecated.boolean
hasUpdateTime()
Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
boolean
isInitialized()
static Cluster.Builder
newBuilder()
static Cluster.Builder
newBuilder(Cluster prototype)
Cluster.Builder
newBuilderForType()
protected Cluster.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Cluster
parseDelimitedFrom(InputStream input)
static Cluster
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster
parseFrom(byte[] data)
static Cluster
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster
parseFrom(com.google.protobuf.ByteString data)
static Cluster
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster
parseFrom(com.google.protobuf.CodedInputStream input)
static Cluster
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster
parseFrom(InputStream input)
static Cluster
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster
parseFrom(ByteBuffer data)
static Cluster
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Cluster>
parser()
Cluster.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
BACKUP_SOURCE_FIELD_NUMBER
public static final int BACKUP_SOURCE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MIGRATION_SOURCE_FIELD_NUMBER
public static final int MIGRATION_SOURCE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CLUSTER_TYPE_FIELD_NUMBER
public static final int CLUSTER_TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DATABASE_VERSION_FIELD_NUMBER
public static final int DATABASE_VERSION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
INITIAL_USER_FIELD_NUMBER
public static final int INITIAL_USER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
AUTOMATED_BACKUP_POLICY_FIELD_NUMBER
public static final int AUTOMATED_BACKUP_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SSL_CONFIG_FIELD_NUMBER
public static final int SSL_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENCRYPTION_CONFIG_FIELD_NUMBER
public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENCRYPTION_INFO_FIELD_NUMBER
public static final int ENCRYPTION_INFO_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONTINUOUS_BACKUP_CONFIG_FIELD_NUMBER
public static final int CONTINUOUS_BACKUP_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONTINUOUS_BACKUP_INFO_FIELD_NUMBER
public static final int CONTINUOUS_BACKUP_INFO_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SECONDARY_CONFIG_FIELD_NUMBER
public static final int SECONDARY_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PRIMARY_CONFIG_FIELD_NUMBER
public static final int PRIMARY_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getSourceCase
public Cluster.SourceCase getSourceCase()
- Specified by:
getSourceCase
in interfaceClusterOrBuilder
-
hasBackupSource
public boolean hasBackupSource()
Output only. Cluster created from backup.
.google.cloud.alloydb.v1.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasBackupSource
in interfaceClusterOrBuilder
- Returns:
- Whether the backupSource field is set.
-
getBackupSource
public BackupSource getBackupSource()
Output only. Cluster created from backup.
.google.cloud.alloydb.v1.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getBackupSource
in interfaceClusterOrBuilder
- Returns:
- 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];
- Specified by:
getBackupSourceOrBuilder
in interfaceClusterOrBuilder
-
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];
- Specified by:
hasMigrationSource
in interfaceClusterOrBuilder
- Returns:
- Whether the migrationSource field is set.
-
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];
- Specified by:
getMigrationSource
in interfaceClusterOrBuilder
- Returns:
- 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];
- Specified by:
getMigrationSourceOrBuilder
in interfaceClusterOrBuilder
-
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];
- Specified by:
getName
in interfaceClusterOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.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];
- Specified by:
getNameBytes
in interfaceClusterOrBuilder
- Returns:
- The bytes for name.
-
getDisplayName
public String getDisplayName()
User-settable and human-readable display name for the Cluster.
string display_name = 2;
- Specified by:
getDisplayName
in interfaceClusterOrBuilder
- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()
User-settable and human-readable display name for the Cluster.
string display_name = 2;
- Specified by:
getDisplayNameBytes
in interfaceClusterOrBuilder
- Returns:
- The bytes for displayName.
-
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];
- Specified by:
getUid
in interfaceClusterOrBuilder
- Returns:
- The uid.
-
getUidBytes
public com.google.protobuf.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];
- Specified by:
getUidBytes
in interfaceClusterOrBuilder
- Returns:
- The bytes for uid.
-
hasCreateTime
public boolean hasCreateTime()
Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasCreateTime
in interfaceClusterOrBuilder
- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()
Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getCreateTime
in interfaceClusterOrBuilder
- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Create time stamp
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getCreateTimeOrBuilder
in interfaceClusterOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()
Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasUpdateTime
in interfaceClusterOrBuilder
- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()
Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getUpdateTime
in interfaceClusterOrBuilder
- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Update time stamp
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getUpdateTimeOrBuilder
in interfaceClusterOrBuilder
-
hasDeleteTime
public boolean hasDeleteTime()
Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasDeleteTime
in interfaceClusterOrBuilder
- Returns:
- Whether the deleteTime field is set.
-
getDeleteTime
public com.google.protobuf.Timestamp getDeleteTime()
Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getDeleteTime
in interfaceClusterOrBuilder
- Returns:
- The deleteTime.
-
getDeleteTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. Delete time stamp
.google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getDeleteTimeOrBuilder
in interfaceClusterOrBuilder
-
getLabelsCount
public int getLabelsCount()
Description copied from interface:ClusterOrBuilder
Labels as key value pairs
map<string, string> labels = 7;
- Specified by:
getLabelsCount
in interfaceClusterOrBuilder
-
containsLabels
public boolean containsLabels(String key)
Labels as key value pairs
map<string, string> labels = 7;
- Specified by:
containsLabels
in interfaceClusterOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()
instead.- Specified by:
getLabels
in interfaceClusterOrBuilder
-
getLabelsMap
public Map<String,String> getLabelsMap()
Labels as key value pairs
map<string, string> labels = 7;
- Specified by:
getLabelsMap
in interfaceClusterOrBuilder
-
getLabelsOrDefault
public String getLabelsOrDefault(String key, String defaultValue)
Labels as key value pairs
map<string, string> labels = 7;
- Specified by:
getLabelsOrDefault
in interfaceClusterOrBuilder
-
getLabelsOrThrow
public String getLabelsOrThrow(String key)
Labels as key value pairs
map<string, string> labels = 7;
- Specified by:
getLabelsOrThrow
in interfaceClusterOrBuilder
-
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];
- Specified by:
getStateValue
in interfaceClusterOrBuilder
- Returns:
- The enum numeric value on the wire for state.
-
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];
- Specified by:
getState
in interfaceClusterOrBuilder
- Returns:
- The state.
-
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];
- Specified by:
getClusterTypeValue
in interfaceClusterOrBuilder
- Returns:
- The enum numeric value on the wire for clusterType.
-
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];
- Specified by:
getClusterType
in interfaceClusterOrBuilder
- Returns:
- The clusterType.
-
getDatabaseVersionValue
public 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.v1.DatabaseVersion database_version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getDatabaseVersionValue
in interfaceClusterOrBuilder
- Returns:
- The enum numeric value on the wire for databaseVersion.
-
getDatabaseVersion
public 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.v1.DatabaseVersion database_version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getDatabaseVersion
in interfaceClusterOrBuilder
- Returns:
- The databaseVersion.
-
getNetwork
public 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) = { ... }
- Specified by:
getNetwork
in interfaceClusterOrBuilder
- Returns:
- The network.
-
getNetworkBytes
public com.google.protobuf.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) = { ... }
- Specified by:
getNetworkBytes
in interfaceClusterOrBuilder
- Returns:
- The bytes for network.
-
getEtag
public String getEtag()
For Resource freshness validation (https://google.aip.dev/154)
string etag = 11;
- Specified by:
getEtag
in interfaceClusterOrBuilder
- Returns:
- The etag.
-
getEtagBytes
public com.google.protobuf.ByteString getEtagBytes()
For Resource freshness validation (https://google.aip.dev/154)
string etag = 11;
- Specified by:
getEtagBytes
in interfaceClusterOrBuilder
- Returns:
- The bytes for etag.
-
getAnnotationsCount
public int getAnnotationsCount()
Description copied from interface:ClusterOrBuilder
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;
- Specified by:
getAnnotationsCount
in interfaceClusterOrBuilder
-
containsAnnotations
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;
- Specified by:
containsAnnotations
in interfaceClusterOrBuilder
-
getAnnotations
@Deprecated public Map<String,String> getAnnotations()
Deprecated.UsegetAnnotationsMap()
instead.- Specified by:
getAnnotations
in interfaceClusterOrBuilder
-
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;
- Specified by:
getAnnotationsMap
in interfaceClusterOrBuilder
-
getAnnotationsOrDefault
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;
- Specified by:
getAnnotationsOrDefault
in interfaceClusterOrBuilder
-
getAnnotationsOrThrow
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;
- Specified by:
getAnnotationsOrThrow
in interfaceClusterOrBuilder
-
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];
- Specified by:
getReconciling
in interfaceClusterOrBuilder
- Returns:
- The reconciling.
-
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];
- Specified by:
hasInitialUser
in interfaceClusterOrBuilder
- Returns:
- Whether the initialUser field is set.
-
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];
- Specified by:
getInitialUser
in interfaceClusterOrBuilder
- Returns:
- 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];
- Specified by:
getInitialUserOrBuilder
in interfaceClusterOrBuilder
-
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;
- Specified by:
hasAutomatedBackupPolicy
in interfaceClusterOrBuilder
- Returns:
- Whether the automatedBackupPolicy field is set.
-
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;
- Specified by:
getAutomatedBackupPolicy
in interfaceClusterOrBuilder
- Returns:
- 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;
- Specified by:
getAutomatedBackupPolicyOrBuilder
in interfaceClusterOrBuilder
-
hasSslConfig
@Deprecated public boolean hasSslConfig()
Deprecated.google.cloud.alloydb.v1.Cluster.ssl_config is deprecated. See google/cloud/alloydb/v1/resources.proto;l=550SSL configuration for this AlloyDB cluster.
.google.cloud.alloydb.v1.SslConfig ssl_config = 18 [deprecated = true];
- Specified by:
hasSslConfig
in interfaceClusterOrBuilder
- Returns:
- Whether the sslConfig field is set.
-
getSslConfig
@Deprecated public SslConfig getSslConfig()
Deprecated.google.cloud.alloydb.v1.Cluster.ssl_config is deprecated. See google/cloud/alloydb/v1/resources.proto;l=550SSL configuration for this AlloyDB cluster.
.google.cloud.alloydb.v1.SslConfig ssl_config = 18 [deprecated = true];
- Specified by:
getSslConfig
in interfaceClusterOrBuilder
- Returns:
- The sslConfig.
-
getSslConfigOrBuilder
@Deprecated public SslConfigOrBuilder getSslConfigOrBuilder()
Deprecated.SSL configuration for this AlloyDB cluster.
.google.cloud.alloydb.v1.SslConfig ssl_config = 18 [deprecated = true];
- Specified by:
getSslConfigOrBuilder
in interfaceClusterOrBuilder
-
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];
- Specified by:
hasEncryptionConfig
in interfaceClusterOrBuilder
- Returns:
- Whether the encryptionConfig field is set.
-
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];
- Specified by:
getEncryptionConfig
in interfaceClusterOrBuilder
- Returns:
- 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];
- Specified by:
getEncryptionConfigOrBuilder
in interfaceClusterOrBuilder
-
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];
- Specified by:
hasEncryptionInfo
in interfaceClusterOrBuilder
- Returns:
- Whether the encryptionInfo field is set.
-
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];
- Specified by:
getEncryptionInfo
in interfaceClusterOrBuilder
- Returns:
- 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];
- Specified by:
getEncryptionInfoOrBuilder
in interfaceClusterOrBuilder
-
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];
- Specified by:
hasContinuousBackupConfig
in interfaceClusterOrBuilder
- Returns:
- Whether the continuousBackupConfig field is set.
-
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];
- Specified by:
getContinuousBackupConfig
in interfaceClusterOrBuilder
- Returns:
- 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];
- Specified by:
getContinuousBackupConfigOrBuilder
in interfaceClusterOrBuilder
-
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];
- Specified by:
hasContinuousBackupInfo
in interfaceClusterOrBuilder
- Returns:
- Whether the continuousBackupInfo field is set.
-
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];
- Specified by:
getContinuousBackupInfo
in interfaceClusterOrBuilder
- Returns:
- 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];
- Specified by:
getContinuousBackupInfoOrBuilder
in interfaceClusterOrBuilder
-
hasSecondaryConfig
public boolean hasSecondaryConfig()
Cross Region replication config specific to SECONDARY cluster.
.google.cloud.alloydb.v1.Cluster.SecondaryConfig secondary_config = 22;
- Specified by:
hasSecondaryConfig
in interfaceClusterOrBuilder
- Returns:
- Whether the secondaryConfig field is set.
-
getSecondaryConfig
public Cluster.SecondaryConfig getSecondaryConfig()
Cross Region replication config specific to SECONDARY cluster.
.google.cloud.alloydb.v1.Cluster.SecondaryConfig secondary_config = 22;
- Specified by:
getSecondaryConfig
in interfaceClusterOrBuilder
- Returns:
- The secondaryConfig.
-
getSecondaryConfigOrBuilder
public Cluster.SecondaryConfigOrBuilder getSecondaryConfigOrBuilder()
Cross Region replication config specific to SECONDARY cluster.
.google.cloud.alloydb.v1.Cluster.SecondaryConfig secondary_config = 22;
- Specified by:
getSecondaryConfigOrBuilder
in interfaceClusterOrBuilder
-
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];
- Specified by:
hasPrimaryConfig
in interfaceClusterOrBuilder
- Returns:
- Whether the primaryConfig field is set.
-
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];
- Specified by:
getPrimaryConfig
in interfaceClusterOrBuilder
- Returns:
- 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];
- Specified by:
getPrimaryConfigOrBuilder
in interfaceClusterOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Cluster parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Cluster parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Cluster parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Cluster parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Cluster parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Cluster parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Cluster parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Cluster parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Cluster parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Cluster parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static Cluster parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Cluster parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public Cluster.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Cluster.Builder newBuilder()
-
newBuilder
public static Cluster.Builder newBuilder(Cluster prototype)
-
toBuilder
public Cluster.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Cluster.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static Cluster getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Cluster> parser()
-
getParserForType
public com.google.protobuf.Parser<Cluster> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Cluster getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-