public final class CopyBackupRequest extends GeneratedMessageV3 implements CopyBackupRequestOrBuilder
The request for CopyBackup.
Protobuf type google.spanner.admin.database.v1.CopyBackupRequest
Static Fields
BACKUP_ID_FIELD_NUMBER
public static final int BACKUP_ID_FIELD_NUMBER
Field Value
ENCRYPTION_CONFIG_FIELD_NUMBER
public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
EXPIRE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
SOURCE_BACKUP_FIELD_NUMBER
public static final int SOURCE_BACKUP_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static CopyBackupRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static CopyBackupRequest.Builder newBuilder()
Returns
newBuilder(CopyBackupRequest prototype)
public static CopyBackupRequest.Builder newBuilder(CopyBackupRequest prototype)
Parameter
Returns
public static CopyBackupRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static CopyBackupRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static CopyBackupRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CopyBackupRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static CopyBackupRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CopyBackupRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CopyBackupRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static CopyBackupRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CopyBackupRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static CopyBackupRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static CopyBackupRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CopyBackupRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<CopyBackupRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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
getDefaultInstanceForType()
public CopyBackupRequest getDefaultInstanceForType()
Returns
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
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
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
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
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
getParserForType()
public Parser<CopyBackupRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public CopyBackupRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CopyBackupRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public CopyBackupRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions