Class RestoreDatabaseMetadata

public final class RestoreDatabaseMetadata extends GeneratedMessageV3 implements RestoreDatabaseMetadataOrBuilder

Metadata type for the long-running operation returned by RestoreDatabase.

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

Fields

BACKUP_INFO_FIELD_NUMBER

public static final int BACKUP_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

CANCEL_TIME_FIELD_NUMBER

public static final int CANCEL_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OPTIMIZE_DATABASE_OPERATION_NAME_FIELD_NUMBER

public static final int OPTIMIZE_DATABASE_OPERATION_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PROGRESS_FIELD_NUMBER

public static final int PROGRESS_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_TYPE_FIELD_NUMBER

public static final int SOURCE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBackupInfo()

public BackupInfo getBackupInfo()

Information about the backup used to restore the database.

.google.spanner.admin.database.v1.BackupInfo backup_info = 3;

Returns
TypeDescription
BackupInfo

The backupInfo.

getBackupInfoOrBuilder()

public BackupInfoOrBuilder getBackupInfoOrBuilder()

Information about the backup used to restore the database.

.google.spanner.admin.database.v1.BackupInfo backup_info = 3;

Returns
TypeDescription
BackupInfoOrBuilder

getCancelTime()

public Timestamp getCancelTime()

The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

.google.protobuf.Timestamp cancel_time = 5;

Returns
TypeDescription
Timestamp

The cancelTime.

getCancelTimeOrBuilder()

public TimestampOrBuilder getCancelTimeOrBuilder()

The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

.google.protobuf.Timestamp cancel_time = 5;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstance()

public static RestoreDatabaseMetadata getDefaultInstance()
Returns
TypeDescription
RestoreDatabaseMetadata

getDefaultInstanceForType()

public RestoreDatabaseMetadata getDefaultInstanceForType()
Returns
TypeDescription
RestoreDatabaseMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getName()

public String getName()

Name of the database being created and restored to.

string name = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the database being created and restored to.

string name = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for name.

getOptimizeDatabaseOperationName()

public String getOptimizeDatabaseOperationName()

If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove the dependency on the restore source. The name is of the form projects/<project>/instances/<instance>/databases/<database>/operations/<operation> where the <database> is the name of database being created and restored to. The metadata type of the long-running operation is OptimizeRestoredDatabaseMetadata. This long-running operation will be automatically created by the system after the RestoreDatabase long-running operation completes successfully. This operation will not be created if the restore was not successful.

string optimize_database_operation_name = 6;

Returns
TypeDescription
String

The optimizeDatabaseOperationName.

getOptimizeDatabaseOperationNameBytes()

public ByteString getOptimizeDatabaseOperationNameBytes()

If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove the dependency on the restore source. The name is of the form projects/<project>/instances/<instance>/databases/<database>/operations/<operation> where the <database> is the name of database being created and restored to. The metadata type of the long-running operation is OptimizeRestoredDatabaseMetadata. This long-running operation will be automatically created by the system after the RestoreDatabase long-running operation completes successfully. This operation will not be created if the restore was not successful.

string optimize_database_operation_name = 6;

Returns
TypeDescription
ByteString

The bytes for optimizeDatabaseOperationName.

getParserForType()

public Parser<RestoreDatabaseMetadata> getParserForType()
Returns
TypeDescription
Parser<RestoreDatabaseMetadata>
Overrides

getProgress()

public OperationProgress getProgress()

The progress of the RestoreDatabase operation.

.google.spanner.admin.database.v1.OperationProgress progress = 4;

Returns
TypeDescription
OperationProgress

The progress.

getProgressOrBuilder()

public OperationProgressOrBuilder getProgressOrBuilder()

The progress of the RestoreDatabase operation.

.google.spanner.admin.database.v1.OperationProgress progress = 4;

Returns
TypeDescription
OperationProgressOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceInfoCase()

public RestoreDatabaseMetadata.SourceInfoCase getSourceInfoCase()
Returns
TypeDescription
RestoreDatabaseMetadata.SourceInfoCase

getSourceType()

public RestoreSourceType getSourceType()

The type of the restore source.

.google.spanner.admin.database.v1.RestoreSourceType source_type = 2;

Returns
TypeDescription
RestoreSourceType

The sourceType.

getSourceTypeValue()

public int getSourceTypeValue()

The type of the restore source.

.google.spanner.admin.database.v1.RestoreSourceType source_type = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for sourceType.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasBackupInfo()

public boolean hasBackupInfo()

Information about the backup used to restore the database.

.google.spanner.admin.database.v1.BackupInfo backup_info = 3;

Returns
TypeDescription
boolean

Whether the backupInfo field is set.

hasCancelTime()

public boolean hasCancelTime()

The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

.google.protobuf.Timestamp cancel_time = 5;

Returns
TypeDescription
boolean

Whether the cancelTime field is set.

hasProgress()

public boolean hasProgress()

The progress of the RestoreDatabase operation.

.google.spanner.admin.database.v1.OperationProgress progress = 4;

Returns
TypeDescription
boolean

Whether the progress field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static RestoreDatabaseMetadata.Builder newBuilder()
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

newBuilder(RestoreDatabaseMetadata prototype)

public static RestoreDatabaseMetadata.Builder newBuilder(RestoreDatabaseMetadata prototype)
Parameter
NameDescription
prototypeRestoreDatabaseMetadata
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

newBuilderForType()

public RestoreDatabaseMetadata.Builder newBuilderForType()
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RestoreDatabaseMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static RestoreDatabaseMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RestoreDatabaseMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RestoreDatabaseMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RestoreDatabaseMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RestoreDatabaseMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RestoreDatabaseMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RestoreDatabaseMetadata> parser()
Returns
TypeDescription
Parser<RestoreDatabaseMetadata>

toBuilder()

public RestoreDatabaseMetadata.Builder toBuilder()
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException