com.clarifai.grpc.api.ListModelConceptsRequestOrBuilder 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 ListModelConceptsRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:clarifai.api.ListModelConceptsRequest)
    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();

  /**
   *    * Model id
   * 
   *
   * string model_id = 2;
   * @return The modelId.
   */
  java.lang.String getModelId();
  /**
   *    * Model id
   * 
   *
   * string model_id = 2;
   * @return The bytes for modelId.
   */
  com.google.protobuf.ByteString
      getModelIdBytes();

  /**
   *    * Model version Id. Optional, if not provided latest model version is used.
   * 
   *
   * string version_id = 3;
   * @return The versionId.
   */
  java.lang.String getVersionId();
  /**
   *    * Model version Id. Optional, if not provided latest model version is used.
   * 
   *
   * string version_id = 3;
   * @return The bytes for versionId.
   */
  com.google.protobuf.ByteString
      getVersionIdBytes();

  /**
   *    * (optional URL parameter) The page number. Pagination is used to split the results into chunks.
   * Defaults to 1.
   * 
   *
   * uint32 page = 4;
   * @return The page.
   */
  int getPage();

  /**
   *    * (optional URL parameter) The number of results that will be contained in each page. Defaults
   * to 128.
   * 
   *
   * uint32 per_page = 5;
   * @return The perPage.
   */
  int getPerPage();

  /**
   *    * Searching options:
   * Specify a search parameter in order to perform keyword search on the
   * following fields of the concept:
   *   - id
   *   - name
   * Keywords are used for partial prefix-matching (so searching for "larif" matches "clarifai").
   * NOTE: Both the list of fields searched and the exact keyword matching
   * rules are subject to change and not guaranteed to be backwards-compatible.
   * 
   *
   * string search = 6;
   * @return The search.
   */
  java.lang.String getSearch();
  /**
   *    * Searching options:
   * Specify a search parameter in order to perform keyword search on the
   * following fields of the concept:
   *   - id
   *   - name
   * Keywords are used for partial prefix-matching (so searching for "larif" matches "clarifai").
   * NOTE: Both the list of fields searched and the exact keyword matching
   * rules are subject to change and not guaranteed to be backwards-compatible.
   * 
   *
   * string search = 6;
   * @return The bytes for search.
   */
  com.google.protobuf.ByteString
      getSearchBytes();
}