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

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

package com.clarifai.grpc.api;

public interface ListModulesRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:clarifai.api.ListModulesRequest)
    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();

  /**
   *    * (optional URL parameter) The page number. Pagination is used to split the results into chunks.
   * Defaults to 1.
   * 
   *
   * uint32 page = 2;
   * @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 = 3;
   * @return The perPage.
   */
  int getPerPage();

  /**
   * bool starred_only = 4;
   * @return The starredOnly.
   */
  boolean getStarredOnly();

  /**
   * repeated string additional_fields = 5;
   * @return A list containing the additionalFields.
   */
  java.util.List
      getAdditionalFieldsList();
  /**
   * repeated string additional_fields = 5;
   * @return The count of additionalFields.
   */
  int getAdditionalFieldsCount();
  /**
   * repeated string additional_fields = 5;
   * @param index The index of the element to return.
   * @return The additionalFields at the given index.
   */
  java.lang.String getAdditionalFields(int index);
  /**
   * repeated string additional_fields = 5;
   * @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);

  /**
   *    * Sorting opitons:
   * Whether to sort in ascending order. If false, will order in descending order.
   * 
   *
   * bool sort_ascending = 6;
   * @return The sortAscending.
   */
  boolean getSortAscending();

  /**
   *    * Whether to order by the created_at time.
   * 
   *
   * bool sort_by_created_at = 7;
   * @return Whether the sortByCreatedAt field is set.
   */
  boolean hasSortByCreatedAt();
  /**
   *    * Whether to order by the created_at time.
   * 
   *
   * bool sort_by_created_at = 7;
   * @return The sortByCreatedAt.
   */
  boolean getSortByCreatedAt();

  /**
   *    * Whether to order by the number of users stared the app
   * 
   *
   * bool sort_by_star_count = 8;
   * @return Whether the sortByStarCount field is set.
   */
  boolean hasSortByStarCount();
  /**
   *    * Whether to order by the number of users stared the app
   * 
   *
   * bool sort_by_star_count = 8;
   * @return The sortByStarCount.
   */
  boolean getSortByStarCount();

  /**
   *    * If neither sort option is set to true, will sort by modified_at.
   * 
   *
   * bool sort_by_modified_at = 9;
   * @return Whether the sortByModifiedAt field is set.
   */
  boolean hasSortByModifiedAt();
  /**
   *    * If neither sort option is set to true, will sort by modified_at.
   * 
   *
   * bool sort_by_modified_at = 9;
   * @return The sortByModifiedAt.
   */
  boolean getSortByModifiedAt();

  /**
   *    * Whether to order by the external id
   * 
   *
   * bool sort_by_id = 11;
   * @return Whether the sortById field is set.
   */
  boolean hasSortById();
  /**
   *    * Whether to order by the external id
   * 
   *
   * bool sort_by_id = 11;
   * @return The sortById.
   */
  boolean getSortById();

  /**
   *    * Filter modules by bookmark. If set, only return bookmarked modules. Otherwise none bookmarked modules only.
   * 
   *
   * bool bookmark = 10;
   * @return The bookmark.
   */
  boolean getBookmark();

  /**
   *    * Filter by the description and name of the model. This supports wildcard queries like "gen*" to match "general" as an example.
   * 
   *
   * string name = 12;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * Filter by the description and name of the model. This supports wildcard queries like "gen*" to match "general" as an example.
   * 
   *
   * string name = 12;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Filter by the application owner whose this module belongs to
   * 
   *
   * bool filter_by_user_id = 13;
   * @return The filterByUserId.
   */
  boolean getFilterByUserId();

  public com.clarifai.grpc.api.ListModulesRequest.SortByCase getSortByCase();
}