Package com.google.longrunning

Class Operation.Builder

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

  • Field Summary

    Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder

    instance

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    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
    clearResponse()
    The normal, successful response of the operation.
    Operation.Builder
    clearResult()
     
    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.
    Operation.Builder
    mergeError(Status value)
    The error result of the operation in case of failure or cancellation.
    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, successful response of the operation.
    Operation.Builder
    setDone(boolean value)
    If the value is `false`, it means the operation is still in progress.
    Operation.Builder
    setError(Status value)
    The error result of the operation in case of failure or cancellation.
    Operation.Builder
    setError(Status.Builder builderForValue)
    The error result of the operation in case of failure or cancellation.
    Operation.Builder
    setMetadata(com.google.protobuf.Any value)
    Service-specific metadata associated with the operation.
    Operation.Builder
    setMetadata(com.google.protobuf.Any.Builder builderForValue)
    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
    setResponse(com.google.protobuf.Any value)
    The normal, successful response of the operation.
    Operation.Builder
    setResponse(com.google.protobuf.Any.Builder builderForValue)
    The normal, successful response of the operation.

    Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder

    build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFrom

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getResultCase

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

    • clearResult

      public Operation.Builder clearResult()

    • 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.

    • setName

      public 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 [json_name = "name"];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      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 [json_name = "name"];
      Returns:
      This builder for chaining.

    • setNameBytes

      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 [json_name = "name"];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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.

    • setMetadata

      public 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 [json_name = "metadata"];

    • setMetadata

      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 [json_name = "metadata"];

    • mergeMetadata

      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 [json_name = "metadata"];

    • clearMetadata

      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 [json_name = "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.

    • setDone

      public 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 [json_name = "done"];
      Parameters:
      value - The done to set.
      Returns:
      This builder for chaining.

    • clearDone

      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 [json_name = "done"];
      Returns:
      This builder for chaining.

    • 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.

    • setError

      public Operation.Builder setError(Status value)
       The error result of the operation in case of failure or cancellation.
      .google.rpc.Status error = 4 [json_name = "error"];

    • setError

      public Operation.Builder setError(Status.Builder builderForValue)
       The error result of the operation in case of failure or cancellation.
      .google.rpc.Status error = 4 [json_name = "error"];

    • mergeError

      public Operation.Builder mergeError(Status value)
       The error result of the operation in case of failure or cancellation.
      .google.rpc.Status error = 4 [json_name = "error"];

    • clearError

      public Operation.Builder clearError()
       The error result of the operation in case of failure or cancellation.
      .google.rpc.Status error = 4 [json_name = "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.

    • setResponse

      public Operation.Builder setResponse(com.google.protobuf.Any value)
       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"];

    • setResponse

      public Operation.Builder setResponse(com.google.protobuf.Any.Builder builderForValue)
       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"];

    • mergeResponse

      public Operation.Builder mergeResponse(com.google.protobuf.Any value)
       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"];

    • clearResponse

      public Operation.Builder clearResponse()
       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"];