com.clarifai.grpc.api.PostWorkflowResultsRequestOrBuilder Maven / Gradle / Ivy
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 PostWorkflowResultsRequestOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.PostWorkflowResultsRequest)
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();
/**
*
* Workflow version ID to retrieve
* If no ID is specified, latest workflow version is used
*
*
* string version_id = 7;
* @return The versionId.
*/
java.lang.String getVersionId();
/**
*
* Workflow version ID to retrieve
* If no ID is specified, latest workflow version is used
*
*
* string version_id = 7;
* @return The bytes for versionId.
*/
com.google.protobuf.ByteString
getVersionIdBytes();
/**
* repeated .clarifai.api.Input inputs = 3;
*/
java.util.List
getInputsList();
/**
* repeated .clarifai.api.Input inputs = 3;
*/
com.clarifai.grpc.api.Input getInputs(int index);
/**
* repeated .clarifai.api.Input inputs = 3;
*/
int getInputsCount();
/**
* repeated .clarifai.api.Input inputs = 3;
*/
java.util.List extends com.clarifai.grpc.api.InputOrBuilder>
getInputsOrBuilderList();
/**
* repeated .clarifai.api.Input inputs = 3;
*/
com.clarifai.grpc.api.InputOrBuilder getInputsOrBuilder(
int index);
/**
*
* FIXME(zeiler): the request for post workflows is using an outputconfig object that is supposed
* to be within models. This is not consistent with setting this on the request for post model
* outputs where it is inside a model object. To make this consistent we would send in the
* workflow object so that each model can have it's own output config. If nobody is setting
* this OutputConfig it would probably be easier to just remove it for now to keep things simpler
* and then it's more consistent we just don't support the OutputConfig on workflows.
*
*
* .clarifai.api.OutputConfig output_config = 4;
* @return Whether the outputConfig field is set.
*/
boolean hasOutputConfig();
/**
*
* FIXME(zeiler): the request for post workflows is using an outputconfig object that is supposed
* to be within models. This is not consistent with setting this on the request for post model
* outputs where it is inside a model object. To make this consistent we would send in the
* workflow object so that each model can have it's own output config. If nobody is setting
* this OutputConfig it would probably be easier to just remove it for now to keep things simpler
* and then it's more consistent we just don't support the OutputConfig on workflows.
*
*
* .clarifai.api.OutputConfig output_config = 4;
* @return The outputConfig.
*/
com.clarifai.grpc.api.OutputConfig getOutputConfig();
/**
*
* FIXME(zeiler): the request for post workflows is using an outputconfig object that is supposed
* to be within models. This is not consistent with setting this on the request for post model
* outputs where it is inside a model object. To make this consistent we would send in the
* workflow object so that each model can have it's own output config. If nobody is setting
* this OutputConfig it would probably be easier to just remove it for now to keep things simpler
* and then it's more consistent we just don't support the OutputConfig on workflows.
*
*
* .clarifai.api.OutputConfig output_config = 4;
*/
com.clarifai.grpc.api.OutputConfigOrBuilder getOutputConfigOrBuilder();
/**
*
* Use this flag to look into clarifai published workflows first for a Workflow ID
*
*
* bool favor_clarifai_workflows = 5;
* @return The favorClarifaiWorkflows.
*/
boolean getFavorClarifaiWorkflows();
/**
*
* A workflow state to be maintained across PostWorkflowResults requests/responses.
* If it is not sent in the initial request with workflow_state.id = "init" then no
* state will be saved or returned in PostWorkflowResultsResponse.
*
*
* .clarifai.api.WorkflowState workflow_state = 6;
* @return Whether the workflowState field is set.
*/
boolean hasWorkflowState();
/**
*
* A workflow state to be maintained across PostWorkflowResults requests/responses.
* If it is not sent in the initial request with workflow_state.id = "init" then no
* state will be saved or returned in PostWorkflowResultsResponse.
*
*
* .clarifai.api.WorkflowState workflow_state = 6;
* @return The workflowState.
*/
com.clarifai.grpc.api.WorkflowState getWorkflowState();
/**
*
* A workflow state to be maintained across PostWorkflowResults requests/responses.
* If it is not sent in the initial request with workflow_state.id = "init" then no
* state will be saved or returned in PostWorkflowResultsResponse.
*
*
* .clarifai.api.WorkflowState workflow_state = 6;
*/
com.clarifai.grpc.api.WorkflowStateOrBuilder getWorkflowStateOrBuilder();
}