com.clarifai.grpc.api.GetWorkflowRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of clarifai-grpc Show documentation
Clarifai Java gRPC Client
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: proto/clarifai/api/service.proto

package com.clarifai.grpc.api;

public interface GetWorkflowRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:clarifai.api.GetWorkflowRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   * .clarifai.api.UserAppIDSet user_app_id = 1;
   * @return Whether the userAppId field is set.
   */
  boolean hasUserAppId();
  /**
   * .clarifai.api.UserAppIDSet user_app_id = 1;
   * @return The userAppId.
   */
  com.clarifai.grpc.api.UserAppIDSet getUserAppId();
  /**
   * .clarifai.api.UserAppIDSet user_app_id = 1;
   */
  com.clarifai.grpc.api.UserAppIDSetOrBuilder getUserAppIdOrBuilder();

  /**
   *    * Workflow ID to retrieve
   * If no ID is specified we return default workflow of the application
   * If an ID is specified by default we first looks into Clarifai workflows for a Workflow ID
   * 
   *
   * string workflow_id = 2;
   * @return The workflowId.
   */
  java.lang.String getWorkflowId();
  /**
   *    * Workflow ID to retrieve
   * If no ID is specified we return default workflow of the application
   * If an ID is specified by default we first looks into Clarifai workflows for a Workflow ID
   * 
   *
   * string workflow_id = 2;
   * @return The bytes for workflowId.
   */
  com.google.protobuf.ByteString
      getWorkflowIdBytes();

  /**
   *    * Use this flag to look into clarifai published workflows first for a Workflow ID
   * 
   *
   * bool favor_clarifai_workflows = 3;
   * @return The favorClarifaiWorkflows.
   */
  boolean getFavorClarifaiWorkflows();

  /**
   *    * (optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars
   * 
   *
   * repeated string additional_fields = 4;
   * @return A list containing the additionalFields.
   */
  java.util.List
      getAdditionalFieldsList();
  /**
   *    * (optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars
   * 
   *
   * repeated string additional_fields = 4;
   * @return The count of additionalFields.
   */
  int getAdditionalFieldsCount();
  /**
   *    * (optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars
   * 
   *
   * repeated string additional_fields = 4;
   * @param index The index of the element to return.
   * @return The additionalFields at the given index.
   */
  java.lang.String getAdditionalFields(int index);
  /**
   *    * (optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars
   * 
   *
   * repeated string additional_fields = 4;
   * @param index The index of the value to return.
   * @return The bytes of the additionalFields at the given index.
   */
  com.google.protobuf.ByteString
      getAdditionalFieldsBytes(int index);

  /**
   *    * if true will not expand search to clarifai workflows
   * 
   *
   * bool exclude_clarifai_workflows = 5;
   * @return The excludeClarifaiWorkflows.
   */
  boolean getExcludeClarifaiWorkflows();
}