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 grpc-core-proto Show documentation
GoogleAPI classes generated from core protos
There is a newer version: 0.0.6
// 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 {

  /**
   * optional string name = 1;
   *
   *    * The name of the operation resource, which is only unique within the same
   * service that originally returns it.
   * 
   */
  java.lang.String getName();
  /**
   * optional string name = 1;
   *
   *    * The name of the operation resource, which is only unique within the same
   * service that originally returns it.
   * 
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   * optional .google.protobuf.Any metadata = 2;
   *
   *    * Some service-specific metadata associated with the operation.  It typically
   * contains progress information and common metadata such as create time.
   * Some services may not provide such metadata.  Any method that returns a
   * long-running operation should document the metadata type, if any.
   * 
   */
  boolean hasMetadata();
  /**
   * optional .google.protobuf.Any metadata = 2;
   *
   *    * Some service-specific metadata associated with the operation.  It typically
   * contains progress information and common metadata such as create time.
   * Some services may not provide such metadata.  Any method that returns a
   * long-running operation should document the metadata type, if any.
   * 
   */
  com.google.protobuf.Any getMetadata();
  /**
   * optional .google.protobuf.Any metadata = 2;
   *
   *    * Some service-specific metadata associated with the operation.  It typically
   * contains progress information and common metadata such as create time.
   * Some services may not provide such metadata.  Any method that returns a
   * long-running operation should document the metadata type, if any.
   * 
   */
  com.google.protobuf.AnyOrBuilder getMetadataOrBuilder();

  /**
   * optional bool done = 3;
   *
   *    * If the value is false, it means the operation is still in progress.
   * If true, the operation is completed and the `result` is available.
   * 
   */
  boolean getDone();

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

  /**
   * optional .google.protobuf.Any response = 5;
   *
   *    * The normal response of the operation in case of success.  If the original
   * method returns no data on success, such as `Delete`, the response will be
   * `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 will be
   * `TakeSnapshotResponse`.
   * 
   */
  com.google.protobuf.Any getResponse();
  /**
   * optional .google.protobuf.Any response = 5;
   *
   *    * The normal response of the operation in case of success.  If the original
   * method returns no data on success, such as `Delete`, the response will be
   * `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 will be
   * `TakeSnapshotResponse`.
   * 
   */
  com.google.protobuf.AnyOrBuilder getResponseOrBuilder();

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