public static final class Operation.Builder extends com.google.protobuf.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(com.google.protobuf.Descriptors.FieldDescriptor field,
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(com.google.protobuf.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(com.google.protobuf.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 com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.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.
|
com.google.protobuf.Any |
getMetadata()
Service-specific metadata associated with the operation.
|
com.google.protobuf.Any.Builder |
getMetadataBuilder()
Service-specific metadata associated with the operation.
|
com.google.protobuf.AnyOrBuilder |
getMetadataOrBuilder()
Service-specific metadata associated with the operation.
|
String |
getName()
The server-assigned name, which is only unique within the same service that
originally returns it.
|
com.google.protobuf.ByteString |
getNameBytes()
The server-assigned name, which is only unique within the same service that
originally returns it.
|
com.google.protobuf.Any |
getResponse()
The normal response of the operation in case of success.
|
com.google.protobuf.Any.Builder |
getResponseBuilder()
The normal response of the operation in case of success.
|
com.google.protobuf.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 com.google.protobuf.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(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Operation.Builder |
mergeFrom(com.google.protobuf.Message other) |
Operation.Builder |
mergeFrom(Operation other) |
Operation.Builder |
mergeMetadata(com.google.protobuf.Any value)
Service-specific metadata associated with the operation.
|
Operation.Builder |
mergeResponse(com.google.protobuf.Any value)
The normal response of the operation in case of success.
|
Operation.Builder |
mergeUnknownFields(com.google.protobuf.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(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Operation.Builder |
setMetadata(com.google.protobuf.Any.Builder builderForValue)
Service-specific metadata associated with the operation.
|
Operation.Builder |
setMetadata(com.google.protobuf.Any value)
Service-specific metadata associated with the operation.
|
Operation.Builder |
setName(String value)
The server-assigned name, which is only unique within the same service that
originally returns it.
|
Operation.Builder |
setNameBytes(com.google.protobuf.ByteString value)
The server-assigned name, which is only unique within the same service that
originally returns it.
|
Operation.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Operation.Builder |
setResponse(com.google.protobuf.Any.Builder builderForValue)
The normal response of the operation in case of success.
|
Operation.Builder |
setResponse(com.google.protobuf.Any value)
The normal response of the operation in case of success.
|
Operation.Builder |
setUnknownFields(com.google.protobuf.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, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Operation.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Operation.Builder>public Operation getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Operation build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Operation buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Operation.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Operation.Builder>public Operation.Builder mergeFrom(Operation other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Operation.Builder>public Operation.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Operation.Builder>IOExceptionpublic Operation.ResultCase getResultCase()
getResultCase in interface OperationOrBuilderpublic Operation.Builder clearResult()
public 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 be a resource name ending with `operations/{unique_id}`.
string name = 1;getName in interface OperationOrBuilderpublic com.google.protobuf.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 be a resource name ending with `operations/{unique_id}`.
string name = 1;getNameBytes in interface OperationOrBuilderpublic Operation.Builder setName(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 be a resource name ending with `operations/{unique_id}`.
string name = 1;value - The name to set.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 be a resource name ending with `operations/{unique_id}`.
string name = 1;public Operation.Builder setNameBytes(com.google.protobuf.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 be a resource name ending with `operations/{unique_id}`.
string name = 1;value - The bytes for name to set.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 com.google.protobuf.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(com.google.protobuf.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(com.google.protobuf.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(com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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;value - The done to set.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 com.google.protobuf.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(com.google.protobuf.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(com.google.protobuf.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(com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Operation.Builder>public final Operation.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Operation.Builder>Copyright © 2021 Google LLC. All rights reserved.