Class CopyBackupRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CopyBackupRequestOrBuilder, Serializable

    public final class CopyBackupRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements CopyBackupRequestOrBuilder
     The request for [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup].
     
    Protobuf type google.spanner.admin.database.v1.CopyBackupRequest
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

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

        public String getParent()
         Required. The name of the destination instance that will contain the backup copy.
         Values are of the form: `projects/<project>/instances/<instance>`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface CopyBackupRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The name of the destination instance that will contain the backup copy.
         Values are of the form: `projects/<project>/instances/<instance>`.
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface CopyBackupRequestOrBuilder
        Returns:
        The bytes for parent.
      • getBackupId

        public String getBackupId()
         Required. The id of the backup copy.
         The `backup_id` appended to `parent` forms the full backup_uri of the form
         `projects/<project>/instances/<instance>/backups/<backup>`.
         
        string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBackupId in interface CopyBackupRequestOrBuilder
        Returns:
        The backupId.
      • getBackupIdBytes

        public com.google.protobuf.ByteString getBackupIdBytes()
         Required. The id of the backup copy.
         The `backup_id` appended to `parent` forms the full backup_uri of the form
         `projects/<project>/instances/<instance>/backups/<backup>`.
         
        string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getBackupIdBytes in interface CopyBackupRequestOrBuilder
        Returns:
        The bytes for backupId.
      • getSourceBackup

        public String getSourceBackup()
         Required. The source backup to be copied.
         The source backup needs to be in READY state for it to be copied.
         Once CopyBackup is in progress, the source backup cannot be deleted or
         cleaned up on expiration until CopyBackup is finished.
         Values are of the form:
         `projects/<project>/instances/<instance>/backups/<backup>`.
         
        string source_backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getSourceBackup in interface CopyBackupRequestOrBuilder
        Returns:
        The sourceBackup.
      • getSourceBackupBytes

        public com.google.protobuf.ByteString getSourceBackupBytes()
         Required. The source backup to be copied.
         The source backup needs to be in READY state for it to be copied.
         Once CopyBackup is in progress, the source backup cannot be deleted or
         cleaned up on expiration until CopyBackup is finished.
         Values are of the form:
         `projects/<project>/instances/<instance>/backups/<backup>`.
         
        string source_backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getSourceBackupBytes in interface CopyBackupRequestOrBuilder
        Returns:
        The bytes for sourceBackup.
      • hasExpireTime

        public boolean hasExpireTime()
         Required. The expiration time of the backup in microsecond granularity.
         The expiration time must be at least 6 hours and at most 366 days
         from the `create_time` of the source backup. Once the `expire_time` has
         passed, the backup is eligible to be automatically deleted by Cloud Spanner
         to free the resources used by the backup.
         
        .google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasExpireTime in interface CopyBackupRequestOrBuilder
        Returns:
        Whether the expireTime field is set.
      • getExpireTime

        public com.google.protobuf.Timestamp getExpireTime()
         Required. The expiration time of the backup in microsecond granularity.
         The expiration time must be at least 6 hours and at most 366 days
         from the `create_time` of the source backup. Once the `expire_time` has
         passed, the backup is eligible to be automatically deleted by Cloud Spanner
         to free the resources used by the backup.
         
        .google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getExpireTime in interface CopyBackupRequestOrBuilder
        Returns:
        The expireTime.
      • getExpireTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
         Required. The expiration time of the backup in microsecond granularity.
         The expiration time must be at least 6 hours and at most 366 days
         from the `create_time` of the source backup. Once the `expire_time` has
         passed, the backup is eligible to be automatically deleted by Cloud Spanner
         to free the resources used by the backup.
         
        .google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getExpireTimeOrBuilder in interface CopyBackupRequestOrBuilder
      • hasEncryptionConfig

        public boolean hasEncryptionConfig()
         Optional. The encryption configuration used to encrypt the backup. If this field is
         not specified, the backup will use the same
         encryption configuration as the source backup by default, namely
         [encryption_type][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type] =
         `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
         
        .google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasEncryptionConfig in interface CopyBackupRequestOrBuilder
        Returns:
        Whether the encryptionConfig field is set.
      • getEncryptionConfig

        public CopyBackupEncryptionConfig getEncryptionConfig()
         Optional. The encryption configuration used to encrypt the backup. If this field is
         not specified, the backup will use the same
         encryption configuration as the source backup by default, namely
         [encryption_type][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type] =
         `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
         
        .google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEncryptionConfig in interface CopyBackupRequestOrBuilder
        Returns:
        The encryptionConfig.
      • getEncryptionConfigOrBuilder

        public CopyBackupEncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
         Optional. The encryption configuration used to encrypt the backup. If this field is
         not specified, the backup will use the same
         encryption configuration as the source backup by default, namely
         [encryption_type][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type] =
         `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
         
        .google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEncryptionConfigOrBuilder in interface CopyBackupRequestOrBuilder
      • 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 CopyBackupRequest parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public com.google.protobuf.Parser<CopyBackupRequest> 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 CopyBackupRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder