Class RestoreDatabaseMetadata.Builder (6.74.1)

public static final class RestoreDatabaseMetadata.Builder extends GeneratedMessageV3.Builder<RestoreDatabaseMetadata.Builder> implements RestoreDatabaseMetadataOrBuilder

Metadata type for the long-running operation returned by RestoreDatabase.

Protobuf type google.spanner.admin.database.v1.RestoreDatabaseMetadata

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RestoreDatabaseMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RestoreDatabaseMetadata.Builder
Overrides

build()

public RestoreDatabaseMetadata build()
Returns
Type Description
RestoreDatabaseMetadata

buildPartial()

public RestoreDatabaseMetadata buildPartial()
Returns
Type Description
RestoreDatabaseMetadata

clear()

public RestoreDatabaseMetadata.Builder clear()
Returns
Type Description
RestoreDatabaseMetadata.Builder
Overrides

clearBackupInfo()

public RestoreDatabaseMetadata.Builder clearBackupInfo()

Information about the backup used to restore the database.

.google.spanner.admin.database.v1.BackupInfo backup_info = 3;

Returns
Type Description
RestoreDatabaseMetadata.Builder

clearCancelTime()

public RestoreDatabaseMetadata.Builder clearCancelTime()

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
Type Description
RestoreDatabaseMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

public RestoreDatabaseMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RestoreDatabaseMetadata.Builder
Overrides

clearName()

public RestoreDatabaseMetadata.Builder clearName()

Name of the database being created and restored to.

string name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
RestoreDatabaseMetadata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RestoreDatabaseMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RestoreDatabaseMetadata.Builder
Overrides

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. 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
Type Description
RestoreDatabaseMetadata.Builder

This builder for chaining.

clearProgress()

public RestoreDatabaseMetadata.Builder clearProgress()

The progress of the RestoreDatabase operation.

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

Returns
Type Description
RestoreDatabaseMetadata.Builder

clearSourceInfo()

public RestoreDatabaseMetadata.Builder clearSourceInfo()
Returns
Type Description
RestoreDatabaseMetadata.Builder

clearSourceType()

public RestoreDatabaseMetadata.Builder clearSourceType()

The type of the restore source.

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

Returns
Type Description
RestoreDatabaseMetadata.Builder

This builder for chaining.

clone()

public RestoreDatabaseMetadata.Builder clone()
Returns
Type Description
RestoreDatabaseMetadata.Builder
Overrides

getBackupInfo()

public BackupInfo getBackupInfo()

Information about the backup used to restore the database.

.google.spanner.admin.database.v1.BackupInfo backup_info = 3;

Returns
Type Description
BackupInfo

The backupInfo.

getBackupInfoBuilder()

public BackupInfo.Builder getBackupInfoBuilder()

Information about the backup used to restore the database.

.google.spanner.admin.database.v1.BackupInfo backup_info = 3;

Returns
Type Description
BackupInfo.Builder

getBackupInfoOrBuilder()

public BackupInfoOrBuilder getBackupInfoOrBuilder()

Information about the backup used to restore the database.

.google.spanner.admin.database.v1.BackupInfo backup_info = 3;

Returns
Type Description
BackupInfoOrBuilder

getCancelTime()

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;

Returns
Type Description
Timestamp

The cancelTime.

getCancelTimeBuilder()

public Timestamp.Builder getCancelTimeBuilder()

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
Type Description
Builder

getCancelTimeOrBuilder()

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;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public RestoreDatabaseMetadata getDefaultInstanceForType()
Returns
Type Description
RestoreDatabaseMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

public String getName()

Name of the database being created and restored to.

string name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the database being created and restored to.

string name = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

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. 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
Type Description
String

The optimizeDatabaseOperationName.

getOptimizeDatabaseOperationNameBytes()

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;

Returns
Type Description
ByteString

The bytes for optimizeDatabaseOperationName.

getProgress()

public OperationProgress getProgress()

The progress of the RestoreDatabase operation.

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

Returns
Type Description
OperationProgress

The progress.

getProgressBuilder()

public OperationProgress.Builder getProgressBuilder()

The progress of the RestoreDatabase operation.

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

Returns
Type Description
OperationProgress.Builder

getProgressOrBuilder()

public OperationProgressOrBuilder getProgressOrBuilder()

The progress of the RestoreDatabase operation.

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

Returns
Type Description
OperationProgressOrBuilder

getSourceInfoCase()

public RestoreDatabaseMetadata.SourceInfoCase getSourceInfoCase()
Returns
Type Description
RestoreDatabaseMetadata.SourceInfoCase

getSourceType()

public RestoreSourceType getSourceType()

The type of the restore source.

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

Returns
Type Description
RestoreSourceType

The sourceType.

getSourceTypeValue()

public int getSourceTypeValue()

The type of the restore source.

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

Returns
Type Description
int

The enum numeric value on the wire for sourceType.

hasBackupInfo()

public boolean hasBackupInfo()

Information about the backup used to restore the database.

.google.spanner.admin.database.v1.BackupInfo backup_info = 3;

Returns
Type Description
boolean

Whether the backupInfo field is set.

hasCancelTime()

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;

Returns
Type Description
boolean

Whether the cancelTime field is set.

hasProgress()

public boolean hasProgress()

The progress of the RestoreDatabase operation.

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

Returns
Type Description
boolean

Whether the progress field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBackupInfo(BackupInfo value)

public RestoreDatabaseMetadata.Builder mergeBackupInfo(BackupInfo value)

Information about the backup used to restore the database.

.google.spanner.admin.database.v1.BackupInfo backup_info = 3;

Parameter
Name Description
value BackupInfo
Returns
Type Description
RestoreDatabaseMetadata.Builder

mergeCancelTime(Timestamp value)

public RestoreDatabaseMetadata.Builder mergeCancelTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
RestoreDatabaseMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RestoreDatabaseMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreDatabaseMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RestoreDatabaseMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RestoreDatabaseMetadata.Builder
Overrides

mergeFrom(RestoreDatabaseMetadata other)

public RestoreDatabaseMetadata.Builder mergeFrom(RestoreDatabaseMetadata other)
Parameter
Name Description
other RestoreDatabaseMetadata
Returns
Type Description
RestoreDatabaseMetadata.Builder

mergeProgress(OperationProgress value)

public RestoreDatabaseMetadata.Builder mergeProgress(OperationProgress value)

The progress of the RestoreDatabase operation.

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

Parameter
Name Description
value OperationProgress
Returns
Type Description
RestoreDatabaseMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RestoreDatabaseMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RestoreDatabaseMetadata.Builder
Overrides

setBackupInfo(BackupInfo value)

public RestoreDatabaseMetadata.Builder setBackupInfo(BackupInfo value)

Information about the backup used to restore the database.

.google.spanner.admin.database.v1.BackupInfo backup_info = 3;

Parameter
Name Description
value BackupInfo
Returns
Type Description
RestoreDatabaseMetadata.Builder

setBackupInfo(BackupInfo.Builder builderForValue)

public RestoreDatabaseMetadata.Builder setBackupInfo(BackupInfo.Builder builderForValue)

Information about the backup used to restore the database.

.google.spanner.admin.database.v1.BackupInfo backup_info = 3;

Parameter
Name Description
builderForValue BackupInfo.Builder
Returns
Type Description
RestoreDatabaseMetadata.Builder

setCancelTime(Timestamp value)

public RestoreDatabaseMetadata.Builder setCancelTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
RestoreDatabaseMetadata.Builder

setCancelTime(Timestamp.Builder builderForValue)

public RestoreDatabaseMetadata.Builder setCancelTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RestoreDatabaseMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RestoreDatabaseMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RestoreDatabaseMetadata.Builder
Overrides

setName(String value)

public RestoreDatabaseMetadata.Builder setName(String value)

Name of the database being created and restored to.

string name = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
RestoreDatabaseMetadata.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RestoreDatabaseMetadata.Builder setNameBytes(ByteString value)

Name of the database being created and restored to.

string name = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
RestoreDatabaseMetadata.Builder

This builder for chaining.

setOptimizeDatabaseOperationName(String value)

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

Parameter
Name Description
value String

The optimizeDatabaseOperationName to set.

Returns
Type Description
RestoreDatabaseMetadata.Builder

This builder for chaining.

setOptimizeDatabaseOperationNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for optimizeDatabaseOperationName to set.

Returns
Type Description
RestoreDatabaseMetadata.Builder

This builder for chaining.

setProgress(OperationProgress value)

public RestoreDatabaseMetadata.Builder setProgress(OperationProgress value)

The progress of the RestoreDatabase operation.

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

Parameter
Name Description
value OperationProgress
Returns
Type Description
RestoreDatabaseMetadata.Builder

setProgress(OperationProgress.Builder builderForValue)

public RestoreDatabaseMetadata.Builder setProgress(OperationProgress.Builder builderForValue)

The progress of the RestoreDatabase operation.

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

Parameter
Name Description
builderForValue OperationProgress.Builder
Returns
Type Description
RestoreDatabaseMetadata.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RestoreDatabaseMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RestoreDatabaseMetadata.Builder
Overrides

setSourceType(RestoreSourceType value)

public RestoreDatabaseMetadata.Builder setSourceType(RestoreSourceType value)

The type of the restore source.

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

Parameter
Name Description
value RestoreSourceType

The sourceType to set.

Returns
Type Description
RestoreDatabaseMetadata.Builder

This builder for chaining.

setSourceTypeValue(int value)

public RestoreDatabaseMetadata.Builder setSourceTypeValue(int value)

The type of the restore source.

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

Parameter
Name Description
value int

The enum numeric value on the wire for sourceType to set.

Returns
Type Description
RestoreDatabaseMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RestoreDatabaseMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RestoreDatabaseMetadata.Builder
Overrides