public final class Operation extends com.google.protobuf.GeneratedMessageV3 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 | Class and Description |
---|---|
static class |
Operation.Builder
This resource represents a long-running operation that is the result of a
network API call.
|
static class |
Operation.ResultCase |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
Modifier and Type | Field and Description |
---|---|
static int |
DONE_FIELD_NUMBER |
static int |
ERROR_FIELD_NUMBER |
static int |
METADATA_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
RESPONSE_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
static Operation |
getDefaultInstance() |
Operation |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
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.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.
|
com.google.protobuf.ByteString |
getNameBytes()
The server-assigned name, which is only unique within the same service that
originally returns it.
|
com.google.protobuf.Parser<Operation> |
getParserForType() |
com.google.protobuf.Any |
getResponse()
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() |
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasError()
The error result of the operation in case of failure or cancellation.
|
int |
hashCode() |
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() |
static Operation.Builder |
newBuilder() |
static Operation.Builder |
newBuilder(Operation prototype) |
Operation.Builder |
newBuilderForType() |
protected Operation.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static Operation |
parseDelimitedFrom(java.io.InputStream input) |
static Operation |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Operation |
parseFrom(byte[] data) |
static Operation |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Operation |
parseFrom(java.nio.ByteBuffer data) |
static Operation |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Operation |
parseFrom(com.google.protobuf.ByteString data) |
static Operation |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Operation |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Operation |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Operation |
parseFrom(java.io.InputStream input) |
static Operation |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Operation> |
parser() |
Operation.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int NAME_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
public static final int DONE_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
public static final int RESPONSE_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public Operation.ResultCase getResultCase()
getResultCase
in interface OperationOrBuilder
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 OperationOrBuilder
public 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 have the format of `operations/some/unique/name`.
string name = 1;
getNameBytes
in interface OperationOrBuilder
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 OperationOrBuilder
public 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 OperationOrBuilder
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 OperationOrBuilder
public 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 OperationOrBuilder
public boolean hasError()
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;
hasError
in interface OperationOrBuilder
public Status getError()
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;
getError
in interface OperationOrBuilder
public StatusOrBuilder getErrorOrBuilder()
The error result of the operation in case of failure or cancellation.
.google.rpc.Status error = 4;
getErrorOrBuilder
in interface OperationOrBuilder
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;
hasResponse
in interface OperationOrBuilder
public 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 OperationOrBuilder
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 OperationOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(java.lang.Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static Operation parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Operation parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Operation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Operation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Operation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Operation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Operation parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Operation parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Operation parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Operation parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Operation parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static Operation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public Operation.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static Operation.Builder newBuilder()
public static Operation.Builder newBuilder(Operation prototype)
public Operation.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected Operation.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static Operation getDefaultInstance()
public static com.google.protobuf.Parser<Operation> parser()
public com.google.protobuf.Parser<Operation> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public Operation getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder