Class CreateCloudBackupAction (6.83.0)

public final class CreateCloudBackupAction extends GeneratedMessageV3 implements CreateCloudBackupActionOrBuilder

Action that creates a Cloud Spanner database backup.

Protobuf type google.spanner.executor.v1.CreateCloudBackupAction

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CreateCloudBackupAction

Implements

CreateCloudBackupActionOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BACKUP_ID_FIELD_NUMBER

public static final int BACKUP_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_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`

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

INSTANCE_ID_FIELD_NUMBER

public static final int INSTANCE_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

VERSION_TIME_FIELD_NUMBER

public static final int VERSION_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static CreateCloudBackupAction getDefaultInstance()

Returns
Type	Description
`CreateCloudBackupAction`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static CreateCloudBackupAction.Builder newBuilder()

Returns
Type	Description
`CreateCloudBackupAction.Builder`

newBuilder(CreateCloudBackupAction prototype)

public static CreateCloudBackupAction.Builder newBuilder(CreateCloudBackupAction prototype)

Parameter
Name	Description
`prototype`	`CreateCloudBackupAction`

Returns
Type	Description
`CreateCloudBackupAction.Builder`

parseDelimitedFrom(InputStream input)

public static CreateCloudBackupAction parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CreateCloudBackupAction`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateCloudBackupAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CreateCloudBackupAction`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static CreateCloudBackupAction parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`CreateCloudBackupAction`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateCloudBackupAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CreateCloudBackupAction`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static CreateCloudBackupAction parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`CreateCloudBackupAction`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateCloudBackupAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CreateCloudBackupAction`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static CreateCloudBackupAction parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`CreateCloudBackupAction`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateCloudBackupAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CreateCloudBackupAction`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static CreateCloudBackupAction parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CreateCloudBackupAction`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateCloudBackupAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CreateCloudBackupAction`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static CreateCloudBackupAction parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`CreateCloudBackupAction`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateCloudBackupAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CreateCloudBackupAction`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<CreateCloudBackupAction> parser()

Returns
Type	Description
`Parser<CreateCloudBackupAction>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getBackupId()

public String getBackupId()

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

string backup_id = 3;

Returns
Type	Description
`String`	The backupId.

getBackupIdBytes()

public ByteString getBackupIdBytes()

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

string backup_id = 3;

Returns
Type	Description
`ByteString`	The bytes for backupId.

getDatabaseId()

public String getDatabaseId()

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
Type	Description
`String`	The databaseId.

getDatabaseIdBytes()

public ByteString getDatabaseIdBytes()

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
Type	Description
`ByteString`	The bytes for databaseId.

getDefaultInstanceForType()

public CreateCloudBackupAction getDefaultInstanceForType()

Returns
Type	Description
`CreateCloudBackupAction`

getEncryptionConfig()

public EncryptionConfig getEncryptionConfig()

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
Type	Description
`EncryptionConfig`	The encryptionConfig.

getEncryptionConfigOrBuilder()

public EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

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
Type	Description
`EncryptionConfigOrBuilder`

getExpireTime()

public Timestamp getExpireTime()

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
Type	Description
`Timestamp`	The expireTime.

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

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
Type	Description
`TimestampOrBuilder`

getInstanceId()

public String getInstanceId()

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

string instance_id = 2;

Returns
Type	Description
`String`	The instanceId.

getInstanceIdBytes()

public ByteString getInstanceIdBytes()

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

string instance_id = 2;

Returns
Type	Description
`ByteString`	The bytes for instanceId.

getParserForType()

public Parser<CreateCloudBackupAction> getParserForType()

Returns
Type	Description
`Parser<CreateCloudBackupAction>`

Overrides

GeneratedMessageV3.getParserForType()

getProjectId()

public String getProjectId()

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

string project_id = 1;

Returns
Type	Description
`String`	The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

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

string project_id = 1;

Returns
Type	Description
`ByteString`	The bytes for projectId.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getVersionTime()

public Timestamp getVersionTime()

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
Type	Description
`Timestamp`	The versionTime.

getVersionTimeOrBuilder()

public TimestampOrBuilder getVersionTimeOrBuilder()

optional .google.protobuf.Timestamp version_time = 6;

Returns
Type	Description
`TimestampOrBuilder`

hasEncryptionConfig()

public boolean hasEncryptionConfig()

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
Type	Description
`boolean`	Whether the encryptionConfig field is set.

hasExpireTime()

public boolean hasExpireTime()

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
Type	Description
`boolean`	Whether the expireTime field is set.

hasVersionTime()

public boolean hasVersionTime()

optional .google.protobuf.Timestamp version_time = 6;

Returns
Type	Description
`boolean`	Whether the versionTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public CreateCloudBackupAction.Builder newBuilderForType()

Returns
Type	Description
`CreateCloudBackupAction.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateCloudBackupAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`CreateCloudBackupAction.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CreateCloudBackupAction.Builder toBuilder()

Returns
Type	Description
`CreateCloudBackupAction.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`