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

Class RestoreDatabaseMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.admin.database.v1.RestoreDatabaseMetadata
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RestoreDatabaseMetadataOrBuilder, Serializable
public final class RestoreDatabaseMetadata extends com.google.protobuf.GeneratedMessageV3 implements RestoreDatabaseMetadataOrBuilder
 Metadata type for the long-running operation returned by
 [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].
Protobuf type google.spanner.admin.database.v1.RestoreDatabaseMetadata
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • SOURCE_TYPE_FIELD_NUMBER

      public static final int SOURCE_TYPE_FIELD_NUMBER
      See Also:

    • BACKUP_INFO_FIELD_NUMBER

      public static final int BACKUP_INFO_FIELD_NUMBER
      See Also:

    • PROGRESS_FIELD_NUMBER

      public static final int PROGRESS_FIELD_NUMBER
      See Also:

    • CANCEL_TIME_FIELD_NUMBER

      public static final int CANCEL_TIME_FIELD_NUMBER
      See Also:

    • OPTIMIZE_DATABASE_OPERATION_NAME_FIELD_NUMBER

      public static final int OPTIMIZE_DATABASE_OPERATION_NAME_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getSourceInfoCase

      public RestoreDatabaseMetadata.SourceInfoCase getSourceInfoCase()
      Specified by:
      getSourceInfoCase in interface RestoreDatabaseMetadataOrBuilder

    • getName

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

    • getNameBytes

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

    • getSourceTypeValue

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

    • getSourceType

      public RestoreSourceType getSourceType()
       The type of the restore source.
      .google.spanner.admin.database.v1.RestoreSourceType source_type = 2;
      Specified by:
      getSourceType in interface RestoreDatabaseMetadataOrBuilder
      Returns:
      The sourceType.

    • hasBackupInfo

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

    • getBackupInfo

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

    • getBackupInfoOrBuilder

      public BackupInfoOrBuilder getBackupInfoOrBuilder()
       Information about the backup used to restore the database.
      .google.spanner.admin.database.v1.BackupInfo backup_info = 3;
      Specified by:
      getBackupInfoOrBuilder in interface RestoreDatabaseMetadataOrBuilder

    • hasProgress

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

    • getProgress

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

    • getProgressOrBuilder

      public OperationProgressOrBuilder getProgressOrBuilder()
       The progress of the
 [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase]
 operation.
      .google.spanner.admin.database.v1.OperationProgress progress = 4;
      Specified by:
      getProgressOrBuilder in interface RestoreDatabaseMetadataOrBuilder

    • hasCancelTime

      public 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;
      Specified by:
      hasCancelTime in interface RestoreDatabaseMetadataOrBuilder
      Returns:
      Whether the cancelTime field is set.

    • getCancelTime

      public 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;
      Specified by:
      getCancelTime in interface RestoreDatabaseMetadataOrBuilder
      Returns:
      The cancelTime.

    • getCancelTimeOrBuilder

      public 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;
      Specified by:
      getCancelTimeOrBuilder in interface RestoreDatabaseMetadataOrBuilder

    • 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][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;
      Specified by:
      getOptimizeDatabaseOperationName in interface RestoreDatabaseMetadataOrBuilder
      Returns:
      The optimizeDatabaseOperationName.

    • getOptimizeDatabaseOperationNameBytes

      public 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;
      Specified by:
      getOptimizeDatabaseOperationNameBytes in interface RestoreDatabaseMetadataOrBuilder
      Returns:
      The bytes for optimizeDatabaseOperationName.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RestoreDatabaseMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RestoreDatabaseMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RestoreDatabaseMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RestoreDatabaseMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RestoreDatabaseMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RestoreDatabaseMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RestoreDatabaseMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RestoreDatabaseMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RestoreDatabaseMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RestoreDatabaseMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RestoreDatabaseMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RestoreDatabaseMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RestoreDatabaseMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RestoreDatabaseMetadata.Builder newBuilder()

    • newBuilder

      public static RestoreDatabaseMetadata.Builder newBuilder(RestoreDatabaseMetadata prototype)

    • toBuilder

      public RestoreDatabaseMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RestoreDatabaseMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static RestoreDatabaseMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RestoreDatabaseMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<RestoreDatabaseMetadata> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public RestoreDatabaseMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder