public final class Operation extends GeneratedMessageV3 implements OperationOrBuilder
This resource represents a long-running operation that is the result of a
network API call.
Protobuf type google.longrunning.Operation
Static Fields
DONE_FIELD_NUMBER
public static final int DONE_FIELD_NUMBER
Field Value
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RESPONSE_FIELD_NUMBER
public static final int RESPONSE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Operation getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Operation.Builder newBuilder()
Returns
newBuilder(Operation prototype)
public static Operation.Builder newBuilder(Operation prototype)
Parameter
Returns
public static Operation parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Operation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Operation parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Operation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Operation parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Operation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Operation parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Operation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Operation parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Operation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Operation parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Operation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Operation> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Operation getDefaultInstanceForType()
Returns
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;
getError()
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;
| Type | Description |
| Status | The error.
|
getErrorOrBuilder()
public StatusOrBuilder getErrorOrBuilder()
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;
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;
| Type | Description |
| Any | The metadata.
|
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;
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;
| Type | Description |
| String | The name.
|
getNameBytes()
public 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;
getParserForType()
public Parser<Operation> getParserForType()
Returns
Overrides
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;
| Type | Description |
| Any | The response.
|
getResponseOrBuilder()
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;
getResultCase()
public Operation.ResultCase getResultCase()
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasError()
public boolean hasError()
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;
| Type | Description |
| boolean | Whether the error field is 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;
| Type | Description |
| boolean | Whether the metadata field is set.
|
hasResponse()
public 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;
| Type | Description |
| boolean | Whether the response field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Operation.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Operation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Operation.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
