public final class CopyBackupRequest extends GeneratedMessageV3 implements CopyBackupRequestOrBuilder
The request for
CopyBackup.
Protobuf type google.spanner.admin.database.v1.CopyBackupRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BACKUP_ID_FIELD_NUMBER
public static final int BACKUP_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 |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SOURCE_BACKUP_FIELD_NUMBER
public static final int SOURCE_BACKUP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CopyBackupRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CopyBackupRequest.Builder newBuilder()
newBuilder(CopyBackupRequest prototype)
public static CopyBackupRequest.Builder newBuilder(CopyBackupRequest prototype)
public static CopyBackupRequest parseDelimitedFrom(InputStream input)
public static CopyBackupRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CopyBackupRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CopyBackupRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CopyBackupRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CopyBackupRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CopyBackupRequest parseFrom(CodedInputStream input)
public static CopyBackupRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CopyBackupRequest parseFrom(InputStream input)
public static CopyBackupRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CopyBackupRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CopyBackupRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CopyBackupRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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 |
| Type |
Description |
ByteString |
The bytes for backupId.
|
getDefaultInstanceForType()
public CopyBackupRequest getDefaultInstanceForType()
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];
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];
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.
|
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];
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.
|
getParserForType()
public Parser<CopyBackupRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
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.
|
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 |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CopyBackupRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CopyBackupRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CopyBackupRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
