Package com.google.cloud.alloydb.v1

Class Backup

  • All Implemented Interfaces:
    BackupOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Backup
extends com.google.protobuf.GeneratedMessageV3
implements BackupOrBuilder
     Message describing Backup object
    Protobuf type google.cloud.alloydb.v1.Backup
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.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 class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public 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];
        Specified by:
        getName in interface BackupOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface BackupOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         User-settable and human-readable display name for the Backup.
        string display_name = 2;
        Specified by:
        getDisplayName in interface BackupOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         User-settable and human-readable display name for the Backup.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface BackupOrBuilder
        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 interface BackupOrBuilder
        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 interface BackupOrBuilder
        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 interface BackupOrBuilder
        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 interface BackupOrBuilder
        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 interface BackupOrBuilder

      • 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 interface BackupOrBuilder
        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 interface BackupOrBuilder
        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 interface BackupOrBuilder

      • hasDeleteTime

        public boolean hasDeleteTime()
         Output only. Delete time stamp
        .google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDeleteTime in interface BackupOrBuilder
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        public com.google.protobuf.Timestamp getDeleteTime()
         Output only. Delete time stamp
        .google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeleteTime in interface BackupOrBuilder
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
         Output only. Delete time stamp
        .google.protobuf.Timestamp delete_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeleteTimeOrBuilder in interface BackupOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Labels as key value pairs
        map<string, string> labels = 6;
        Specified by:
        containsLabels in interface BackupOrBuilder

      • getStateValue

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

      • getState

        public Backup.State getState()
         Output only. The current state of the backup.
        .google.cloud.alloydb.v1.Backup.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface BackupOrBuilder
        Returns:
        The state.

      • getTypeValue

        public int getTypeValue()
         The backup type, which suggests the trigger for the backup.
        .google.cloud.alloydb.v1.Backup.Type type = 8;
        Specified by:
        getTypeValue in interface BackupOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • getType

        public Backup.Type getType()
         The backup type, which suggests the trigger for the backup.
        .google.cloud.alloydb.v1.Backup.Type type = 8;
        Specified by:
        getType in interface BackupOrBuilder
        Returns:
        The type.

      • getDescription

        public String getDescription()
         User-provided description of the backup.
        string description = 9;
        Specified by:
        getDescription in interface BackupOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

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

      • getClusterUid

        public 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];
        Specified by:
        getClusterUid in interface BackupOrBuilder
        Returns:
        The clusterUid.

      • getClusterUidBytes

        public 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];
        Specified by:
        getClusterUidBytes in interface BackupOrBuilder
        Returns:
        The bytes for clusterUid.

      • getClusterName

        public 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) = { ... }
        Specified by:
        getClusterName in interface BackupOrBuilder
        Returns:
        The clusterName.

      • getClusterNameBytes

        public 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) = { ... }
        Specified by:
        getClusterNameBytes in interface BackupOrBuilder
        Returns:
        The bytes for clusterName.

      • getReconciling

        public 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];
        Specified by:
        getReconciling in interface BackupOrBuilder
        Returns:
        The reconciling.

      • hasEncryptionConfig

        public 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.v1.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasEncryptionConfig in interface BackupOrBuilder
        Returns:
        Whether the encryptionConfig field is set.

      • getEncryptionConfig

        public 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.v1.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEncryptionConfig in interface BackupOrBuilder
        Returns:
        The encryptionConfig.

      • getEncryptionConfigOrBuilder

        public 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.v1.EncryptionConfig encryption_config = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEncryptionConfigOrBuilder in interface BackupOrBuilder

      • hasEncryptionInfo

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

      • getEncryptionInfo

        public EncryptionInfo getEncryptionInfo()
         Output only. The encryption information for the backup.
        .google.cloud.alloydb.v1.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEncryptionInfo in interface BackupOrBuilder
        Returns:
        The encryptionInfo.

      • getEncryptionInfoOrBuilder

        public EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()
         Output only. The encryption information for the backup.
        .google.cloud.alloydb.v1.EncryptionInfo encryption_info = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEncryptionInfoOrBuilder in interface BackupOrBuilder

      • getEtag

        public String getEtag()
         For Resource freshness validation (https://google.aip.dev/154)
        string etag = 14;
        Specified by:
        getEtag in interface BackupOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         For Resource freshness validation (https://google.aip.dev/154)
        string etag = 14;
        Specified by:
        getEtagBytes in interface BackupOrBuilder
        Returns:
        The bytes for etag.

      • getAnnotationsCount

        public int getAnnotationsCount()
        Description copied from interface: BackupOrBuilder
         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;
        Specified by:
        getAnnotationsCount in interface BackupOrBuilder

      • 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 = 16;
        Specified by:
        containsAnnotations in interface BackupOrBuilder

      • 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 = 16;
        Specified by:
        getAnnotationsMap in interface BackupOrBuilder

      • 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 = 16;
        Specified by:
        getAnnotationsOrDefault in interface BackupOrBuilder

      • 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 = 16;
        Specified by:
        getAnnotationsOrThrow in interface BackupOrBuilder

      • getSizeBytes

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

      • hasExpiryTime

        public 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];
        Specified by:
        hasExpiryTime in interface BackupOrBuilder
        Returns:
        Whether the expiryTime field is set.

      • getExpiryTime

        public 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];
        Specified by:
        getExpiryTime in interface BackupOrBuilder
        Returns:
        The expiryTime.

      • getExpiryTimeOrBuilder

        public 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];
        Specified by:
        getExpiryTimeOrBuilder in interface BackupOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Backup parseFrom​(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Backup parseFrom​(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Backup parseFrom​(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Backup parseFrom​(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Backup parseFrom​(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Backup parseFrom​(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Backup parseFrom​(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Backup.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Backup.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Backup.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Backup getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Backup> parser()

      • getParserForType

        public com.google.protobuf.Parser<Backup> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Backup getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder