Class CreateCloudBackupAction.Builder (6.83.0)

public static final class CreateCloudBackupAction.Builder extends GeneratedMessageV3.Builder<CreateCloudBackupAction.Builder> implements CreateCloudBackupActionOrBuilder

Action that creates a Cloud Spanner database backup.

Protobuf type google.spanner.executor.v1.CreateCloudBackupAction

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CreateCloudBackupAction build()
Returns
Type Description
CreateCloudBackupAction

buildPartial()

public CreateCloudBackupAction buildPartial()
Returns
Type Description
CreateCloudBackupAction

clear()

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

clearBackupId()

public CreateCloudBackupAction.Builder clearBackupId()

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

string backup_id = 3;

Returns
Type Description
CreateCloudBackupAction.Builder

This builder for chaining.

clearDatabaseId()

public CreateCloudBackupAction.Builder clearDatabaseId()

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
CreateCloudBackupAction.Builder

This builder for chaining.

clearEncryptionConfig()

public CreateCloudBackupAction.Builder clearEncryptionConfig()

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
CreateCloudBackupAction.Builder

clearExpireTime()

public CreateCloudBackupAction.Builder clearExpireTime()

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
CreateCloudBackupAction.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearInstanceId()

public CreateCloudBackupAction.Builder clearInstanceId()

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

string instance_id = 2;

Returns
Type Description
CreateCloudBackupAction.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearProjectId()

public CreateCloudBackupAction.Builder clearProjectId()

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

string project_id = 1;

Returns
Type Description
CreateCloudBackupAction.Builder

This builder for chaining.

clearVersionTime()

public CreateCloudBackupAction.Builder clearVersionTime()

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
CreateCloudBackupAction.Builder

clone()

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

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

getDescriptorForType()

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

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.

getEncryptionConfigBuilder()

public EncryptionConfig.Builder getEncryptionConfigBuilder()

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

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.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

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
Builder

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.

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.

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.

getVersionTimeBuilder()

public Timestamp.Builder getVersionTimeBuilder()

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
Builder

getVersionTimeOrBuilder()

public TimestampOrBuilder getVersionTimeOrBuilder()

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
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()

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
boolean

Whether the versionTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEncryptionConfig(EncryptionConfig value)

public CreateCloudBackupAction.Builder mergeEncryptionConfig(EncryptionConfig value)

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;

Parameter
Name Description
value EncryptionConfig
Returns
Type Description
CreateCloudBackupAction.Builder

mergeExpireTime(Timestamp value)

public CreateCloudBackupAction.Builder mergeExpireTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
CreateCloudBackupAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(CreateCloudBackupAction other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeVersionTime(Timestamp value)

public CreateCloudBackupAction.Builder mergeVersionTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
CreateCloudBackupAction.Builder

setBackupId(String value)

public CreateCloudBackupAction.Builder setBackupId(String value)

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

string backup_id = 3;

Parameter
Name Description
value String

The backupId to set.

Returns
Type Description
CreateCloudBackupAction.Builder

This builder for chaining.

setBackupIdBytes(ByteString value)

public CreateCloudBackupAction.Builder setBackupIdBytes(ByteString value)

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

string backup_id = 3;

Parameter
Name Description
value ByteString

The bytes for backupId to set.

Returns
Type Description
CreateCloudBackupAction.Builder

This builder for chaining.

setDatabaseId(String value)

public CreateCloudBackupAction.Builder setDatabaseId(String value)

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;

Parameter
Name Description
value String

The databaseId to set.

Returns
Type Description
CreateCloudBackupAction.Builder

This builder for chaining.

setDatabaseIdBytes(ByteString value)

public CreateCloudBackupAction.Builder setDatabaseIdBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for databaseId to set.

Returns
Type Description
CreateCloudBackupAction.Builder

This builder for chaining.

setEncryptionConfig(EncryptionConfig value)

public CreateCloudBackupAction.Builder setEncryptionConfig(EncryptionConfig value)

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;

Parameter
Name Description
value EncryptionConfig
Returns
Type Description
CreateCloudBackupAction.Builder

setEncryptionConfig(EncryptionConfig.Builder builderForValue)

public CreateCloudBackupAction.Builder setEncryptionConfig(EncryptionConfig.Builder builderForValue)

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;

Parameter
Name Description
builderForValue EncryptionConfig.Builder
Returns
Type Description
CreateCloudBackupAction.Builder

setExpireTime(Timestamp value)

public CreateCloudBackupAction.Builder setExpireTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
CreateCloudBackupAction.Builder

setExpireTime(Timestamp.Builder builderForValue)

public CreateCloudBackupAction.Builder setExpireTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CreateCloudBackupAction.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setInstanceId(String value)

public CreateCloudBackupAction.Builder setInstanceId(String value)

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

string instance_id = 2;

Parameter
Name Description
value String

The instanceId to set.

Returns
Type Description
CreateCloudBackupAction.Builder

This builder for chaining.

setInstanceIdBytes(ByteString value)

public CreateCloudBackupAction.Builder setInstanceIdBytes(ByteString value)

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

string instance_id = 2;

Parameter
Name Description
value ByteString

The bytes for instanceId to set.

Returns
Type Description
CreateCloudBackupAction.Builder

This builder for chaining.

setProjectId(String value)

public CreateCloudBackupAction.Builder setProjectId(String value)

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

string project_id = 1;

Parameter
Name Description
value String

The projectId to set.

Returns
Type Description
CreateCloudBackupAction.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public CreateCloudBackupAction.Builder setProjectIdBytes(ByteString value)

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

string project_id = 1;

Parameter
Name Description
value ByteString

The bytes for projectId to set.

Returns
Type Description
CreateCloudBackupAction.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setVersionTime(Timestamp value)

public CreateCloudBackupAction.Builder setVersionTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
CreateCloudBackupAction.Builder

setVersionTime(Timestamp.Builder builderForValue)

public CreateCloudBackupAction.Builder setVersionTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CreateCloudBackupAction.Builder