public static final class CopyBackupMetadata.Builder extends GeneratedMessageV3.Builder<CopyBackupMetadata.Builder> implements CopyBackupMetadataOrBuilder
Metadata type for the operation returned by CopyBackup.
Protobuf type google.spanner.admin.database.v1.CopyBackupMetadata
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CopyBackupMetadata.BuilderImplements
CopyBackupMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CopyBackupMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
build()
public CopyBackupMetadata build()
Returns | |
---|---|
Type | Description |
CopyBackupMetadata |
buildPartial()
public CopyBackupMetadata buildPartial()
Returns | |
---|---|
Type | Description |
CopyBackupMetadata |
clear()
public CopyBackupMetadata.Builder clear()
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
clearCancelTime()
public CopyBackupMetadata.Builder clearCancelTime()
The time at which cancellation of CopyBackup 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 | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
clearField(Descriptors.FieldDescriptor field)
public CopyBackupMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
clearName()
public CopyBackupMetadata.Builder clearName()
The name of the backup being created through the copy operation.
Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.
string name = 1 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CopyBackupMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
clearProgress()
public CopyBackupMetadata.Builder clearProgress()
The progress of the CopyBackup operation.
.google.spanner.admin.database.v1.OperationProgress progress = 3;
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
clearSourceBackup()
public CopyBackupMetadata.Builder clearSourceBackup()
The name of the source backup that is being copied.
Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.
string source_backup = 2 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
This builder for chaining. |
clone()
public CopyBackupMetadata.Builder clone()
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
getCancelTime()
public Timestamp getCancelTime()
The time at which cancellation of CopyBackup 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 | |
---|---|
Type | Description |
Timestamp |
The cancelTime. |
getCancelTimeBuilder()
public Timestamp.Builder getCancelTimeBuilder()
The time at which cancellation of CopyBackup 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 | |
---|---|
Type | Description |
Builder |
getCancelTimeOrBuilder()
public TimestampOrBuilder getCancelTimeOrBuilder()
The time at which cancellation of CopyBackup 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 | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public CopyBackupMetadata getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
CopyBackupMetadata |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getName()
public String getName()
The name of the backup being created through the copy operation.
Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.
string name = 1 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
The name of the backup being created through the copy operation.
Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.
string name = 1 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getProgress()
public OperationProgress getProgress()
The progress of the CopyBackup operation.
.google.spanner.admin.database.v1.OperationProgress progress = 3;
Returns | |
---|---|
Type | Description |
OperationProgress |
The progress. |
getProgressBuilder()
public OperationProgress.Builder getProgressBuilder()
The progress of the CopyBackup operation.
.google.spanner.admin.database.v1.OperationProgress progress = 3;
Returns | |
---|---|
Type | Description |
OperationProgress.Builder |
getProgressOrBuilder()
public OperationProgressOrBuilder getProgressOrBuilder()
The progress of the CopyBackup operation.
.google.spanner.admin.database.v1.OperationProgress progress = 3;
Returns | |
---|---|
Type | Description |
OperationProgressOrBuilder |
getSourceBackup()
public String getSourceBackup()
The name of the source backup that is being copied.
Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.
string source_backup = 2 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The sourceBackup. |
getSourceBackupBytes()
public ByteString getSourceBackupBytes()
The name of the source backup that is being copied.
Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.
string source_backup = 2 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for sourceBackup. |
hasCancelTime()
public boolean hasCancelTime()
The time at which cancellation of CopyBackup 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 | |
---|---|
Type | Description |
boolean |
Whether the cancelTime field is set. |
hasProgress()
public boolean hasProgress()
The progress of the CopyBackup operation.
.google.spanner.admin.database.v1.OperationProgress progress = 3;
Returns | |
---|---|
Type | Description |
boolean |
Whether the progress field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCancelTime(Timestamp value)
public CopyBackupMetadata.Builder mergeCancelTime(Timestamp value)
The time at which cancellation of CopyBackup 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 | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CopyBackupMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public CopyBackupMetadata.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
mergeFrom(CopyBackupMetadata other)
public CopyBackupMetadata.Builder mergeFrom(CopyBackupMetadata other)
Parameter | |
---|---|
Name | Description |
other |
CopyBackupMetadata |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
mergeProgress(OperationProgress value)
public CopyBackupMetadata.Builder mergeProgress(OperationProgress value)
The progress of the CopyBackup operation.
.google.spanner.admin.database.v1.OperationProgress progress = 3;
Parameter | |
---|---|
Name | Description |
value |
OperationProgress |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CopyBackupMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
setCancelTime(Timestamp value)
public CopyBackupMetadata.Builder setCancelTime(Timestamp value)
The time at which cancellation of CopyBackup 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 | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
setCancelTime(Timestamp.Builder builderForValue)
public CopyBackupMetadata.Builder setCancelTime(Timestamp.Builder builderForValue)
The time at which cancellation of CopyBackup 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 | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public CopyBackupMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
setName(String value)
public CopyBackupMetadata.Builder setName(String value)
The name of the backup being created through the copy operation.
Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.
string name = 1 [(.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public CopyBackupMetadata.Builder setNameBytes(ByteString value)
The name of the backup being created through the copy operation.
Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.
string name = 1 [(.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
This builder for chaining. |
setProgress(OperationProgress value)
public CopyBackupMetadata.Builder setProgress(OperationProgress value)
The progress of the CopyBackup operation.
.google.spanner.admin.database.v1.OperationProgress progress = 3;
Parameter | |
---|---|
Name | Description |
value |
OperationProgress |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
setProgress(OperationProgress.Builder builderForValue)
public CopyBackupMetadata.Builder setProgress(OperationProgress.Builder builderForValue)
The progress of the CopyBackup operation.
.google.spanner.admin.database.v1.OperationProgress progress = 3;
Parameter | |
---|---|
Name | Description |
builderForValue |
OperationProgress.Builder |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CopyBackupMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
setSourceBackup(String value)
public CopyBackupMetadata.Builder setSourceBackup(String value)
The name of the source backup that is being copied.
Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.
string source_backup = 2 [(.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The sourceBackup to set. |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
This builder for chaining. |
setSourceBackupBytes(ByteString value)
public CopyBackupMetadata.Builder setSourceBackupBytes(ByteString value)
The name of the source backup that is being copied.
Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.
string source_backup = 2 [(.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for sourceBackup to set. |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CopyBackupMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
CopyBackupMetadata.Builder |