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

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

package com.clarifai.grpc.api;

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

  /**
   *    * Unique ID for the task.
   * 
   *
   * string id = 1;
   * @return The id.
   */
  java.lang.String getId();
  /**
   *    * Unique ID for the task.
   * 
   *
   * string id = 1;
   * @return The bytes for id.
   */
  com.google.protobuf.ByteString
      getIdBytes();

  /**
   *    * When the task was created.
   * The format is https://www.ietf.org/rfc/rfc3339.txt.
   * Example: "2006-01-02T15:04:05.999999Z".
   * 
   *
   * .google.protobuf.Timestamp created_at = 2;
   * @return Whether the createdAt field is set.
   */
  boolean hasCreatedAt();
  /**
   *    * When the task was created.
   * The format is https://www.ietf.org/rfc/rfc3339.txt.
   * Example: "2006-01-02T15:04:05.999999Z".
   * 
   *
   * .google.protobuf.Timestamp created_at = 2;
   * @return The createdAt.
   */
  com.google.protobuf.Timestamp getCreatedAt();
  /**
   *    * When the task was created.
   * The format is https://www.ietf.org/rfc/rfc3339.txt.
   * Example: "2006-01-02T15:04:05.999999Z".
   * 
   *
   * .google.protobuf.Timestamp created_at = 2;
   */
  com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder();

  /**
   *    * Most recent time when the task was updated.
   * The format is https://www.ietf.org/rfc/rfc3339.txt.
   * Example: "2006-01-02T15:04:05.999999Z".
   * 
   *
   * .google.protobuf.Timestamp modified_at = 3;
   * @return Whether the modifiedAt field is set.
   */
  boolean hasModifiedAt();
  /**
   *    * Most recent time when the task was updated.
   * The format is https://www.ietf.org/rfc/rfc3339.txt.
   * Example: "2006-01-02T15:04:05.999999Z".
   * 
   *
   * .google.protobuf.Timestamp modified_at = 3;
   * @return The modifiedAt.
   */
  com.google.protobuf.Timestamp getModifiedAt();
  /**
   *    * Most recent time when the task was updated.
   * The format is https://www.ietf.org/rfc/rfc3339.txt.
   * Example: "2006-01-02T15:04:05.999999Z".
   * 
   *
   * .google.protobuf.Timestamp modified_at = 3;
   */
  com.google.protobuf.TimestampOrBuilder getModifiedAtOrBuilder();

  /**
   *    * Task type.
   * 
   *
   * .clarifai.api.Task.TaskType type = 4;
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *    * Task type.
   * 
   *
   * .clarifai.api.Task.TaskType type = 4;
   * @return The type.
   */
  com.clarifai.grpc.api.Task.TaskType getType();

  /**
   *    * Description of the task.
   * 
   *
   * string description = 5;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *    * Description of the task.
   * 
   *
   * string description = 5;
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * Worker details.
   * 
   *
   * .clarifai.api.TaskWorker worker = 6;
   * @return Whether the worker field is set.
   */
  boolean hasWorker();
  /**
   *    * Worker details.
   * 
   *
   * .clarifai.api.TaskWorker worker = 6;
   * @return The worker.
   */
  com.clarifai.grpc.api.TaskWorker getWorker();
  /**
   *    * Worker details.
   * 
   *
   * .clarifai.api.TaskWorker worker = 6;
   */
  com.clarifai.grpc.api.TaskWorkerOrBuilder getWorkerOrBuilder();

  /**
   *    * List of concept ids used in the work of this task.
   * DEPRECATED: Use task.concepts instead.
   * 
   *
   * repeated string concept_ids = 7 [deprecated = true];
   * @deprecated clarifai.api.Task.concept_ids is deprecated.
   *     See proto/clarifai/api/resources.proto;l=3008
   * @return A list containing the conceptIds.
   */
  @java.lang.Deprecated java.util.List
      getConceptIdsList();
  /**
   *    * List of concept ids used in the work of this task.
   * DEPRECATED: Use task.concepts instead.
   * 
   *
   * repeated string concept_ids = 7 [deprecated = true];
   * @deprecated clarifai.api.Task.concept_ids is deprecated.
   *     See proto/clarifai/api/resources.proto;l=3008
   * @return The count of conceptIds.
   */
  @java.lang.Deprecated int getConceptIdsCount();
  /**
   *    * List of concept ids used in the work of this task.
   * DEPRECATED: Use task.concepts instead.
   * 
   *
   * repeated string concept_ids = 7 [deprecated = true];
   * @deprecated clarifai.api.Task.concept_ids is deprecated.
   *     See proto/clarifai/api/resources.proto;l=3008
   * @param index The index of the element to return.
   * @return The conceptIds at the given index.
   */
  @java.lang.Deprecated java.lang.String getConceptIds(int index);
  /**
   *    * List of concept ids used in the work of this task.
   * DEPRECATED: Use task.concepts instead.
   * 
   *
   * repeated string concept_ids = 7 [deprecated = true];
   * @deprecated clarifai.api.Task.concept_ids is deprecated.
   *     See proto/clarifai/api/resources.proto;l=3008
   * @param index The index of the value to return.
   * @return The bytes of the conceptIds at the given index.
   */
  @java.lang.Deprecated com.google.protobuf.ByteString
      getConceptIdsBytes(int index);

  /**
   *    * List of inputs used in this task will be taken from this source.
   * 
   *
   * .clarifai.api.TaskInputSource input_source = 8;
   * @return Whether the inputSource field is set.
   */
  boolean hasInputSource();
  /**
   *    * List of inputs used in this task will be taken from this source.
   * 
   *
   * .clarifai.api.TaskInputSource input_source = 8;
   * @return The inputSource.
   */
  com.clarifai.grpc.api.TaskInputSource getInputSource();
  /**
   *    * List of inputs used in this task will be taken from this source.
   * 
   *
   * .clarifai.api.TaskInputSource input_source = 8;
   */
  com.clarifai.grpc.api.TaskInputSourceOrBuilder getInputSourceOrBuilder();

  /**
   *    * For model predictions on video: Sample delay for video predicting (1 frame per N milliseconds)
   * 
   *
   * uint32 sample_ms = 9;
   * @return The sampleMs.
   */
  int getSampleMs();

  /**
   *    * AI assistant details.
   * 
   *
   * .clarifai.api.TaskAIAssistant ai_assistant = 10;
   * @return Whether the aiAssistant field is set.
   */
  boolean hasAiAssistant();
  /**
   *    * AI assistant details.
   * 
   *
   * .clarifai.api.TaskAIAssistant ai_assistant = 10;
   * @return The aiAssistant.
   */
  com.clarifai.grpc.api.TaskAIAssistant getAiAssistant();
  /**
   *    * AI assistant details.
   * 
   *
   * .clarifai.api.TaskAIAssistant ai_assistant = 10;
   */
  com.clarifai.grpc.api.TaskAIAssistantOrBuilder getAiAssistantOrBuilder();

  /**
   *    * Review details.
   * 
   *
   * .clarifai.api.TaskReview review = 11;
   * @return Whether the review field is set.
   */
  boolean hasReview();
  /**
   *    * Review details.
   * 
   *
   * .clarifai.api.TaskReview review = 11;
   * @return The review.
   */
  com.clarifai.grpc.api.TaskReview getReview();
  /**
   *    * Review details.
   * 
   *
   * .clarifai.api.TaskReview review = 11;
   */
  com.clarifai.grpc.api.TaskReviewOrBuilder getReviewOrBuilder();

  /**
   *    * Status of this task.
   * 
   *
   * .clarifai.api.status.Status status = 12;
   * @return Whether the status field is set.
   */
  boolean hasStatus();
  /**
   *    * Status of this task.
   * 
   *
   * .clarifai.api.status.Status status = 12;
   * @return The status.
   */
  com.clarifai.grpc.api.status.Status getStatus();
  /**
   *    * Status of this task.
   * 
   *
   * .clarifai.api.status.Status status = 12;
   */
  com.clarifai.grpc.api.status.StatusOrBuilder getStatusOrBuilder();

  /**
   *    * Add a title for this task to quickly recognise it in a list of tasks.
   * 
   *
   * string name = 13;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * Add a title for this task to quickly recognise it in a list of tasks.
   * 
   *
   * string name = 13;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   * .clarifai.api.AiAssistParameters ai_assist_params = 14;
   * @return Whether the aiAssistParams field is set.
   */
  boolean hasAiAssistParams();
  /**
   * .clarifai.api.AiAssistParameters ai_assist_params = 14;
   * @return The aiAssistParams.
   */
  com.clarifai.grpc.api.AiAssistParameters getAiAssistParams();
  /**
   * .clarifai.api.AiAssistParameters ai_assist_params = 14;
   */
  com.clarifai.grpc.api.AiAssistParametersOrBuilder getAiAssistParamsOrBuilder();

  /**
   *    * The visibility field represents whether this message is privately/publicly visible.
   * To be visible to the public the App that contains it AND the User that contains the App must
   * also be publicly visible.
   * 
   *
   * .clarifai.api.Visibility visibility = 15;
   * @return Whether the visibility field is set.
   */
  boolean hasVisibility();
  /**
   *    * The visibility field represents whether this message is privately/publicly visible.
   * To be visible to the public the App that contains it AND the User that contains the App must
   * also be publicly visible.
   * 
   *
   * .clarifai.api.Visibility visibility = 15;
   * @return The visibility.
   */
  com.clarifai.grpc.api.Visibility getVisibility();
  /**
   *    * The visibility field represents whether this message is privately/publicly visible.
   * To be visible to the public the App that contains it AND the User that contains the App must
   * also be publicly visible.
   * 
   *
   * .clarifai.api.Visibility visibility = 15;
   */
  com.clarifai.grpc.api.VisibilityOrBuilder getVisibilityOrBuilder();

  /**
   *    * The app the task belongs to.
   * 
   *
   * string app_id = 16;
   * @return The appId.
   */
  java.lang.String getAppId();
  /**
   *    * The app the task belongs to.
   * 
   *
   * string app_id = 16;
   * @return The bytes for appId.
   */
  com.google.protobuf.ByteString
      getAppIdBytes();

  /**
   *    * The user the task belongs to.
   * 
   *
   * string user_id = 17;
   * @return The userId.
   */
  java.lang.String getUserId();
  /**
   *    * The user the task belongs to.
   * 
   *
   * string user_id = 17;
   * @return The bytes for userId.
   */
  com.google.protobuf.ByteString
      getUserIdBytes();

  /**
   *    * The label order the task belongs to.
   * 
   *
   * string label_order_id = 18;
   * @return The labelOrderId.
   */
  java.lang.String getLabelOrderId();
  /**
   *    * The label order the task belongs to.
   * 
   *
   * string label_order_id = 18;
   * @return The bytes for labelOrderId.
   */
  com.google.protobuf.ByteString
      getLabelOrderIdBytes();

  /**
   *    * Ignore Task.concept_ids field if Task.TaskConcept are supplied.
   * 
   *
   * repeated .clarifai.api.TaskConcept concepts = 19;
   */
  java.util.List 
      getConceptsList();
  /**
   *    * Ignore Task.concept_ids field if Task.TaskConcept are supplied.
   * 
   *
   * repeated .clarifai.api.TaskConcept concepts = 19;
   */
  com.clarifai.grpc.api.TaskConcept getConcepts(int index);
  /**
   *    * Ignore Task.concept_ids field if Task.TaskConcept are supplied.
   * 
   *
   * repeated .clarifai.api.TaskConcept concepts = 19;
   */
  int getConceptsCount();
  /**
   *    * Ignore Task.concept_ids field if Task.TaskConcept are supplied.
   * 
   *
   * repeated .clarifai.api.TaskConcept concepts = 19;
   */
  java.util.List 
      getConceptsOrBuilderList();
  /**
   *    * Ignore Task.concept_ids field if Task.TaskConcept are supplied.
   * 
   *
   * repeated .clarifai.api.TaskConcept concepts = 19;
   */
  com.clarifai.grpc.api.TaskConceptOrBuilder getConceptsOrBuilder(
      int index);

  /**
   *    * Specify whether existing Annotations within the same app that are generated by other auto annotation tasks
   * with the specified Concept from the selected Model or Workflow should deleted before executing the Task
   * 
   *
   * bool delete_previous_annotations = 20;
   * @return The deletePreviousAnnotations.
   */
  boolean getDeletePreviousAnnotations();

  /**
   *    * Tasks metrics are filled in upon user-request.
   * 
   *
   * .clarifai.api.TaskMetrics metrics = 21;
   * @return Whether the metrics field is set.
   */
  boolean hasMetrics();
  /**
   *    * Tasks metrics are filled in upon user-request.
   * 
   *
   * .clarifai.api.TaskMetrics metrics = 21;
   * @return The metrics.
   */
  com.clarifai.grpc.api.TaskMetrics getMetrics();
  /**
   *    * Tasks metrics are filled in upon user-request.
   * 
   *
   * .clarifai.api.TaskMetrics metrics = 21;
   */
  com.clarifai.grpc.api.TaskMetricsOrBuilder getMetricsOrBuilder();
}