public static final class Operation.Builder extends GeneratedMessageV3.Builder<Operation.Builder> implements OperationOrBuilder
This resource represents a long-running operation that is the result of a network API call.Protobuf type
google.longrunning.Operation| Modifier and Type | Method and Description |
|---|---|
Operation.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
Operation |
build() |
Operation |
buildPartial() |
Operation.Builder |
clear() |
Operation.Builder |
clearDone()
If the value is `false`, it means the operation is still in progress.
|
Operation.Builder |
clearError()
The error result of the operation in case of failure or cancellation.
|
Operation.Builder |
clearField(Descriptors.FieldDescriptor field) |
Operation.Builder |
clearMetadata()
Service-specific metadata associated with the operation.
|
Operation.Builder |
clearName()
The server-assigned name, which is only unique within the same service that
originally returns it.
|
Operation.Builder |
clearOneof(Descriptors.OneofDescriptor oneof) |
Operation.Builder |
clearResponse()
The normal response of the operation in case of success.
|
Operation.Builder |
clearResult() |
Operation.Builder |
clone() |
Operation |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Descriptors.Descriptor |
getDescriptorForType() |
boolean |
getDone()
If the value is `false`, it means the operation is still in progress.
|
Status |
getError()
The error result of the operation in case of failure or cancellation.
|
Status.Builder |
getErrorBuilder()
The error result of the operation in case of failure or cancellation.
|
StatusOrBuilder |
getErrorOrBuilder()
The error result of the operation in case of failure or cancellation.
|
Any |
getMetadata()
Service-specific metadata associated with the operation.
|
Any.Builder |
getMetadataBuilder()
Service-specific metadata associated with the operation.
|
AnyOrBuilder |
getMetadataOrBuilder()
Service-specific metadata associated with the operation.
|
java.lang.String |
getName()
The server-assigned name, which is only unique within the same service that
originally returns it.
|
ByteString |
getNameBytes()
The server-assigned name, which is only unique within the same service that
originally returns it.
|
Any |
getResponse()
The normal response of the operation in case of success.
|
Any.Builder |
getResponseBuilder()
The normal response of the operation in case of success.
|
AnyOrBuilder |
getResponseOrBuilder()
The normal response of the operation in case of success.
|
Operation.ResultCase |
getResultCase() |
boolean |
hasError()
The error result of the operation in case of failure or cancellation.
|
boolean |
hasMetadata()
Service-specific metadata associated with the operation.
|
boolean |
hasResponse()
The normal response of the operation in case of success.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Operation.Builder |
mergeError(Status value)
The error result of the operation in case of failure or cancellation.
|
Operation.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
Operation.Builder |
mergeFrom(Message other) |
Operation.Builder |
mergeFrom(Operation other) |
Operation.Builder |
mergeMetadata(Any value)
Service-specific metadata associated with the operation.
|
Operation.Builder |
mergeResponse(Any value)
The normal response of the operation in case of success.
|
Operation.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields) |
Operation.Builder |
setDone(boolean value)
If the value is `false`, it means the operation is still in progress.
|
Operation.Builder |
setError(Status.Builder builderForValue)
The error result of the operation in case of failure or cancellation.
|
Operation.Builder |
setError(Status value)
The error result of the operation in case of failure or cancellation.
|
Operation.Builder |
setField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
Operation.Builder |
setMetadata(Any.Builder builderForValue)
Service-specific metadata associated with the operation.
|
Operation.Builder |
setMetadata(Any value)
Service-specific metadata associated with the operation.
|
Operation.Builder |
setName(java.lang.String value)
The server-assigned name, which is only unique within the same service that
originally returns it.
|
Operation.Builder |
setNameBytes(ByteString value)
The server-assigned name, which is only unique within the same service that
originally returns it.
|
Operation.Builder |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
Operation.Builder |
setResponse(Any.Builder builderForValue)
The normal response of the operation in case of success.
|
Operation.Builder |
setResponse(Any value)
The normal response of the operation in case of success.
|
Operation.Builder |
setUnknownFields(UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<Operation.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<Operation.Builder>public Operation getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic Operation build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic Operation buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic Operation.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<Operation.Builder>public Operation.Builder mergeFrom(Operation other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<Operation.Builder>java.io.IOExceptionpublic Operation.ResultCase getResultCase()
getResultCase in interface OperationOrBuilderpublic Operation.Builder clearResult()
public java.lang.String getName()
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
string name = 1;getName in interface OperationOrBuilderpublic ByteString getNameBytes()
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
string name = 1;getNameBytes in interface OperationOrBuilderpublic Operation.Builder setName(java.lang.String value)
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
string name = 1;public Operation.Builder clearName()
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
string name = 1;public Operation.Builder setNameBytes(ByteString value)
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`.
string name = 1;public boolean hasMetadata()
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
.google.protobuf.Any metadata = 2;hasMetadata in interface OperationOrBuilderpublic Any getMetadata()
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
.google.protobuf.Any metadata = 2;getMetadata in interface OperationOrBuilderpublic Operation.Builder setMetadata(Any value)
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
.google.protobuf.Any metadata = 2;public Operation.Builder setMetadata(Any.Builder builderForValue)
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
.google.protobuf.Any metadata = 2;public Operation.Builder mergeMetadata(Any value)
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
.google.protobuf.Any metadata = 2;public Operation.Builder clearMetadata()
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
.google.protobuf.Any metadata = 2;public Any.Builder getMetadataBuilder()
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
.google.protobuf.Any metadata = 2;public AnyOrBuilder getMetadataOrBuilder()
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
.google.protobuf.Any metadata = 2;getMetadataOrBuilder in interface OperationOrBuilderpublic boolean getDone()
If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
bool done = 3;getDone in interface OperationOrBuilderpublic Operation.Builder setDone(boolean value)
If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
bool done = 3;public Operation.Builder clearDone()
If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
bool done = 3;public boolean hasError()
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;hasError in interface OperationOrBuilderpublic Status getError()
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;getError in interface OperationOrBuilderpublic Operation.Builder setError(Status value)
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;public Operation.Builder setError(Status.Builder builderForValue)
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;public Operation.Builder mergeError(Status value)
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;public Operation.Builder clearError()
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;public Status.Builder getErrorBuilder()
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;public StatusOrBuilder getErrorOrBuilder()
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;getErrorOrBuilder in interface OperationOrBuilderpublic boolean hasResponse()
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
.google.protobuf.Any response = 5;hasResponse in interface OperationOrBuilderpublic Any getResponse()
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
.google.protobuf.Any response = 5;getResponse in interface OperationOrBuilderpublic Operation.Builder setResponse(Any value)
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
.google.protobuf.Any response = 5;public Operation.Builder setResponse(Any.Builder builderForValue)
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
.google.protobuf.Any response = 5;public Operation.Builder mergeResponse(Any value)
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
.google.protobuf.Any response = 5;public Operation.Builder clearResponse()
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
.google.protobuf.Any response = 5;public Any.Builder getResponseBuilder()
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
.google.protobuf.Any response = 5;public AnyOrBuilder getResponseOrBuilder()
The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
.google.protobuf.Any response = 5;getResponseOrBuilder in interface OperationOrBuilderpublic final Operation.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<Operation.Builder>public final Operation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<Operation.Builder>