Class RestoreDatabaseMetadata (6.74.1)

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

Static Fields

BACKUP_INFO_FIELD_NUMBER

public static final int BACKUP_INFO_FIELD_NUMBER
Field Value
Type Description
int

CANCEL_TIME_FIELD_NUMBER

public static final int CANCEL_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPTIMIZE_DATABASE_OPERATION_NAME_FIELD_NUMBER

public static final int OPTIMIZE_DATABASE_OPERATION_NAME_FIELD_NUMBER
Field Value
Type Description
int

PROGRESS_FIELD_NUMBER

public static final int PROGRESS_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_TYPE_FIELD_NUMBER

public static final int SOURCE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RestoreDatabaseMetadata getDefaultInstance()
Returns
Type Description
RestoreDatabaseMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RestoreDatabaseMetadata.Builder newBuilder()
Returns
Type Description
RestoreDatabaseMetadata.Builder

newBuilder(RestoreDatabaseMetadata prototype)

public static RestoreDatabaseMetadata.Builder newBuilder(RestoreDatabaseMetadata prototype)
Parameter
Name Description
prototype RestoreDatabaseMetadata
Returns
Type Description
RestoreDatabaseMetadata.Builder

parseDelimitedFrom(InputStream input)

public static RestoreDatabaseMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RestoreDatabaseMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RestoreDatabaseMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RestoreDatabaseMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RestoreDatabaseMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RestoreDatabaseMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RestoreDatabaseMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RestoreDatabaseMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RestoreDatabaseMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RestoreDatabaseMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RestoreDatabaseMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RestoreDatabaseMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RestoreDatabaseMetadata> parser()
Returns
Type Description
Parser<RestoreDatabaseMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public RestoreDatabaseMetadata getDefaultInstanceForType()
Returns
Type Description
RestoreDatabaseMetadata

getName()

public String getName()

Name of the database being created and restored to.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the database being created and restored to.

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

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for optimizeDatabaseOperationName.

getParserForType()

public Parser<RestoreDatabaseMetadata> getParserForType()
Returns
Type Description
Parser<RestoreDatabaseMetadata>
Overrides

getProgress()

public OperationProgress getProgress()

The progress of the RestoreDatabase operation.

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

Returns
Type Description
OperationProgress

The progress.

getProgressOrBuilder()

public OperationProgressOrBuilder getProgressOrBuilder()

The progress of the RestoreDatabase operation.

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

Returns
Type Description
OperationProgressOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceInfoCase()

public RestoreDatabaseMetadata.SourceInfoCase getSourceInfoCase()
Returns
Type Description
RestoreDatabaseMetadata.SourceInfoCase

getSourceType()

public RestoreSourceType getSourceType()

The type of the restore source.

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

Returns
Type Description
RestoreSourceType

The sourceType.

getSourceTypeValue()

public int getSourceTypeValue()

The type of the restore source.

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

Returns
Type Description
int

The enum numeric value on the wire for sourceType.

hasBackupInfo()

public boolean hasBackupInfo()

Information about the backup used to restore the database.

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

Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the progress field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RestoreDatabaseMetadata.Builder newBuilderForType()
Returns
Type Description
RestoreDatabaseMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RestoreDatabaseMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RestoreDatabaseMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RestoreDatabaseMetadata.Builder toBuilder()
Returns
Type Description
RestoreDatabaseMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException