Package com.google.longrunning

Interface OperationOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Operation, Operation.Builder
    public interface OperationOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      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.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.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getName

        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;
        Returns:
        The name.

      • getNameBytes

        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;
        Returns:
        The bytes for name.

      • hasMetadata

        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;
        Returns:
        Whether the metadata field is set.

      • getMetadata

        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;
        Returns:
        The metadata.

      • getMetadataOrBuilder

        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;

      • getDone

        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;
        Returns:
        The done.

      • hasError

        boolean hasError()
         The error result of the operation in case of failure or cancellation.
        .google.rpc.Status error = 4;
        Returns:
        Whether the error field is set.

      • getError

        Status getError()
         The error result of the operation in case of failure or cancellation.
        .google.rpc.Status error = 4;
        Returns:
        The error.

      • getErrorOrBuilder

        StatusOrBuilder getErrorOrBuilder()
         The error result of the operation in case of failure or cancellation.
        .google.rpc.Status error = 4;

      • hasResponse

        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;
        Returns:
        Whether the response field is set.

      • getResponse

        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;
        Returns:
        The response.

      • getResponseOrBuilder

        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;