Package com.google.cloud.alloydb.v1alpha

Interface ClusterOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Cluster, Cluster.Builder
    public interface ClusterOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasBackupSource

        boolean hasBackupSource()
         Output only. Cluster created from backup.
        .google.cloud.alloydb.v1alpha.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the backupSource field is set.

      • getBackupSource

        BackupSource getBackupSource()
         Output only. Cluster created from backup.
        .google.cloud.alloydb.v1alpha.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The backupSource.

      • getBackupSourceOrBuilder

        BackupSourceOrBuilder getBackupSourceOrBuilder()
         Output only. Cluster created from backup.
        .google.cloud.alloydb.v1alpha.BackupSource backup_source = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasMigrationSource

        boolean hasMigrationSource()
         Output only. Cluster created via DMS migration.
        .google.cloud.alloydb.v1alpha.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the migrationSource field is set.

      • getMigrationSource

        MigrationSource getMigrationSource()
         Output only. Cluster created via DMS migration.
        .google.cloud.alloydb.v1alpha.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The migrationSource.

      • getMigrationSourceOrBuilder

        MigrationSourceOrBuilder getMigrationSourceOrBuilder()
         Output only. Cluster created via DMS migration.
        .google.cloud.alloydb.v1alpha.MigrationSource migration_source = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getName

        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:
        The name.

      • getNameBytes

        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];
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         User-settable and human-readable display name for the Cluster.
        string display_name = 2;
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         User-settable and human-readable display name for the Cluster.
        string display_name = 2;
        Returns:
        The bytes for displayName.

      • getUid

        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:
        The uid.

      • getUidBytes

        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];
        Returns:
        The bytes for uid.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Create time stamp
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Create time stamp
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Create time stamp
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. Update time stamp
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         Output only. Update time stamp
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Update time stamp
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasDeleteTime

        boolean hasDeleteTime()
         Output only. Delete time stamp
        .google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        com.google.protobuf.Timestamp getDeleteTime()
         Output only. Delete time stamp
        .google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
         Output only. Delete time stamp
        .google.protobuf.Timestamp delete_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsCount

        int getLabelsCount()
         Labels as key value pairs
        map<string, string> labels = 7;

      • containsLabels

        boolean containsLabels​(String key)
         Labels as key value pairs
        map<string, string> labels = 7;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Labels as key value pairs
        map<string, string> labels = 7;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Labels as key value pairs
        map<string, string> labels = 7;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Labels as key value pairs
        map<string, string> labels = 7;

      • getStateValue

        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:
        The enum numeric value on the wire for state.

      • getState

        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:
        The state.

      • getClusterTypeValue

        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:
        The enum numeric value on the wire for clusterType.

      • getClusterType

        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:
        The clusterType.

      • getDatabaseVersionValue

        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.v1alpha.DatabaseVersion database_version = 9 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for databaseVersion.

      • getDatabaseVersion

        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.v1alpha.DatabaseVersion database_version = 9 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The databaseVersion.

      • hasNetworkConfig

        boolean hasNetworkConfig()
        .google.cloud.alloydb.v1alpha.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the networkConfig field is set.

      • getNetworkConfig

        Cluster.NetworkConfig getNetworkConfig()
        .google.cloud.alloydb.v1alpha.Cluster.NetworkConfig network_config = 29 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The networkConfig.

      • getNetworkConfigOrBuilder

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

      • getNetwork

        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:
        The network.

      • getNetworkBytes

        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) = { ... }
        Returns:
        The bytes for network.

      • getEtag

        String getEtag()
         For Resource freshness validation (https://google.aip.dev/154)
        string etag = 11;
        Returns:
        The etag.

      • getEtagBytes

        com.google.protobuf.ByteString getEtagBytes()
         For Resource freshness validation (https://google.aip.dev/154)
        string etag = 11;
        Returns:
        The bytes for etag.

      • getAnnotationsCount

        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;

      • containsAnnotations

        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;

      • getAnnotationsMap

        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;

      • getAnnotationsOrDefault

        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;

      • getAnnotationsOrThrow

        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;

      • getReconciling

        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:
        The reconciling.

      • hasInitialUser

        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:
        Whether the initialUser field is set.

      • getInitialUser

        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:
        The initialUser.

      • getInitialUserOrBuilder

        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];

      • hasAutomatedBackupPolicy

        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:
        Whether the automatedBackupPolicy field is set.

      • getAutomatedBackupPolicy

        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:
        The automatedBackupPolicy.

      • getAutomatedBackupPolicyOrBuilder

        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;

      • hasSslConfig

        @Deprecated
boolean hasSslConfig()
        Deprecated.
        google.cloud.alloydb.v1alpha.Cluster.ssl_config is deprecated. See google/cloud/alloydb/v1alpha/resources.proto;l=578
         SSL configuration for this AlloyDB cluster.
        .google.cloud.alloydb.v1alpha.SslConfig ssl_config = 18 [deprecated = true];
        Returns:
        Whether the sslConfig field is set.

      • getSslConfig

        @Deprecated
SslConfig getSslConfig()
        Deprecated.
        google.cloud.alloydb.v1alpha.Cluster.ssl_config is deprecated. See google/cloud/alloydb/v1alpha/resources.proto;l=578
         SSL configuration for this AlloyDB cluster.
        .google.cloud.alloydb.v1alpha.SslConfig ssl_config = 18 [deprecated = true];
        Returns:
        The sslConfig.

      • getSslConfigOrBuilder

        @Deprecated
SslConfigOrBuilder getSslConfigOrBuilder()
        Deprecated.
         SSL configuration for this AlloyDB cluster.
        .google.cloud.alloydb.v1alpha.SslConfig ssl_config = 18 [deprecated = true];

      • hasEncryptionConfig

        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:
        Whether the encryptionConfig field is set.

      • getEncryptionConfig

        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:
        The encryptionConfig.

      • getEncryptionConfigOrBuilder

        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];

      • hasEncryptionInfo

        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:
        Whether the encryptionInfo field is set.

      • getEncryptionInfo

        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:
        The encryptionInfo.

      • getEncryptionInfoOrBuilder

        EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()
         Output only. The encryption information for the cluster.
        .google.cloud.alloydb.v1alpha.EncryptionInfo encryption_info = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasContinuousBackupConfig

        boolean hasContinuousBackupConfig()
         Optional. Continuous backup configuration for this cluster.
        .google.cloud.alloydb.v1alpha.ContinuousBackupConfig continuous_backup_config = 27 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the continuousBackupConfig field is set.

      • getContinuousBackupConfig

        ContinuousBackupConfig getContinuousBackupConfig()
         Optional. Continuous backup configuration for this cluster.
        .google.cloud.alloydb.v1alpha.ContinuousBackupConfig continuous_backup_config = 27 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The continuousBackupConfig.

      • getContinuousBackupConfigOrBuilder

        ContinuousBackupConfigOrBuilder getContinuousBackupConfigOrBuilder()
         Optional. Continuous backup configuration for this cluster.
        .google.cloud.alloydb.v1alpha.ContinuousBackupConfig continuous_backup_config = 27 [(.google.api.field_behavior) = OPTIONAL];

      • hasContinuousBackupInfo

        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:
        Whether the continuousBackupInfo field is set.

      • getContinuousBackupInfo

        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:
        The continuousBackupInfo.

      • getContinuousBackupInfoOrBuilder

        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];

      • hasSecondaryConfig

        boolean hasSecondaryConfig()
         Cross Region replication config specific to SECONDARY cluster.
        .google.cloud.alloydb.v1alpha.Cluster.SecondaryConfig secondary_config = 22;
        Returns:
        Whether the secondaryConfig field is set.

      • getSecondaryConfig

        Cluster.SecondaryConfig getSecondaryConfig()
         Cross Region replication config specific to SECONDARY cluster.
        .google.cloud.alloydb.v1alpha.Cluster.SecondaryConfig secondary_config = 22;
        Returns:
        The secondaryConfig.

      • getSecondaryConfigOrBuilder

        Cluster.SecondaryConfigOrBuilder getSecondaryConfigOrBuilder()
         Cross Region replication config specific to SECONDARY cluster.
        .google.cloud.alloydb.v1alpha.Cluster.SecondaryConfig secondary_config = 22;

      • hasPrimaryConfig

        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:
        Whether the primaryConfig field is set.

      • getPrimaryConfig

        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:
        The primaryConfig.

      • getPrimaryConfigOrBuilder

        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];

      • getSatisfiesPzs

        boolean getSatisfiesPzs()
         Reserved for future use.
        bool satisfies_pzs = 30;
        Returns:
        The satisfiesPzs.