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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreateBackupMetadata.BuilderImplements
CreateBackupMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CreateBackupMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
build()
public CreateBackupMetadata build()
Returns | |
---|---|
Type | Description |
CreateBackupMetadata |
buildPartial()
public CreateBackupMetadata buildPartial()
Returns | |
---|---|
Type | Description |
CreateBackupMetadata |
clear()
public CreateBackupMetadata.Builder clear()
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CreateBackupMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
clearName()
public CreateBackupMetadata.Builder clearName()
The name of the backup being created.
string name = 1 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CreateBackupMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
clearProgress()
public CreateBackupMetadata.Builder clearProgress()
The progress of the CreateBackup operation.
.google.spanner.admin.database.v1.OperationProgress progress = 3;
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
clone()
public CreateBackupMetadata.Builder clone()
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
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 | |
---|---|
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 = 4;
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 = 4;
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDatabase()
public String getDatabase()
The name of the database the backup is created from.
string database = 2 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ByteString |
The bytes for database. |
getDefaultInstanceForType()
public CreateBackupMetadata getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
CreateBackupMetadata |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getName()
public String getName()
The name of the backup being created.
string name = 1 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
The name of the backup being created.
string name = 1 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getProgress()
public OperationProgress getProgress()
The progress of the CreateBackup operation.
.google.spanner.admin.database.v1.OperationProgress progress = 3;
Returns | |
---|---|
Type | Description |
OperationProgress |
The progress. |
getProgressBuilder()
public OperationProgress.Builder getProgressBuilder()
The progress of the CreateBackup operation.
.google.spanner.admin.database.v1.OperationProgress progress = 3;
Returns | |
---|---|
Type | Description |
OperationProgress.Builder |
getProgressOrBuilder()
public OperationProgressOrBuilder getProgressOrBuilder()
The progress of the CreateBackup operation.
.google.spanner.admin.database.v1.OperationProgress progress = 3;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
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 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 | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CreateBackupMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public CreateBackupMetadata.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
mergeFrom(CreateBackupMetadata other)
public CreateBackupMetadata.Builder mergeFrom(CreateBackupMetadata other)
Parameter | |
---|---|
Name | Description |
other |
CreateBackupMetadata |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
OperationProgress |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CreateBackupMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
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 | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The database to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for database to set. |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CreateBackupMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
setName(String value)
public CreateBackupMetadata.Builder setName(String value)
The name of the backup being created.
string name = 1 [(.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
OperationProgress |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
builderForValue |
OperationProgress.Builder |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CreateBackupMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final CreateBackupMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
CreateBackupMetadata.Builder |