Package com.google.cloud.alloydb.v1beta

Interface BackupOrBuilder

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

    • Method Detail

      • getName

        String getName()
         Output only. The name of the backup resource with the format:
  * projects/{project}/locations/{region}/backups/{backup_id}
 where the cluster and backup ID segments should satisfy the regex
 expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of
 lowercase letters, numbers, and dashes, starting with a letter, and ending
 with a letter or number. For more details see https://google.aip.dev/122.
 The prefix of the backup 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 backup resource with the format:
  * projects/{project}/locations/{region}/backups/{backup_id}
 where the cluster and backup ID segments should satisfy the regex
 expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of
 lowercase letters, numbers, and dashes, starting with a letter, and ending
 with a letter or number. For more details see https://google.aip.dev/122.
 The prefix of the backup 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 Backup.
        string display_name = 2;
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         User-settable and human-readable display name for the Backup.
        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 = 15 [(.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 = 15 [(.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 = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsCount

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

      • containsLabels

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

      • getLabelsMap

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

      • getLabelsOrDefault

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

      • getLabelsOrThrow

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

      • getStateValue

        int getStateValue()
         Output only. The current state of the backup.
        .google.cloud.alloydb.v1beta.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for state.

      • getState

        Backup.State getState()
         Output only. The current state of the backup.
        .google.cloud.alloydb.v1beta.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The state.

      • getTypeValue

        int getTypeValue()
         The backup type, which suggests the trigger for the backup.
        .google.cloud.alloydb.v1beta.Backup.Type type = 8;
        Returns:
        The enum numeric value on the wire for type.

      • getType

        Backup.Type getType()
         The backup type, which suggests the trigger for the backup.
        .google.cloud.alloydb.v1beta.Backup.Type type = 8;
        Returns:
        The type.

      • getDescription

        String getDescription()
         User-provided description of the backup.
        string description = 9;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         User-provided description of the backup.
        string description = 9;
        Returns:
        The bytes for description.

      • getClusterUid

        String getClusterUid()
         Output only. The system-generated UID of the cluster which was used to
 create this resource.
        string cluster_uid = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The clusterUid.

      • getClusterUidBytes

        com.google.protobuf.ByteString getClusterUidBytes()
         Output only. The system-generated UID of the cluster which was used to
 create this resource.
        string cluster_uid = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for clusterUid.

      • getClusterName

        String getClusterName()
         Required. The full resource name of the backup source cluster
 (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
        string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The clusterName.

      • getClusterNameBytes

        com.google.protobuf.ByteString getClusterNameBytes()
         Required. The full resource name of the backup source cluster
 (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
        string cluster_name = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for clusterName.

      • getReconciling

        boolean getReconciling()
         Output only. Reconciling (https://google.aip.dev/128#reconciliation), if
 true, indicates that the service is actively updating the resource. This
 can happen due to user-triggered updates or system actions like failover or
 maintenance.
        bool reconciling = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The reconciling.

      • hasEncryptionConfig

        boolean hasEncryptionConfig()
         Optional. The encryption config can be specified to encrypt the
 backup with a customer-managed encryption key (CMEK). When this field is
 not specified, the backup will then use default encryption scheme to
 protect the user data.
        .google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.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
 backup with a customer-managed encryption key (CMEK). When this field is
 not specified, the backup will then use default encryption scheme to
 protect the user data.
        .google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The encryptionConfig.

      • getEncryptionConfigOrBuilder

        EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
         Optional. The encryption config can be specified to encrypt the
 backup with a customer-managed encryption key (CMEK). When this field is
 not specified, the backup will then use default encryption scheme to
 protect the user data.
        .google.cloud.alloydb.v1beta.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];

      • hasEncryptionInfo

        boolean hasEncryptionInfo()
         Output only. The encryption information for the backup.
        .google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the encryptionInfo field is set.

      • getEncryptionInfo

        EncryptionInfo getEncryptionInfo()
         Output only. The encryption information for the backup.
        .google.cloud.alloydb.v1beta.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The encryptionInfo.

      • getEncryptionInfoOrBuilder

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

      • getEtag

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

      • getEtagBytes

        com.google.protobuf.ByteString getEtagBytes()
         For Resource freshness validation (https://google.aip.dev/154)
        string etag = 14;
        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 = 16;

      • 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 = 16;

      • 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 = 16;

      • 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 = 16;

      • 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 = 16;

      • getSizeBytes

        long getSizeBytes()
         Output only. The size of the backup in bytes.
        int64 size_bytes = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The sizeBytes.

      • hasExpiryTime

        boolean hasExpiryTime()
         Output only. The time at which after the backup is eligible to be garbage
 collected. It is the duration specified by the backup's retention policy,
 added to the backup's create_time.
        .google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the expiryTime field is set.

      • getExpiryTime

        com.google.protobuf.Timestamp getExpiryTime()
         Output only. The time at which after the backup is eligible to be garbage
 collected. It is the duration specified by the backup's retention policy,
 added to the backup's create_time.
        .google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The expiryTime.

      • getExpiryTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getExpiryTimeOrBuilder()
         Output only. The time at which after the backup is eligible to be garbage
 collected. It is the duration specified by the backup's retention policy,
 added to the backup's create_time.
        .google.protobuf.Timestamp expiry_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];