Class CreateBackupMetadata.Builder (6.62.0)

public static final class CreateBackupMetadata.Builder extends GeneratedMessageV3.Builder<CreateBackupMetadata.Builder> implements CreateBackupMetadataOrBuilder

Metadata type for the operation returned by CreateBackup.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateBackupMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CreateBackupMetadata.Builder
Overrides

build()

public CreateBackupMetadata build()
Returns
TypeDescription
CreateBackupMetadata

buildPartial()

public CreateBackupMetadata buildPartial()
Returns
TypeDescription
CreateBackupMetadata

clear()

public CreateBackupMetadata.Builder clear()
Returns
TypeDescription
CreateBackupMetadata.Builder
Overrides

clearCancelTime()

public CreateBackupMetadata.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 = 4;

Returns
TypeDescription
CreateBackupMetadata.Builder

clearDatabase()

public CreateBackupMetadata.Builder clearDatabase()

The name of the database the backup is created from.

string database = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
CreateBackupMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateBackupMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CreateBackupMetadata.Builder
Overrides

clearName()

public CreateBackupMetadata.Builder clearName()

The name of the backup being created.

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

Returns
TypeDescription
CreateBackupMetadata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateBackupMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CreateBackupMetadata.Builder
Overrides

clearProgress()

public CreateBackupMetadata.Builder clearProgress()

The progress of the CreateBackup operation.

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

Returns
TypeDescription
CreateBackupMetadata.Builder

clone()

public CreateBackupMetadata.Builder clone()
Returns
TypeDescription
CreateBackupMetadata.Builder
Overrides

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 = 4;

Returns
TypeDescription
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 = 4;

Returns
TypeDescription
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 = 4;

Returns
TypeDescription
TimestampOrBuilder

getDatabase()

public String getDatabase()

The name of the database the backup is created from.

string database = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

The name of the database the backup is created from.

string database = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for database.

getDefaultInstanceForType()

public CreateBackupMetadata getDefaultInstanceForType()
Returns
TypeDescription
CreateBackupMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getName()

public String getName()

The name of the backup being created.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the backup being created.

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

Returns
TypeDescription
ByteString

The bytes for name.

getProgress()

public OperationProgress getProgress()

The progress of the CreateBackup operation.

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

Returns
TypeDescription
OperationProgress

The progress.

getProgressBuilder()

public OperationProgress.Builder getProgressBuilder()

The progress of the CreateBackup operation.

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

Returns
TypeDescription
OperationProgress.Builder

getProgressOrBuilder()

public OperationProgressOrBuilder getProgressOrBuilder()

The progress of the CreateBackup operation.

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

Returns
TypeDescription
OperationProgressOrBuilder

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 = 4;

Returns
TypeDescription
boolean

Whether the cancelTime field is set.

hasProgress()

public boolean hasProgress()

The progress of the CreateBackup operation.

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

Returns
TypeDescription
boolean

Whether the progress field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCancelTime(Timestamp value)

public CreateBackupMetadata.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 = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
CreateBackupMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateBackupMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateBackupMetadata.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CreateBackupMetadata.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CreateBackupMetadata.Builder
Overrides

mergeFrom(CreateBackupMetadata other)

public CreateBackupMetadata.Builder mergeFrom(CreateBackupMetadata other)
Parameter
NameDescription
otherCreateBackupMetadata
Returns
TypeDescription
CreateBackupMetadata.Builder

mergeProgress(OperationProgress value)

public CreateBackupMetadata.Builder mergeProgress(OperationProgress value)

The progress of the CreateBackup operation.

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

Parameter
NameDescription
valueOperationProgress
Returns
TypeDescription
CreateBackupMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateBackupMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateBackupMetadata.Builder
Overrides

setCancelTime(Timestamp value)

public CreateBackupMetadata.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 = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
CreateBackupMetadata.Builder

setCancelTime(Timestamp.Builder builderForValue)

public CreateBackupMetadata.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 = 4;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
CreateBackupMetadata.Builder

setDatabase(String value)

public CreateBackupMetadata.Builder setDatabase(String value)

The name of the database the backup is created from.

string database = 2 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The database to set.

Returns
TypeDescription
CreateBackupMetadata.Builder

This builder for chaining.

setDatabaseBytes(ByteString value)

public CreateBackupMetadata.Builder setDatabaseBytes(ByteString value)

The name of the database the backup is created from.

string database = 2 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for database to set.

Returns
TypeDescription
CreateBackupMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateBackupMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CreateBackupMetadata.Builder
Overrides

setName(String value)

public CreateBackupMetadata.Builder setName(String value)

The name of the backup being created.

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
CreateBackupMetadata.Builder

This builder for chaining.

setNameBytes(ByteString value)

public CreateBackupMetadata.Builder setNameBytes(ByteString value)

The name of the backup being created.

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
CreateBackupMetadata.Builder

This builder for chaining.

setProgress(OperationProgress value)

public CreateBackupMetadata.Builder setProgress(OperationProgress value)

The progress of the CreateBackup operation.

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

Parameter
NameDescription
valueOperationProgress
Returns
TypeDescription
CreateBackupMetadata.Builder

setProgress(OperationProgress.Builder builderForValue)

public CreateBackupMetadata.Builder setProgress(OperationProgress.Builder builderForValue)

The progress of the CreateBackup operation.

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

Parameter
NameDescription
builderForValueOperationProgress.Builder
Returns
TypeDescription
CreateBackupMetadata.Builder

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

public CreateBackupMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CreateBackupMetadata.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateBackupMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CreateBackupMetadata.Builder
Overrides