com.google.spanner.admin.database.v1

Class Backup

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.spanner.admin.database.v1.Backup

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BackupOrBuilder, Serializable

public final class Backup
extends com.google.protobuf.GeneratedMessageV3
implements BackupOrBuilder

 A backup of a Cloud Spanner database.
 

Protobuf type google.spanner.admin.database.v1.Backup

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Backup.Builder A backup of a Cloud Spanner database.
static class	Backup.State Indicates the current state of the backup.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATE_TIME_FIELD_NUMBER
static int	DATABASE_FIELD_NUMBER
static int	EXPIRE_TIME_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	REFERENCING_DATABASES_FIELD_NUMBER
static int	SIZE_BYTES_FIELD_NUMBER
static int	STATE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDatabase() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
com.google.protobuf.ByteString	getDatabaseBytes() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
static Backup	getDefaultInstance()
Backup	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Timestamp	getExpireTime() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
com.google.protobuf.TimestampOrBuilder	getExpireTimeOrBuilder() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
String	getName() Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
com.google.protobuf.ByteString	getNameBytes() Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
com.google.protobuf.Parser<Backup>	getParserForType()
String	getReferencingDatabases(int index) Output only.
com.google.protobuf.ByteString	getReferencingDatabasesBytes(int index) Output only.
int	getReferencingDatabasesCount() Output only.
com.google.protobuf.ProtocolStringList	getReferencingDatabasesList() Output only.
int	getSerializedSize()
long	getSizeBytes() Output only.
Backup.State	getState() Output only.
int	getStateValue() Output only.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCreateTime() Output only.
boolean	hasExpireTime() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Backup.Builder	newBuilder()
static Backup.Builder	newBuilder(Backup prototype)
Backup.Builder	newBuilderForType()
protected Backup.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Backup	parseDelimitedFrom(InputStream input)
static Backup	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Backup	parseFrom(byte[] data)
static Backup	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Backup	parseFrom(ByteBuffer data)
static Backup	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Backup	parseFrom(com.google.protobuf.ByteString data)
static Backup	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Backup	parseFrom(com.google.protobuf.CodedInputStream input)
static Backup	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Backup	parseFrom(InputStream input)
static Backup	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Backup>	parser()
Backup.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER

See Also:

Constant Field Values

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

SIZE_BYTES_FIELD_NUMBER

public static final int SIZE_BYTES_FIELD_NUMBER

See Also:

Constant Field Values

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

REFERENCING_DATABASES_FIELD_NUMBER

public static final int REFERENCING_DATABASES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getDatabase

public String getDatabase()

 Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.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) = { ... }

Specified by:

getDatabase in interface BackupOrBuilder

Returns:

The database.

getDatabaseBytes

public com.google.protobuf.ByteString getDatabaseBytes()

 Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.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) = { ... }

Specified by:

getDatabaseBytes in interface BackupOrBuilder

Returns:

The bytes for database.

hasExpireTime

public boolean hasExpireTime()

 Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.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;

Specified by:

hasExpireTime in interface BackupOrBuilder

Returns:

Whether the expireTime field is set.

getExpireTime

public com.google.protobuf.Timestamp getExpireTime()

 Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.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;

Specified by:

getExpireTime in interface BackupOrBuilder

Returns:

The expireTime.

getExpireTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()

 Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.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;

Specified by:

getExpireTimeOrBuilder in interface BackupOrBuilder

getName

public String getName()

 Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
 Required for the [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.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_\-]*[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;

Specified by:

getName in interface BackupOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
 Required for the [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.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_\-]*[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;

Specified by:

getNameBytes in interface BackupOrBuilder

Returns:

The bytes for name.

hasCreateTime

public boolean hasCreateTime()

 Output only. The backup will contain an externally consistent
 copy of the database at the timestamp specified by
 `create_time`. `create_time` is approximately the time the
 [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasCreateTime in interface BackupOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 Output only. The backup will contain an externally consistent
 copy of the database at the timestamp specified by
 `create_time`. `create_time` is approximately the time the
 [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCreateTime in interface BackupOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. The backup will contain an externally consistent
 copy of the database at the timestamp specified by
 `create_time`. `create_time` is approximately the time the
 [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCreateTimeOrBuilder in interface BackupOrBuilder

getSizeBytes

public long getSizeBytes()

 Output only. Size of the backup in bytes.
 

int64 size_bytes = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getSizeBytes in interface BackupOrBuilder

Returns:

The sizeBytes.

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

Specified by:

getStateValue in interface BackupOrBuilder

Returns:

The enum numeric value on the wire for state.

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

Specified by:

getState in interface BackupOrBuilder

Returns:

The state.

getReferencingDatabasesList

public com.google.protobuf.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];

Specified by:

getReferencingDatabasesList in interface BackupOrBuilder

Returns:

A list containing the referencingDatabases.

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

Specified by:

getReferencingDatabasesCount in interface BackupOrBuilder

Returns:

The count of referencingDatabases.

getReferencingDatabases

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

Specified by:

getReferencingDatabases in interface BackupOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The referencingDatabases at the given index.

getReferencingDatabasesBytes

public com.google.protobuf.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];

Specified by:

getReferencingDatabasesBytes in interface BackupOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the referencingDatabases at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Backup parseFrom(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Backup parseFrom(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Backup parseFrom(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Backup parseFrom(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Backup parseFrom(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Backup parseFrom(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Backup parseFrom(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Backup parseFrom(InputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Backup parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Backup parseDelimitedFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static Backup parseFrom(com.google.protobuf.CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Backup parseFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

newBuilderForType

public Backup.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Backup.Builder newBuilder()

newBuilder

public static Backup.Builder newBuilder(Backup prototype)

toBuilder

public Backup.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Backup.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Backup getDefaultInstance()

parser

public static com.google.protobuf.Parser<Backup> parser()

getParserForType

public com.google.protobuf.Parser<Backup> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Backup getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder