Interface RestoreDatabaseMetadataOrBuilder (6.25.0)

public interface RestoreDatabaseMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBackupInfo()

public abstract 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 abstract 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 abstract 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 abstract 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

getName()

public abstract 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 abstract 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 abstract 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 abstract 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.

getProgress()

public abstract OperationProgress getProgress()

The progress of the RestoreDatabase operation.

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

Returns
TypeDescription
OperationProgress

The progress.

getProgressOrBuilder()

public abstract OperationProgressOrBuilder getProgressOrBuilder()

The progress of the RestoreDatabase operation.

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

Returns
TypeDescription
OperationProgressOrBuilder

getSourceInfoCase()

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

getSourceType()

public abstract RestoreSourceType getSourceType()

The type of the restore source.

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

Returns
TypeDescription
RestoreSourceType

The sourceType.

getSourceTypeValue()

public abstract 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.

hasBackupInfo()

public abstract 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 abstract 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 abstract 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.