Class CreateCloudBackupAction (6.89.0)

publicfinalclassCreateCloudBackupActionextendsGeneratedMessageV3implementsCreateCloudBackupActionOrBuilder

Action that creates a Cloud Spanner database backup.

Protobuf type google.spanner.executor.v1.CreateCloudBackupAction

Static Fields

BACKUP_ID_FIELD_NUMBER

publicstaticfinalintBACKUP_ID_FIELD_NUMBER
Field Value
TypeDescription
int

DATABASE_ID_FIELD_NUMBER

publicstaticfinalintDATABASE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

ENCRYPTION_CONFIG_FIELD_NUMBER

publicstaticfinalintENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

EXPIRE_TIME_FIELD_NUMBER

publicstaticfinalintEXPIRE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_ID_FIELD_NUMBER

publicstaticfinalintINSTANCE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

publicstaticfinalintPROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_TIME_FIELD_NUMBER

publicstaticfinalintVERSION_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

publicstaticCreateCloudBackupActiongetDefaultInstance()
Returns
TypeDescription
CreateCloudBackupAction

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticCreateCloudBackupAction.BuildernewBuilder()
Returns
TypeDescription
CreateCloudBackupAction.Builder

newBuilder(CreateCloudBackupAction prototype)

publicstaticCreateCloudBackupAction.BuildernewBuilder(CreateCloudBackupActionprototype)
Parameter
NameDescription
prototypeCreateCloudBackupAction
Returns
TypeDescription
CreateCloudBackupAction.Builder

parseDelimitedFrom(InputStream input)

publicstaticCreateCloudBackupActionparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateCloudBackupAction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticCreateCloudBackupActionparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCloudBackupAction
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticCreateCloudBackupActionparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateCloudBackupAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticCreateCloudBackupActionparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCloudBackupAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticCreateCloudBackupActionparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateCloudBackupAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticCreateCloudBackupActionparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCloudBackupAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticCreateCloudBackupActionparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateCloudBackupAction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticCreateCloudBackupActionparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCloudBackupAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticCreateCloudBackupActionparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateCloudBackupAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticCreateCloudBackupActionparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCloudBackupAction
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticCreateCloudBackupActionparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateCloudBackupAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticCreateCloudBackupActionparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCloudBackupAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

publicstaticParser<CreateCloudBackupAction>parser()
Returns
TypeDescription
Parser<CreateCloudBackupAction>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBackupId()

publicStringgetBackupId()

The id of the backup to be created, e.g. "test-backup".

string backup_id = 3;

Returns
TypeDescription
String

The backupId.

getBackupIdBytes()

publicByteStringgetBackupIdBytes()

The id of the backup to be created, e.g. "test-backup".

string backup_id = 3;

Returns
TypeDescription
ByteString

The bytes for backupId.

getDatabaseId()

publicStringgetDatabaseId()

The id of the database from which this backup was created, e.g. "db0". Note that this needs to be in the same instance as the backup.

string database_id = 4;

Returns
TypeDescription
String

The databaseId.

getDatabaseIdBytes()

publicByteStringgetDatabaseIdBytes()

The id of the database from which this backup was created, e.g. "db0". Note that this needs to be in the same instance as the backup.

string database_id = 4;

Returns
TypeDescription
ByteString

The bytes for databaseId.

getDefaultInstanceForType()

publicCreateCloudBackupActiongetDefaultInstanceForType()
Returns
TypeDescription
CreateCloudBackupAction

getEncryptionConfig()

publicEncryptionConfiggetEncryptionConfig()

The KMS key(s) used to encrypt the backup to be created if the backup should be CMEK protected.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 7;

Returns
TypeDescription
EncryptionConfig

The encryptionConfig.

getEncryptionConfigOrBuilder()

publicEncryptionConfigOrBuildergetEncryptionConfigOrBuilder()

The KMS key(s) used to encrypt the backup to be created if the backup should be CMEK protected.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 7;

Returns
TypeDescription
EncryptionConfigOrBuilder

getExpireTime()

publicTimestampgetExpireTime()

Output only. The expiration time of the backup, which must be at least 6 hours and at most 366 days from the time the request is received.

.google.protobuf.Timestamp expire_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The expireTime.

getExpireTimeOrBuilder()

publicTimestampOrBuildergetExpireTimeOrBuilder()

Output only. The expiration time of the backup, which must be at least 6 hours and at most 366 days from the time the request is received.

.google.protobuf.Timestamp expire_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getInstanceId()

publicStringgetInstanceId()

Cloud instance ID (not path), e.g. "test-instance".

string instance_id = 2;

Returns
TypeDescription
String

The instanceId.

getInstanceIdBytes()

publicByteStringgetInstanceIdBytes()

Cloud instance ID (not path), e.g. "test-instance".

string instance_id = 2;

Returns
TypeDescription
ByteString

The bytes for instanceId.

getParserForType()

publicParser<CreateCloudBackupAction>getParserForType()
Returns
TypeDescription
Parser<CreateCloudBackupAction>
Overrides

getProjectId()

publicStringgetProjectId()

Cloud project ID, e.g. "spanner-cloud-systest".

string project_id = 1;

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

publicByteStringgetProjectIdBytes()

Cloud project ID, e.g. "spanner-cloud-systest".

string project_id = 1;

Returns
TypeDescription
ByteString

The bytes for projectId.

getSerializedSize()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

getVersionTime()

publicTimestampgetVersionTime()

The version time of the backup, which must be within the time range of [earliest_version_time, NOW], where earliest_version_time is retrieved by cloud spanner frontend API (See details: go/cs-pitr-lite-design).

optional .google.protobuf.Timestamp version_time = 6;

Returns
TypeDescription
Timestamp

The versionTime.

getVersionTimeOrBuilder()

publicTimestampOrBuildergetVersionTimeOrBuilder()

The version time of the backup, which must be within the time range of [earliest_version_time, NOW], where earliest_version_time is retrieved by cloud spanner frontend API (See details: go/cs-pitr-lite-design).

optional .google.protobuf.Timestamp version_time = 6;

Returns
TypeDescription
TimestampOrBuilder

hasEncryptionConfig()

publicbooleanhasEncryptionConfig()

The KMS key(s) used to encrypt the backup to be created if the backup should be CMEK protected.

.google.spanner.admin.database.v1.EncryptionConfig encryption_config = 7;

Returns
TypeDescription
boolean

Whether the encryptionConfig field is set.

hasExpireTime()

publicbooleanhasExpireTime()

Output only. The expiration time of the backup, which must be at least 6 hours and at most 366 days from the time the request is received.

.google.protobuf.Timestamp expire_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the expireTime field is set.

hasVersionTime()

publicbooleanhasVersionTime()

The version time of the backup, which must be within the time range of [earliest_version_time, NOW], where earliest_version_time is retrieved by cloud spanner frontend API (See details: go/cs-pitr-lite-design).

optional .google.protobuf.Timestamp version_time = 6;

Returns
TypeDescription
boolean

Whether the versionTime field is set.

hashCode()

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicCreateCloudBackupAction.BuildernewBuilderForType()
Returns
TypeDescription
CreateCloudBackupAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedCreateCloudBackupAction.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateCloudBackupAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

publicCreateCloudBackupAction.BuildertoBuilder()
Returns
TypeDescription
CreateCloudBackupAction.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException