public final class Backup extends GeneratedMessageV3 implements BackupOrBuilder
A backup of a Cloud Spanner database.
Protobuf type google.spanner.admin.database.v1.Backup
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
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DATABASE_DIALECT_FIELD_NUMBER
public static final int DATABASE_DIALECT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DATABASE_FIELD_NUMBER
public static final int DATABASE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENCRYPTION_INFO_FIELD_NUMBER
public static final int ENCRYPTION_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPIRE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_EXPIRE_TIME_FIELD_NUMBER
public static final int MAX_EXPIRE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REFERENCING_BACKUPS_FIELD_NUMBER
public static final int REFERENCING_BACKUPS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REFERENCING_DATABASES_FIELD_NUMBER
public static final int REFERENCING_DATABASES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SIZE_BYTES_FIELD_NUMBER
public static final int SIZE_BYTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_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 Backup getDefaultInstance()
| Returns |
| Type |
Description |
Backup |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Backup.Builder newBuilder()
newBuilder(Backup prototype)
public static Backup.Builder newBuilder(Backup prototype)
| Parameter |
| Name |
Description |
prototype |
Backup
|
public static Backup parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(byte[] data)
public static Backup parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Backup |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Backup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(ByteString data)
public static Backup parseFrom(ByteString data)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Backup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseFrom(InputStream input)
| Returns |
| Type |
Description |
Backup |
|
public static Backup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(ByteBuffer data)
public static Backup parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Backup |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Backup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Backup |
|
parser()
public static Parser<Backup> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. The time the CreateBackup
request is received. If the request does not specify version_time, the
version_time of the backup will be equivalent to the create_time.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time the CreateBackup
request is received. If the request does not specify version_time, the
version_time of the backup will be equivalent to the create_time.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDatabase()
public String getDatabase()
Required for the CreateBackup operation.
Name of the database from which this backup was
created. This needs to be in the same instance as the backup.
Values are of the form
projects/<project>/instances/<instance>/databases/<database>.
string database = 2 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The database.
|
getDatabaseBytes()
public ByteString getDatabaseBytes()
Required for the CreateBackup operation.
Name of the database from which this backup was
created. This needs to be in the same instance as the backup.
Values are of the form
projects/<project>/instances/<instance>/databases/<database>.
string database = 2 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for database.
|
getDatabaseDialect()
public DatabaseDialect getDatabaseDialect()
Output only. The database dialect information for the backup.
.google.spanner.admin.database.v1.DatabaseDialect database_dialect = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDatabaseDialectValue()
public int getDatabaseDialectValue()
Output only. The database dialect information for the backup.
.google.spanner.admin.database.v1.DatabaseDialect database_dialect = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for databaseDialect.
|
getDefaultInstanceForType()
public Backup getDefaultInstanceForType()
| Returns |
| Type |
Description |
Backup |
|
getEncryptionInfo()
public EncryptionInfo getEncryptionInfo()
Output only. The encryption information for the backup.
.google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getEncryptionInfoOrBuilder()
public EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()
Output only. The encryption information for the backup.
.google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getExpireTime()
public Timestamp getExpireTime()
Required for the CreateBackup
operation. The expiration time of the backup, with microseconds
granularity that must be at least 6 hours and at most 366 days
from the time the CreateBackup request is processed. 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 = 3;
| Returns |
| Type |
Description |
Timestamp |
The expireTime.
|
getExpireTimeOrBuilder()
public TimestampOrBuilder getExpireTimeOrBuilder()
Required for the CreateBackup
operation. The expiration time of the backup, with microseconds
granularity that must be at least 6 hours and at most 366 days
from the time the CreateBackup request is processed. 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 = 3;
getMaxExpireTime()
public Timestamp getMaxExpireTime()
Output only. The max allowed expiration time of the backup, with
microseconds granularity. A backup's expiration time can be configured in
multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or
copying an existing backup, the expiration time specified must be
less than Backup.max_expire_time.
.google.protobuf.Timestamp max_expire_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The maxExpireTime.
|
getMaxExpireTimeOrBuilder()
public TimestampOrBuilder getMaxExpireTimeOrBuilder()
Output only. The max allowed expiration time of the backup, with
microseconds granularity. A backup's expiration time can be configured in
multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or
copying an existing backup, the expiration time specified must be
less than Backup.max_expire_time.
.google.protobuf.Timestamp max_expire_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getName()
Output only for the CreateBackup operation.
Required for the UpdateBackup operation.
A globally unique identifier for the backup which cannot be
changed. Values are of the form
projects/<project>/instances/<instance>/backups/a-z*[a-z0-9]
The final segment of the name must be between 2 and 60 characters
in length.
The backup is stored in the location(s) specified in the instance
configuration of the instance containing the backup, identified
by the prefix of the backup name of the form
projects/<project>/instances/<instance>.
string name = 1;
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only for the CreateBackup operation.
Required for the UpdateBackup operation.
A globally unique identifier for the backup which cannot be
changed. Values are of the form
projects/<project>/instances/<instance>/backups/a-z*[a-z0-9]
The final segment of the name must be between 2 and 60 characters
in length.
The backup is stored in the location(s) specified in the instance
configuration of the instance containing the backup, identified
by the prefix of the backup name of the form
projects/<project>/instances/<instance>.
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Backup> getParserForType()
Overrides
getReferencingBackups(int index)
public String getReferencingBackups(int index)
Output only. The names of the destination backups being created by copying
this source backup. The backup names are of the form
projects/<project>/instances/<instance>/backups/<backup>.
Referencing backups may exist in different instances. The existence of
any referencing backup prevents the backup from being deleted. When the
copy operation is done (either successfully completed or cancelled or the
destination backup is deleted), the reference to the backup is removed.
repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The referencingBackups at the given index.
|
getReferencingBackupsBytes(int index)
public ByteString getReferencingBackupsBytes(int index)
Output only. The names of the destination backups being created by copying
this source backup. The backup names are of the form
projects/<project>/instances/<instance>/backups/<backup>.
Referencing backups may exist in different instances. The existence of
any referencing backup prevents the backup from being deleted. When the
copy operation is done (either successfully completed or cancelled or the
destination backup is deleted), the reference to the backup is removed.
repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the referencingBackups at the given index.
|
getReferencingBackupsCount()
public int getReferencingBackupsCount()
Output only. The names of the destination backups being created by copying
this source backup. The backup names are of the form
projects/<project>/instances/<instance>/backups/<backup>.
Referencing backups may exist in different instances. The existence of
any referencing backup prevents the backup from being deleted. When the
copy operation is done (either successfully completed or cancelled or the
destination backup is deleted), the reference to the backup is removed.
repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
int |
The count of referencingBackups.
|
getReferencingBackupsList()
public ProtocolStringList getReferencingBackupsList()
Output only. The names of the destination backups being created by copying
this source backup. The backup names are of the form
projects/<project>/instances/<instance>/backups/<backup>.
Referencing backups may exist in different instances. The existence of
any referencing backup prevents the backup from being deleted. When the
copy operation is done (either successfully completed or cancelled or the
destination backup is deleted), the reference to the backup is removed.
repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
getReferencingDatabases(int index)
public String getReferencingDatabases(int index)
Output only. The names of the restored databases that reference the backup.
The database names are of
the form projects/<project>/instances/<instance>/databases/<database>.
Referencing databases may exist in different instances. The existence of
any referencing database prevents the backup from being deleted. When a
restored database from the backup enters the READY state, the reference
to the backup is removed.
repeated string referencing_databases = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The referencingDatabases at the given index.
|
getReferencingDatabasesBytes(int index)
public ByteString getReferencingDatabasesBytes(int index)
Output only. The names of the restored databases that reference the backup.
The database names are of
the form projects/<project>/instances/<instance>/databases/<database>.
Referencing databases may exist in different instances. The existence of
any referencing database prevents the backup from being deleted. When a
restored database from the backup enters the READY state, the reference
to the backup is removed.
repeated string referencing_databases = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the referencingDatabases at the given index.
|
getReferencingDatabasesCount()
public int getReferencingDatabasesCount()
Output only. The names of the restored databases that reference the backup.
The database names are of
the form projects/<project>/instances/<instance>/databases/<database>.
Referencing databases may exist in different instances. The existence of
any referencing database prevents the backup from being deleted. When a
restored database from the backup enters the READY state, the reference
to the backup is removed.
repeated string referencing_databases = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
int |
The count of referencingDatabases.
|
getReferencingDatabasesList()
public ProtocolStringList getReferencingDatabasesList()
Output only. The names of the restored databases that reference the backup.
The database names are of
the form projects/<project>/instances/<instance>/databases/<database>.
Referencing databases may exist in different instances. The existence of
any referencing database prevents the backup from being deleted. When a
restored database from the backup enters the READY state, the reference
to the backup is removed.
repeated string referencing_databases = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSizeBytes()
public long getSizeBytes()
Output only. Size of the backup in bytes.
int64 size_bytes = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
long |
The sizeBytes.
|
getState()
public Backup.State getState()
Output only. The current state of the backup.
.google.spanner.admin.database.v1.Backup.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. The current state of the backup.
.google.spanner.admin.database.v1.Backup.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
getVersionTime()
public Timestamp getVersionTime()
The backup will contain an externally consistent copy of the database at
the timestamp specified by version_time. If version_time is not
specified, the system will set version_time to the create_time of the
backup.
.google.protobuf.Timestamp version_time = 9;
| Returns |
| Type |
Description |
Timestamp |
The versionTime.
|
getVersionTimeOrBuilder()
public TimestampOrBuilder getVersionTimeOrBuilder()
The backup will contain an externally consistent copy of the database at
the timestamp specified by version_time. If version_time is not
specified, the system will set version_time to the create_time of the
backup.
.google.protobuf.Timestamp version_time = 9;
hasCreateTime()
public boolean hasCreateTime()
Output only. The time the CreateBackup
request is received. If the request does not specify version_time, the
version_time of the backup will be equivalent to the create_time.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasEncryptionInfo()
public boolean hasEncryptionInfo()
Output only. The encryption information for the backup.
.google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the encryptionInfo field is set.
|
hasExpireTime()
public boolean hasExpireTime()
Required for the CreateBackup
operation. The expiration time of the backup, with microseconds
granularity that must be at least 6 hours and at most 366 days
from the time the CreateBackup request is processed. 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 = 3;
| Returns |
| Type |
Description |
boolean |
Whether the expireTime field is set.
|
hasMaxExpireTime()
public boolean hasMaxExpireTime()
Output only. The max allowed expiration time of the backup, with
microseconds granularity. A backup's expiration time can be configured in
multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or
copying an existing backup, the expiration time specified must be
less than Backup.max_expire_time.
.google.protobuf.Timestamp max_expire_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the maxExpireTime field is set.
|
hasVersionTime()
public boolean hasVersionTime()
The backup will contain an externally consistent copy of the database at
the timestamp specified by version_time. If version_time is not
specified, the system will set version_time to the create_time of the
backup.
.google.protobuf.Timestamp version_time = 9;
| Returns |
| Type |
Description |
boolean |
Whether the versionTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Backup.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Backup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Backup.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
