Package com.google.longrunning

Class Operation

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<Operation,Operation.Builder>
com.google.longrunning.Operation
All Implemented Interfaces:
OperationOrBuilder, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder
public final class Operation extends com.google.protobuf.GeneratedMessageLite<Operation,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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Operation.Builder
    This resource represents a long-running operation that is the result of a network API call.
    static enum 
    Operation.ResultCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DONE_FIELD_NUMBER
     
    static final int
    ERROR_FIELD_NUMBER
     
    static final int
    METADATA_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    RESPONSE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    static Operation
    getDefaultInstance()
     
    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.
    com.google.protobuf.Any
    getMetadata()
    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, successful response of the operation.
    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, successful response of the operation.
    static Operation.Builder
    newBuilder()
     
    static Operation.Builder
    newBuilder(Operation prototype)
     
    static Operation
    parseDelimitedFrom(InputStream input)
     
    static Operation
    parseDelimitedFrom(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(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(InputStream input)
     
    static Operation
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Operation
    parseFrom(ByteBuffer data)
     
    static Operation
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Operation>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

  • Method Details

    • getResultCase

      public Operation.ResultCase getResultCase()
      Specified by:
      getResultCase in interface OperationOrBuilder

    • getName

      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 [json_name = "name"];
      Specified by:
      getName in interface OperationOrBuilder
      Returns:
      The name.

    • getNameBytes

      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 be a resource name ending with `operations/{unique_id}`.
      string name = 1 [json_name = "name"];
      Specified by:
      getNameBytes in interface OperationOrBuilder
      Returns:
      The bytes for name.

    • hasMetadata

      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 [json_name = "metadata"];
      Specified by:
      hasMetadata in interface OperationOrBuilder
      Returns:
      Whether the metadata field is set.

    • getMetadata

      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 [json_name = "metadata"];
      Specified by:
      getMetadata in interface OperationOrBuilder
      Returns:
      The metadata.

    • getDone

      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 [json_name = "done"];
      Specified by:
      getDone in interface OperationOrBuilder
      Returns:
      The done.

    • hasError

      public boolean hasError()
       The error result of the operation in case of failure or cancellation.
      .google.rpc.Status error = 4 [json_name = "error"];
      Specified by:
      hasError in interface OperationOrBuilder
      Returns:
      Whether the error field is set.

    • getError

      public Status getError()
       The error result of the operation in case of failure or cancellation.
      .google.rpc.Status error = 4 [json_name = "error"];
      Specified by:
      getError in interface OperationOrBuilder
      Returns:
      The error.

    • hasResponse

      public boolean hasResponse()
       The normal, successful response of the operation.  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 [json_name = "response"];
      Specified by:
      hasResponse in interface OperationOrBuilder
      Returns:
      Whether the response field is set.

    • getResponse

      public com.google.protobuf.Any getResponse()
       The normal, successful response of the operation.  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 [json_name = "response"];
      Specified by:
      getResponse in interface OperationOrBuilder
      Returns:
      The response.

    • parseFrom

      public static Operation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Operation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Operation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Operation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Operation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Operation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Operation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Operation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Operation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Operation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Operation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Operation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static Operation.Builder newBuilder()

    • newBuilder

      public static Operation.Builder newBuilder(Operation prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<Operation,Operation.Builder>

    • getDefaultInstance

      public static Operation getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Operation> parser()