com.google.longrunning.OperationOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-longrunning-v1 Show documentation
PROTO library for proto-google-longrunning-v1
There is a newer version: 0.1.24
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/longrunning/operations.proto

package com.google.longrunning;

public interface OperationOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.longrunning.Operation)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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;
   */
  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;
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * 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;
   */
  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;
   */
  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;
   */
  com.google.protobuf.AnyOrBuilder getMetadataOrBuilder();

  /**
   *    * 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;
   */
  boolean getDone();

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

  /**
   *    * 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;
   */
  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;
   */
  com.google.protobuf.AnyOrBuilder getResponseOrBuilder();

  public com.google.longrunning.Operation.ResultCase getResultCase();
}