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

Class RestoreDatabaseMetadata.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RestoreDatabaseMetadataOrBuilder, Cloneable
    Enclosing class:
    RestoreDatabaseMetadata
    public static final class RestoreDatabaseMetadata.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RestoreDatabaseMetadata.Builder>
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

    • Method Detail

      • 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.Builder<RestoreDatabaseMetadata.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreDatabaseMetadata.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • clearField

        public RestoreDatabaseMetadata.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreDatabaseMetadata.Builder>

      • clearOneof

        public RestoreDatabaseMetadata.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreDatabaseMetadata.Builder>

      • setRepeatedField

        public RestoreDatabaseMetadata.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        int index,
                                                        Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreDatabaseMetadata.Builder>

      • addRepeatedField

        public RestoreDatabaseMetadata.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreDatabaseMetadata.Builder>

      • isInitialized

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

      • mergeFrom

        public RestoreDatabaseMetadata.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RestoreDatabaseMetadata.Builder>
        Throws:
        IOException

      • 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.

      • setName

        public RestoreDatabaseMetadata.Builder setName​(String value)
         Name of the database being created and restored to.
        string name = 1 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public RestoreDatabaseMetadata.Builder clearName()
         Name of the database being created and restored to.
        string name = 1 [(.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setNameBytes

        public RestoreDatabaseMetadata.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Name of the database being created and restored to.
        string name = 1 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • 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.

      • setSourceTypeValue

        public RestoreDatabaseMetadata.Builder setSourceTypeValue​(int value)
         The type of the restore source.
        .google.spanner.admin.database.v1.RestoreSourceType source_type = 2;
        Parameters:
        value - The enum numeric value on the wire for sourceType to set.
        Returns:
        This builder for chaining.

      • setSourceType

        public RestoreDatabaseMetadata.Builder setSourceType​(RestoreSourceType value)
         The type of the restore source.
        .google.spanner.admin.database.v1.RestoreSourceType source_type = 2;
        Parameters:
        value - The sourceType to set.
        Returns:
        This builder for chaining.

      • clearSourceType

        public RestoreDatabaseMetadata.Builder clearSourceType()
         The type of the restore source.
        .google.spanner.admin.database.v1.RestoreSourceType source_type = 2;
        Returns:
        This builder for chaining.

      • 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.

      • setBackupInfo

        public RestoreDatabaseMetadata.Builder setBackupInfo​(BackupInfo value)
         Information about the backup used to restore the database.
        .google.spanner.admin.database.v1.BackupInfo backup_info = 3;

      • mergeBackupInfo

        public RestoreDatabaseMetadata.Builder mergeBackupInfo​(BackupInfo value)
         Information about the backup used to restore the database.
        .google.spanner.admin.database.v1.BackupInfo backup_info = 3;

      • clearBackupInfo

        public RestoreDatabaseMetadata.Builder clearBackupInfo()
         Information about the backup used to restore the database.
        .google.spanner.admin.database.v1.BackupInfo backup_info = 3;

      • getBackupInfoBuilder

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

      • 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.

      • setProgress

        public RestoreDatabaseMetadata.Builder setProgress​(OperationProgress value)
         The progress of the
 [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase]
 operation.
        .google.spanner.admin.database.v1.OperationProgress progress = 4;

      • setProgress

        public RestoreDatabaseMetadata.Builder setProgress​(OperationProgress.Builder builderForValue)
         The progress of the
 [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase]
 operation.
        .google.spanner.admin.database.v1.OperationProgress progress = 4;

      • mergeProgress

        public RestoreDatabaseMetadata.Builder mergeProgress​(OperationProgress value)
         The progress of the
 [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase]
 operation.
        .google.spanner.admin.database.v1.OperationProgress progress = 4;

      • clearProgress

        public RestoreDatabaseMetadata.Builder clearProgress()
         The progress of the
 [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase]
 operation.
        .google.spanner.admin.database.v1.OperationProgress progress = 4;

      • getProgressBuilder

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

      • 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.

      • setCancelTime

        public RestoreDatabaseMetadata.Builder setCancelTime​(com.google.protobuf.Timestamp value)
         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;

      • setCancelTime

        public RestoreDatabaseMetadata.Builder setCancelTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         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;

      • mergeCancelTime

        public RestoreDatabaseMetadata.Builder mergeCancelTime​(com.google.protobuf.Timestamp value)
         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;

      • clearCancelTime

        public RestoreDatabaseMetadata.Builder clearCancelTime()
         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;

      • getCancelTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCancelTimeBuilder()
         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;

      • 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.

      • setOptimizeDatabaseOperationName

        public RestoreDatabaseMetadata.Builder setOptimizeDatabaseOperationName​(String value)
         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;
        Parameters:
        value - The optimizeDatabaseOperationName to set.
        Returns:
        This builder for chaining.

      • clearOptimizeDatabaseOperationName

        public RestoreDatabaseMetadata.Builder clearOptimizeDatabaseOperationName()
         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:
        This builder for chaining.

      • setOptimizeDatabaseOperationNameBytes

        public RestoreDatabaseMetadata.Builder setOptimizeDatabaseOperationNameBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for optimizeDatabaseOperationName to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final RestoreDatabaseMetadata.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreDatabaseMetadata.Builder>

      • mergeUnknownFields

        public final RestoreDatabaseMetadata.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreDatabaseMetadata.Builder>