Package com.google.spanner.admin.database.v1

Interface RestoreDatabaseMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RestoreDatabaseMetadata, RestoreDatabaseMetadata.Builder
public interface RestoreDatabaseMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    BackupInfo
    getBackupInfo()
    Information about the backup used to restore the database.
    BackupInfoOrBuilder
    getBackupInfoOrBuilder()
    Information about the backup used to restore the database.
    com.google.protobuf.Timestamp
    getCancelTime()
    The time at which cancellation of this operation was received.
    com.google.protobuf.TimestampOrBuilder
    getCancelTimeOrBuilder()
    The time at which cancellation of this operation was received.
    String
    getName()
    Name of the database being created and restored to.
    com.google.protobuf.ByteString
    getNameBytes()
    Name of the database being created and restored to.
    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.
    com.google.protobuf.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.
    OperationProgress
    getProgress()
    The progress of the [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase] operation.
    OperationProgressOrBuilder
    getProgressOrBuilder()
    The progress of the [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase] operation.
    RestoreDatabaseMetadata.SourceInfoCase
    getSourceInfoCase()
     
    RestoreSourceType
    getSourceType()
    The type of the restore source.
    int
    getSourceTypeValue()
    The type of the restore source.
    boolean
    hasBackupInfo()
    Information about the backup used to restore the database.
    boolean
    hasCancelTime()
    The time at which cancellation of this operation was received.
    boolean
    hasProgress()
    The progress of the [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase] operation.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getName

      String getName()
       Name of the database being created and restored to.
      string name = 1 [(.google.api.resource_reference) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Name of the database being created and restored to.
      string name = 1 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for name.

    • getSourceTypeValue

      int getSourceTypeValue()
       The type of the restore source.
      .google.spanner.admin.database.v1.RestoreSourceType source_type = 2;
      Returns:
      The enum numeric value on the wire for sourceType.

    • getSourceType

      RestoreSourceType getSourceType()
       The type of the restore source.
      .google.spanner.admin.database.v1.RestoreSourceType source_type = 2;
      Returns:
      The sourceType.

    • hasBackupInfo

      boolean hasBackupInfo()
       Information about the backup used to restore the database.
      .google.spanner.admin.database.v1.BackupInfo backup_info = 3;
      Returns:
      Whether the backupInfo field is set.

    • getBackupInfo

      BackupInfo getBackupInfo()
       Information about the backup used to restore the database.
      .google.spanner.admin.database.v1.BackupInfo backup_info = 3;
      Returns:
      The backupInfo.

    • getBackupInfoOrBuilder

      BackupInfoOrBuilder getBackupInfoOrBuilder()
       Information about the backup used to restore the database.
      .google.spanner.admin.database.v1.BackupInfo backup_info = 3;

    • hasProgress

      boolean hasProgress()
       The progress of the
 [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase]
 operation.
      .google.spanner.admin.database.v1.OperationProgress progress = 4;
      Returns:
      Whether the progress field is set.

    • getProgress

      OperationProgress getProgress()
       The progress of the
 [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase]
 operation.
      .google.spanner.admin.database.v1.OperationProgress progress = 4;
      Returns:
      The progress.

    • getProgressOrBuilder

      OperationProgressOrBuilder getProgressOrBuilder()
       The progress of the
 [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase]
 operation.
      .google.spanner.admin.database.v1.OperationProgress progress = 4;

    • hasCancelTime

      boolean hasCancelTime()
       The time at which cancellation of this operation was received.
 [Operations.CancelOperation][google.longrunning.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][google.longrunning.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][google.longrunning.Operation.error] value with a
 [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
      .google.protobuf.Timestamp cancel_time = 5;
      Returns:
      Whether the cancelTime field is set.

    • getCancelTime

      com.google.protobuf.Timestamp getCancelTime()
       The time at which cancellation of this operation was received.
 [Operations.CancelOperation][google.longrunning.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][google.longrunning.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][google.longrunning.Operation.error] value with a
 [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
      .google.protobuf.Timestamp cancel_time = 5;
      Returns:
      The cancelTime.

    • getCancelTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCancelTimeOrBuilder()
       The time at which cancellation of this operation was received.
 [Operations.CancelOperation][google.longrunning.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][google.longrunning.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][google.longrunning.Operation.error] value with a
 [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
      .google.protobuf.Timestamp cancel_time = 5;

    • getOptimizeDatabaseOperationName

      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][google.spanner.admin.database.v1.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:
      The optimizeDatabaseOperationName.

    • getOptimizeDatabaseOperationNameBytes

      com.google.protobuf.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][google.spanner.admin.database.v1.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:
      The bytes for optimizeDatabaseOperationName.

    • getSourceInfoCase

      RestoreDatabaseMetadata.SourceInfoCase getSourceInfoCase()