Package com.google.spanner.admin.database.v1

Class CopyBackupRequest.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CopyBackupRequestOrBuilder, Cloneable
    Enclosing class:
    CopyBackupRequest
    public static final class CopyBackupRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<CopyBackupRequest.Builder>
implements CopyBackupRequestOrBuilder
     The request for [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup].
    Protobuf type google.spanner.admin.database.v1.CopyBackupRequest

    • Method Detail

      • 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.Builder<CopyBackupRequest.Builder>

      • clear

        public CopyBackupRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<CopyBackupRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CopyBackupRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public CopyBackupRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<CopyBackupRequest.Builder>

      • setField

        public CopyBackupRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<CopyBackupRequest.Builder>

      • clearField

        public CopyBackupRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CopyBackupRequest.Builder>

      • clearOneof

        public CopyBackupRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CopyBackupRequest.Builder>

      • setRepeatedField

        public CopyBackupRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CopyBackupRequest.Builder>

      • addRepeatedField

        public CopyBackupRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CopyBackupRequest.Builder>

      • mergeFrom

        public CopyBackupRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CopyBackupRequest.Builder>

      • isInitialized

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

      • mergeFrom

        public CopyBackupRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CopyBackupRequest.Builder>
        Throws:
        IOException

      • 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.

      • setParent

        public CopyBackupRequest.Builder setParent​(String value)
         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) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.

      • clearParent

        public CopyBackupRequest.Builder clearParent()
         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) = { ... }
        Returns:
        This builder for chaining.

      • setParentBytes

        public CopyBackupRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.

      • 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.

      • setBackupId

        public CopyBackupRequest.Builder setBackupId​(String value)
         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];
        Parameters:
        value - The backupId to set.
        Returns:
        This builder for chaining.

      • clearBackupId

        public CopyBackupRequest.Builder clearBackupId()
         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];
        Returns:
        This builder for chaining.

      • setBackupIdBytes

        public CopyBackupRequest.Builder setBackupIdBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for backupId to set.
        Returns:
        This builder for chaining.

      • 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.

      • setSourceBackup

        public CopyBackupRequest.Builder setSourceBackup​(String value)
         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) = { ... }
        Parameters:
        value - The sourceBackup to set.
        Returns:
        This builder for chaining.

      • clearSourceBackup

        public CopyBackupRequest.Builder clearSourceBackup()
         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) = { ... }
        Returns:
        This builder for chaining.

      • setSourceBackupBytes

        public CopyBackupRequest.Builder setSourceBackupBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for sourceBackup to set.
        Returns:
        This builder for chaining.

      • 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.

      • setExpireTime

        public CopyBackupRequest.Builder setExpireTime​(com.google.protobuf.Timestamp value)
         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];

      • setExpireTime

        public CopyBackupRequest.Builder setExpireTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         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];

      • mergeExpireTime

        public CopyBackupRequest.Builder mergeExpireTime​(com.google.protobuf.Timestamp value)
         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];

      • clearExpireTime

        public CopyBackupRequest.Builder clearExpireTime()
         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];

      • getExpireTimeBuilder

        public com.google.protobuf.Timestamp.Builder getExpireTimeBuilder()
         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];

      • 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.

      • setEncryptionConfig

        public CopyBackupRequest.Builder setEncryptionConfig​(CopyBackupEncryptionConfig value)
         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];

      • setEncryptionConfig

        public CopyBackupRequest.Builder setEncryptionConfig​(CopyBackupEncryptionConfig.Builder builderForValue)
         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];

      • mergeEncryptionConfig

        public CopyBackupRequest.Builder mergeEncryptionConfig​(CopyBackupEncryptionConfig value)
         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];

      • clearEncryptionConfig

        public CopyBackupRequest.Builder clearEncryptionConfig()
         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];

      • getEncryptionConfigBuilder

        public CopyBackupEncryptionConfig.Builder getEncryptionConfigBuilder()
         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];

      • 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

      • setUnknownFields

        public final CopyBackupRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CopyBackupRequest.Builder>

      • mergeUnknownFields

        public final CopyBackupRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CopyBackupRequest.Builder>