Class CreateBackupRequest (6.83.0)

public final class CreateBackupRequest extends GeneratedMessageV3 implements CreateBackupRequestOrBuilder

The request for CreateBackup.

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

Static Fields

BACKUP_FIELD_NUMBER

public static final int BACKUP_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_ID_FIELD_NUMBER

public static final int BACKUP_ID_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_CONFIG_FIELD_NUMBER

public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateBackupRequest getDefaultInstance()
Returns
Type Description
CreateBackupRequest

getDescriptor()

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

newBuilder()

public static CreateBackupRequest.Builder newBuilder()
Returns
Type Description
CreateBackupRequest.Builder

newBuilder(CreateBackupRequest prototype)

public static CreateBackupRequest.Builder newBuilder(CreateBackupRequest prototype)
Parameter
Name Description
prototype CreateBackupRequest
Returns
Type Description
CreateBackupRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateBackupRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateBackupRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateBackupRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBackupRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateBackupRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateBackupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateBackupRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBackupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateBackupRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateBackupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateBackupRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBackupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateBackupRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateBackupRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateBackupRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBackupRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateBackupRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateBackupRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateBackupRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBackupRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateBackupRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateBackupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateBackupRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateBackupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateBackupRequest> parser()
Returns
Type Description
Parser<CreateBackupRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

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.

getParserForType()

public Parser<CreateBackupRequest> getParserForType()
Returns
Type Description
Parser<CreateBackupRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateBackupRequest.Builder newBuilderForType()
Returns
Type Description
CreateBackupRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateBackupRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateBackupRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateBackupRequest.Builder toBuilder()
Returns
Type Description
CreateBackupRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException