Class CreateBackupRequest.Builder (6.83.0)

public static final class CreateBackupRequest.Builder extends GeneratedMessageV3.Builder<CreateBackupRequest.Builder> implements CreateBackupRequestOrBuilder

The request for CreateBackup.

Protobuf type google.spanner.admin.database.v1.CreateBackupRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateBackupRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateBackupRequest.Builder
Overrides

build()

public CreateBackupRequest build()
Returns
Type Description
CreateBackupRequest

buildPartial()

public CreateBackupRequest buildPartial()
Returns
Type Description
CreateBackupRequest

clear()

public CreateBackupRequest.Builder clear()
Returns
Type Description
CreateBackupRequest.Builder
Overrides

clearBackup()

public CreateBackupRequest.Builder clearBackup()

Required. The backup to create.

.google.spanner.admin.database.v1.Backup backup = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateBackupRequest.Builder

clearBackupId()

public CreateBackupRequest.Builder clearBackupId()

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/<project>/instances/<instance>/backups/<backup_id>.

string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateBackupRequest.Builder

This builder for chaining.

clearEncryptionConfig()

public CreateBackupRequest.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 database by default, namely encryption_type = USE_DATABASE_ENCRYPTION.

.google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreateBackupRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public CreateBackupRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CreateBackupRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateBackupRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreateBackupRequest.Builder
Overrides

clearParent()

public CreateBackupRequest.Builder clearParent()

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/<project>/instances/<instance>.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
CreateBackupRequest.Builder

This builder for chaining.

clone()

public CreateBackupRequest.Builder clone()
Returns
Type Description
CreateBackupRequest.Builder
Overrides

getBackup()

public Backup getBackup()

Required. The backup to create.

.google.spanner.admin.database.v1.Backup backup = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Backup

The backup.

getBackupBuilder()

public Backup.Builder getBackupBuilder()

Required. The backup to create.

.google.spanner.admin.database.v1.Backup backup = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Backup.Builder

getBackupId()

public String getBackupId()

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/<project>/instances/<instance>/backups/<backup_id>.

string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The backupId.

getBackupIdBytes()

public ByteString getBackupIdBytes()

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/<project>/instances/<instance>/backups/<backup_id>.

string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for backupId.

getBackupOrBuilder()

public BackupOrBuilder getBackupOrBuilder()

Required. The backup to create.

.google.spanner.admin.database.v1.Backup backup = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BackupOrBuilder

getDefaultInstanceForType()

public CreateBackupRequest getDefaultInstanceForType()
Returns
Type Description
CreateBackupRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEncryptionConfig()

public CreateBackupEncryptionConfig 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 database by default, namely encryption_type = USE_DATABASE_ENCRYPTION.

.google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreateBackupEncryptionConfig

The encryptionConfig.

getEncryptionConfigBuilder()

public CreateBackupEncryptionConfig.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 database by default, namely encryption_type = USE_DATABASE_ENCRYPTION.

.google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreateBackupEncryptionConfig.Builder

getEncryptionConfigOrBuilder()

public CreateBackupEncryptionConfigOrBuilder 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 database by default, namely encryption_type = USE_DATABASE_ENCRYPTION.

.google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreateBackupEncryptionConfigOrBuilder

getParent()

public String getParent()

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/<project>/instances/<instance>.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/<project>/instances/<instance>.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

hasBackup()

public boolean hasBackup()

Required. The backup to create.

.google.spanner.admin.database.v1.Backup backup = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the backup field is set.

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 database by default, namely encryption_type = USE_DATABASE_ENCRYPTION.

.google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the encryptionConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBackup(Backup value)

public CreateBackupRequest.Builder mergeBackup(Backup value)

Required. The backup to create.

.google.spanner.admin.database.v1.Backup backup = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Backup
Returns
Type Description
CreateBackupRequest.Builder

mergeEncryptionConfig(CreateBackupEncryptionConfig value)

public CreateBackupRequest.Builder mergeEncryptionConfig(CreateBackupEncryptionConfig 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 database by default, namely encryption_type = USE_DATABASE_ENCRYPTION.

.google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CreateBackupEncryptionConfig
Returns
Type Description
CreateBackupRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateBackupRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBackupRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CreateBackupRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CreateBackupRequest.Builder
Overrides

mergeFrom(CreateBackupRequest other)

public CreateBackupRequest.Builder mergeFrom(CreateBackupRequest other)
Parameter
Name Description
other CreateBackupRequest
Returns
Type Description
CreateBackupRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateBackupRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateBackupRequest.Builder
Overrides

setBackup(Backup value)

public CreateBackupRequest.Builder setBackup(Backup value)

Required. The backup to create.

.google.spanner.admin.database.v1.Backup backup = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Backup
Returns
Type Description
CreateBackupRequest.Builder

setBackup(Backup.Builder builderForValue)

public CreateBackupRequest.Builder setBackup(Backup.Builder builderForValue)

Required. The backup to create.

.google.spanner.admin.database.v1.Backup backup = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Backup.Builder
Returns
Type Description
CreateBackupRequest.Builder

setBackupId(String value)

public CreateBackupRequest.Builder setBackupId(String value)

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/<project>/instances/<instance>/backups/<backup_id>.

string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The backupId to set.

Returns
Type Description
CreateBackupRequest.Builder

This builder for chaining.

setBackupIdBytes(ByteString value)

public CreateBackupRequest.Builder setBackupIdBytes(ByteString value)

Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/<project>/instances/<instance>/backups/<backup_id>.

string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for backupId to set.

Returns
Type Description
CreateBackupRequest.Builder

This builder for chaining.

setEncryptionConfig(CreateBackupEncryptionConfig value)

public CreateBackupRequest.Builder setEncryptionConfig(CreateBackupEncryptionConfig 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 database by default, namely encryption_type = USE_DATABASE_ENCRYPTION.

.google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CreateBackupEncryptionConfig
Returns
Type Description
CreateBackupRequest.Builder

setEncryptionConfig(CreateBackupEncryptionConfig.Builder builderForValue)

public CreateBackupRequest.Builder setEncryptionConfig(CreateBackupEncryptionConfig.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 database by default, namely encryption_type = USE_DATABASE_ENCRYPTION.

.google.spanner.admin.database.v1.CreateBackupEncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue CreateBackupEncryptionConfig.Builder
Returns
Type Description
CreateBackupRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CreateBackupRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateBackupRequest.Builder
Overrides

setParent(String value)

public CreateBackupRequest.Builder setParent(String value)

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/<project>/instances/<instance>.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateBackupRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateBackupRequest.Builder setParentBytes(ByteString value)

Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/<project>/instances/<instance>.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateBackupRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CreateBackupRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CreateBackupRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateBackupRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateBackupRequest.Builder
Overrides