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
public static final int BACKUP_INFO_FIELD_NUMBER
Field Value
public static final int CANCEL_TIME_FIELD_NUMBER
Field Value
public static final int NAME_FIELD_NUMBER
Field Value
public static final int OPTIMIZE_DATABASE_OPERATION_NAME_FIELD_NUMBER
Field Value
public static final int PROGRESS_FIELD_NUMBER
Field Value
public static final int SOURCE_TYPE_FIELD_NUMBER
Field Value
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public BackupInfo getBackupInfo()
Information about the backup used to restore the database.
.google.spanner.admin.database.v1.BackupInfo backup_info = 3;
public BackupInfoOrBuilder getBackupInfoOrBuilder()
Information about the backup used to restore the database.
.google.spanner.admin.database.v1.BackupInfo backup_info = 3;
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;
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;
public static RestoreDatabaseMetadata getDefaultInstance()
Returns
public RestoreDatabaseMetadata getDefaultInstanceForType()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
Name of the database being created and restored to.
string name = 1 [(.google.api.resource_reference) = { ... }
| Type | Description |
| String | The name.
|
public ByteString getNameBytes()
Name of the database being created and restored to.
string name = 1 [(.google.api.resource_reference) = { ... }
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;
| Type | Description |
| String | The optimizeDatabaseOperationName.
|
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;
| Type | Description |
| ByteString | The bytes for optimizeDatabaseOperationName.
|
public Parser<RestoreDatabaseMetadata> getParserForType()
Returns
Overrides
public OperationProgress getProgress()
The progress of the
RestoreDatabase
operation.
.google.spanner.admin.database.v1.OperationProgress progress = 4;
public OperationProgressOrBuilder getProgressOrBuilder()
The progress of the
RestoreDatabase
operation.
.google.spanner.admin.database.v1.OperationProgress progress = 4;
public int getSerializedSize()
Returns
Overrides
public RestoreDatabaseMetadata.SourceInfoCase getSourceInfoCase()
Returns
public RestoreSourceType getSourceType()
The type of the restore source.
.google.spanner.admin.database.v1.RestoreSourceType source_type = 2;
public int getSourceTypeValue()
The type of the restore source.
.google.spanner.admin.database.v1.RestoreSourceType source_type = 2;
| Type | Description |
| int | The enum numeric value on the wire for sourceType.
|
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasBackupInfo()
Information about the backup used to restore the database.
.google.spanner.admin.database.v1.BackupInfo backup_info = 3;
| Type | Description |
| boolean | Whether the backupInfo field is set.
|
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;
| Type | Description |
| boolean | Whether the cancelTime field is set.
|
public boolean hasProgress()
The progress of the
RestoreDatabase
operation.
.google.spanner.admin.database.v1.OperationProgress progress = 4;
| Type | Description |
| boolean | Whether the progress field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public static RestoreDatabaseMetadata.Builder newBuilder()
Returns
public static RestoreDatabaseMetadata.Builder newBuilder(RestoreDatabaseMetadata prototype)
Parameter
Returns
public RestoreDatabaseMetadata.Builder newBuilderForType()
Returns
protected RestoreDatabaseMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static RestoreDatabaseMetadata parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RestoreDatabaseMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RestoreDatabaseMetadata parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static RestoreDatabaseMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RestoreDatabaseMetadata parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static RestoreDatabaseMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RestoreDatabaseMetadata parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RestoreDatabaseMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RestoreDatabaseMetadata parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RestoreDatabaseMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RestoreDatabaseMetadata parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static RestoreDatabaseMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<RestoreDatabaseMetadata> parser()
Returns
public RestoreDatabaseMetadata.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
