com.clarifai.grpc.api.status.StatusOrBuilder Maven / Gradle / Ivy

Go to download
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: proto/clarifai/api/status/status.proto

package com.clarifai.grpc.api.status;

public interface StatusOrBuilder extends
    // @@protoc_insertion_point(interface_extends:clarifai.api.status.Status)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Status code from internal codes.
   * 
   *
   * .clarifai.api.status.StatusCode code = 1;
   * @return The enum numeric value on the wire for code.
   */
  int getCodeValue();
  /**
   *    * Status code from internal codes.
   * 
   *
   * .clarifai.api.status.StatusCode code = 1;
   * @return The code.
   */
  com.clarifai.grpc.api.status.StatusCode getCode();

  /**
   *    * A short description of the error.
   * 
   *
   * string description = 2;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *    * A short description of the error.
   * 
   *
   * string description = 2;
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * More details of the given error.
   * These details may be exposed to non-technical users.
   * For technical details, try to use developer_notes field.
   * 
   *
   * string details = 3;
   * @return The details.
   */
  java.lang.String getDetails();
  /**
   *    * More details of the given error.
   * These details may be exposed to non-technical users.
   * For technical details, try to use developer_notes field.
   * 
   *
   * string details = 3;
   * @return The bytes for details.
   */
  com.google.protobuf.ByteString
      getDetailsBytes();

  /**
   *    * For some environment we may return a stack trace to help debug
   * any issues.
   * 
   *
   * repeated string stack_trace = 4 [(.clarifai.auth.util.cl_private_field) = true];
   * @return A list containing the stackTrace.
   */
  java.util.List
      getStackTraceList();
  /**
   *    * For some environment we may return a stack trace to help debug
   * any issues.
   * 
   *
   * repeated string stack_trace = 4 [(.clarifai.auth.util.cl_private_field) = true];
   * @return The count of stackTrace.
   */
  int getStackTraceCount();
  /**
   *    * For some environment we may return a stack trace to help debug
   * any issues.
   * 
   *
   * repeated string stack_trace = 4 [(.clarifai.auth.util.cl_private_field) = true];
   * @param index The index of the element to return.
   * @return The stackTrace at the given index.
   */
  java.lang.String getStackTrace(int index);
  /**
   *    * For some environment we may return a stack trace to help debug
   * any issues.
   * 
   *
   * repeated string stack_trace = 4 [(.clarifai.auth.util.cl_private_field) = true];
   * @param index The index of the value to return.
   * @return The bytes of the stackTrace at the given index.
   */
  com.google.protobuf.ByteString
      getStackTraceBytes(int index);

  /**
   *    * specifically for long running jobs
   * 
   *
   * uint32 percent_completed = 5;
   * @return The percentCompleted.
   */
  int getPercentCompleted();

  /**
   *    * if status is pending, how much time is remaining (in seconds)
   * 
   *
   * uint32 time_remaining = 6;
   * @return The timeRemaining.
   */
  int getTimeRemaining();

  /**
   *    * A request ID may be present, to help monitoring and tracking requests
   * 
   *
   * string req_id = 7;
   * @return The reqId.
   */
  java.lang.String getReqId();
  /**
   *    * A request ID may be present, to help monitoring and tracking requests
   * 
   *
   * string req_id = 7;
   * @return The bytes for reqId.
   */
  com.google.protobuf.ByteString
      getReqIdBytes();

  /**
   *    * Internal Annotation (do not set in production, for internal Clarifai use only).
   * 
   *
   * string internal_details = 8 [(.clarifai.auth.util.cl_private_field) = true];
   * @return The internalDetails.
   */
  java.lang.String getInternalDetails();
  /**
   *    * Internal Annotation (do not set in production, for internal Clarifai use only).
   * 
   *
   * string internal_details = 8 [(.clarifai.auth.util.cl_private_field) = true];
   * @return The bytes for internalDetails.
   */
  com.google.protobuf.ByteString
      getInternalDetailsBytes();

  /**
   *    * Resource location info for redirect, when resource location has been changed.
   * 
   *
   * .clarifai.api.status.RedirectInfo redirect_info = 9 [(.clarifai.auth.util.cl_private_field) = true];
   * @return Whether the redirectInfo field is set.
   */
  boolean hasRedirectInfo();
  /**
   *    * Resource location info for redirect, when resource location has been changed.
   * 
   *
   * .clarifai.api.status.RedirectInfo redirect_info = 9 [(.clarifai.auth.util.cl_private_field) = true];
   * @return The redirectInfo.
   */
  com.clarifai.grpc.api.status.RedirectInfo getRedirectInfo();
  /**
   *    * Resource location info for redirect, when resource location has been changed.
   * 
   *
   * .clarifai.api.status.RedirectInfo redirect_info = 9 [(.clarifai.auth.util.cl_private_field) = true];
   */
  com.clarifai.grpc.api.status.RedirectInfoOrBuilder getRedirectInfoOrBuilder();

  /**
   *    * Notes for developer.
   * These notes are rather technical details for developers how to interpret the status,
   * e.g. why an error occurred and how to avoid getting the error.
   * 
   *
   * string developer_notes = 10;
   * @return The developerNotes.
   */
  java.lang.String getDeveloperNotes();
  /**
   *    * Notes for developer.
   * These notes are rather technical details for developers how to interpret the status,
   * e.g. why an error occurred and how to avoid getting the error.
   * 
   *
   * string developer_notes = 10;
   * @return The bytes for developerNotes.
   */
  com.google.protobuf.ByteString
      getDeveloperNotesBytes();
}