public static final class CopyBackupRequest.Builder extends GeneratedMessageV3.Builder<CopyBackupRequest.Builder> implements CopyBackupRequestOrBuilderThe request for CopyBackup.
Protobuf type google.spanner.admin.database.v1.CopyBackupRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CopyBackupRequest.BuilderImplements
CopyBackupRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CopyBackupRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
build()
public CopyBackupRequest build()| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest |
|
buildPartial()
public CopyBackupRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest |
|
clear()
public CopyBackupRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
clearBackupId()
public CopyBackupRequest.Builder clearBackupId() Required. The id of the backup copy.
The backup_id appended to parent forms the full backup_uri of the form
projects/<project>/instances/<instance>/backups/<backup>.
string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
This builder for chaining. |
clearEncryptionConfig()
public CopyBackupRequest.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 source backup by default, namely
encryption_type =
USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.
.google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
clearExpireTime()
public CopyBackupRequest.Builder clearExpireTime() Required. The expiration time of the backup in microsecond granularity.
The expiration time must be at least 6 hours and at most 366 days
from the create_time of the source backup. Once the expire_time has
passed, the backup is eligible to be automatically deleted by Cloud Spanner
to free the resources used by the backup.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public CopyBackupRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public CopyBackupRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
clearParent()
public CopyBackupRequest.Builder clearParent() Required. The name of the destination instance that will contain the backup copy.
Values are of the form: projects/<project>/instances/<instance>.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
This builder for chaining. |
clearSourceBackup()
public CopyBackupRequest.Builder clearSourceBackup() Required. The source backup to be copied.
The source backup needs to be in READY state for it to be copied.
Once CopyBackup is in progress, the source backup cannot be deleted or
cleaned up on expiration until CopyBackup is finished.
Values are of the form:
projects/<project>/instances/<instance>/backups/<backup>.
string source_backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
This builder for chaining. |
clone()
public CopyBackupRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
getBackupId()
public String getBackupId() Required. The id of the backup copy.
The backup_id appended to parent forms the full backup_uri of the form
projects/<project>/instances/<instance>/backups/<backup>.
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 copy.
The backup_id appended to parent forms the full backup_uri of the form
projects/<project>/instances/<instance>/backups/<backup>.
string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for backupId. |
getDefaultInstanceForType()
public CopyBackupRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEncryptionConfig()
public CopyBackupEncryptionConfig 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 source backup by default, namely
encryption_type =
USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.
.google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CopyBackupEncryptionConfig |
The encryptionConfig. |
getEncryptionConfigBuilder()
public CopyBackupEncryptionConfig.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 source backup by default, namely
encryption_type =
USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.
.google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CopyBackupEncryptionConfig.Builder |
|
getEncryptionConfigOrBuilder()
public CopyBackupEncryptionConfigOrBuilder 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 source backup by default, namely
encryption_type =
USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.
.google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CopyBackupEncryptionConfigOrBuilder |
|
getExpireTime()
public Timestamp getExpireTime() Required. The expiration time of the backup in microsecond granularity.
The expiration time must be at least 6 hours and at most 366 days
from the create_time of the source backup. Once the expire_time has
passed, the backup is eligible to be automatically deleted by Cloud Spanner
to free the resources used by the backup.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The expireTime. |
getExpireTimeBuilder()
public Timestamp.Builder getExpireTimeBuilder() Required. The expiration time of the backup in microsecond granularity.
The expiration time must be at least 6 hours and at most 366 days
from the create_time of the source backup. Once the expire_time has
passed, the backup is eligible to be automatically deleted by Cloud Spanner
to free the resources used by the backup.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getExpireTimeOrBuilder()
public TimestampOrBuilder getExpireTimeOrBuilder() Required. The expiration time of the backup in microsecond granularity.
The expiration time must be at least 6 hours and at most 366 days
from the create_time of the source backup. Once the expire_time has
passed, the backup is eligible to be automatically deleted by Cloud Spanner
to free the resources used by the backup.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getParent()
public String getParent() Required. The name of the destination instance that will contain the backup copy.
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 destination instance that will contain the backup copy.
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. |
getSourceBackup()
public String getSourceBackup() Required. The source backup to be copied.
The source backup needs to be in READY state for it to be copied.
Once CopyBackup is in progress, the source backup cannot be deleted or
cleaned up on expiration until CopyBackup is finished.
Values are of the form:
projects/<project>/instances/<instance>/backups/<backup>.
string source_backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The sourceBackup. |
getSourceBackupBytes()
public ByteString getSourceBackupBytes() Required. The source backup to be copied.
The source backup needs to be in READY state for it to be copied.
Once CopyBackup is in progress, the source backup cannot be deleted or
cleaned up on expiration until CopyBackup is finished.
Values are of the form:
projects/<project>/instances/<instance>/backups/<backup>.
string source_backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for sourceBackup. |
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 source backup by default, namely
encryption_type =
USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.
.google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the encryptionConfig field is set. |
hasExpireTime()
public boolean hasExpireTime() Required. The expiration time of the backup in microsecond granularity.
The expiration time must be at least 6 hours and at most 366 days
from the create_time of the source backup. Once the expire_time has
passed, the backup is eligible to be automatically deleted by Cloud Spanner
to free the resources used by the backup.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the expireTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeEncryptionConfig(CopyBackupEncryptionConfig value)
public CopyBackupRequest.Builder mergeEncryptionConfig(CopyBackupEncryptionConfig 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 source backup by default, namely
encryption_type =
USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.
.google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CopyBackupEncryptionConfig |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
mergeExpireTime(Timestamp value)
public CopyBackupRequest.Builder mergeExpireTime(Timestamp value) Required. The expiration time of the backup in microsecond granularity.
The expiration time must be at least 6 hours and at most 366 days
from the create_time of the source backup. Once the expire_time has
passed, the backup is eligible to be automatically deleted by Cloud Spanner
to free the resources used by the backup.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CopyBackupRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CopyBackupRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
mergeFrom(CopyBackupRequest other)
public CopyBackupRequest.Builder mergeFrom(CopyBackupRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
CopyBackupRequest |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CopyBackupRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
setBackupId(String value)
public CopyBackupRequest.Builder setBackupId(String value) Required. The id of the backup copy.
The backup_id appended to parent forms the full backup_uri of the form
projects/<project>/instances/<instance>/backups/<backup>.
string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe backupId to set. |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
This builder for chaining. |
setBackupIdBytes(ByteString value)
public CopyBackupRequest.Builder setBackupIdBytes(ByteString value) Required. The id of the backup copy.
The backup_id appended to parent forms the full backup_uri of the form
projects/<project>/instances/<instance>/backups/<backup>.
string backup_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for backupId to set. |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
This builder for chaining. |
setEncryptionConfig(CopyBackupEncryptionConfig value)
public CopyBackupRequest.Builder setEncryptionConfig(CopyBackupEncryptionConfig 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 source backup by default, namely
encryption_type =
USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.
.google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
CopyBackupEncryptionConfig |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
setEncryptionConfig(CopyBackupEncryptionConfig.Builder builderForValue)
public CopyBackupRequest.Builder setEncryptionConfig(CopyBackupEncryptionConfig.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 source backup by default, namely
encryption_type =
USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.
.google.spanner.admin.database.v1.CopyBackupEncryptionConfig encryption_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CopyBackupEncryptionConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
setExpireTime(Timestamp value)
public CopyBackupRequest.Builder setExpireTime(Timestamp value) Required. The expiration time of the backup in microsecond granularity.
The expiration time must be at least 6 hours and at most 366 days
from the create_time of the source backup. Once the expire_time has
passed, the backup is eligible to be automatically deleted by Cloud Spanner
to free the resources used by the backup.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
setExpireTime(Timestamp.Builder builderForValue)
public CopyBackupRequest.Builder setExpireTime(Timestamp.Builder builderForValue) Required. The expiration time of the backup in microsecond granularity.
The expiration time must be at least 6 hours and at most 366 days
from the create_time of the source backup. Once the expire_time has
passed, the backup is eligible to be automatically deleted by Cloud Spanner
to free the resources used by the backup.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public CopyBackupRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
setParent(String value)
public CopyBackupRequest.Builder setParent(String value) Required. The name of the destination instance that will contain the backup copy.
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 |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public CopyBackupRequest.Builder setParentBytes(ByteString value) Required. The name of the destination instance that will contain the backup copy.
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 |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CopyBackupRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|
setSourceBackup(String value)
public CopyBackupRequest.Builder setSourceBackup(String value) Required. The source backup to be copied.
The source backup needs to be in READY state for it to be copied.
Once CopyBackup is in progress, the source backup cannot be deleted or
cleaned up on expiration until CopyBackup is finished.
Values are of the form:
projects/<project>/instances/<instance>/backups/<backup>.
string source_backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe sourceBackup to set. |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
This builder for chaining. |
setSourceBackupBytes(ByteString value)
public CopyBackupRequest.Builder setSourceBackupBytes(ByteString value) Required. The source backup to be copied.
The source backup needs to be in READY state for it to be copied.
Once CopyBackup is in progress, the source backup cannot be deleted or
cleaned up on expiration until CopyBackup is finished.
Values are of the form:
projects/<project>/instances/<instance>/backups/<backup>.
string source_backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for sourceBackup to set. |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CopyBackupRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CopyBackupRequest.Builder |
|