com.clarifai.grpc.api.ListModelsRequestOrBuilder Maven / Gradle / Ivy
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: proto/clarifai/api/service.proto
package com.clarifai.grpc.api;
public interface ListModelsRequestOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.ListModelsRequest)
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();
/**
*
* Sorting options:
* Whether to sort in ascending order. If false, will order in descending order.
*
*
* bool sort_ascending = 10;
* @return The sortAscending.
*/
boolean getSortAscending();
/**
*
* Whether to order by the name
*
*
* bool sort_by_name = 11;
* @return The sortByName.
*/
boolean getSortByName();
/**
*
* Whether to order by the number of training inputs
*
*
* bool sort_by_num_inputs = 12;
* @return The sortByNumInputs.
*/
boolean getSortByNumInputs();
/**
*
* Whether to order by the modified_at time of the latest model version.
* If neither sort option is set to true, will sort by modified_at.
*
*
* bool sort_by_modified_at = 13;
* @return The sortByModifiedAt.
*/
boolean getSortByModifiedAt();
/**
*
* Filtering options:
* // Query various text fields that can contain the words in the query string
*
*
* string query = 14;
* @return The query.
*/
java.lang.String getQuery();
/**
*
* Filtering options:
* // Query various text fields that can contain the words in the query string
*
*
* string query = 14;
* @return The bytes for query.
*/
com.google.protobuf.ByteString
getQueryBytes();
/**
*
* Filter by the name of the model. This supports wildcard queries like "gen*" to match "general" as an example.
* Deprecated in favor of query
*
*
* string name = 5 [deprecated = true];
* @return The name.
*/
@java.lang.Deprecated java.lang.String getName();
/**
*
* Filter by the name of the model. This supports wildcard queries like "gen*" to match "general" as an example.
* Deprecated in favor of query
*
*
* string name = 5 [deprecated = true];
* @return The bytes for name.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getNameBytes();
/**
*
* Filter models by the specific model_type_id. See ListModelTypes for the list of ModelType.Id's
* supported.
*
*
* string model_type_id = 6;
* @return The modelTypeId.
*/
java.lang.String getModelTypeId();
/**
*
* Filter models by the specific model_type_id. See ListModelTypes for the list of ModelType.Id's
* supported.
*
*
* string model_type_id = 6;
* @return The bytes for modelTypeId.
*/
com.google.protobuf.ByteString
getModelTypeIdBytes();
/**
*
* If true, we only return models that have the status MODEL_TRAINED, which includes non-trainable model types.
*
*
* bool trained_only = 7;
* @return The trainedOnly.
*/
boolean getTrainedOnly();
/**
*
* The list of input fields to the model.
* For example, you can specify 'image', which will return models that make inferences on images like visual-classifier models.
*
*
* repeated string input_fields = 8;
* @return A list containing the inputFields.
*/
java.util.List
getInputFieldsList();
/**
*
* The list of input fields to the model.
* For example, you can specify 'image', which will return models that make inferences on images like visual-classifier models.
*
*
* repeated string input_fields = 8;
* @return The count of inputFields.
*/
int getInputFieldsCount();
/**
*
* The list of input fields to the model.
* For example, you can specify 'image', which will return models that make inferences on images like visual-classifier models.
*
*
* repeated string input_fields = 8;
* @param index The index of the element to return.
* @return The inputFields at the given index.
*/
java.lang.String getInputFields(int index);
/**
*
* The list of input fields to the model.
* For example, you can specify 'image', which will return models that make inferences on images like visual-classifier models.
*
*
* repeated string input_fields = 8;
* @param index The index of the value to return.
* @return The bytes of the inputFields at the given index.
*/
com.google.protobuf.ByteString
getInputFieldsBytes(int index);
/**
*
* The list of output fields to the model.
* For example, you can specify 'regions[...].data.concepts', which will return visual-detector models.
*
*
* repeated string output_fields = 9;
* @return A list containing the outputFields.
*/
java.util.List
getOutputFieldsList();
/**
*
* The list of output fields to the model.
* For example, you can specify 'regions[...].data.concepts', which will return visual-detector models.
*
*
* repeated string output_fields = 9;
* @return The count of outputFields.
*/
int getOutputFieldsCount();
/**
*
* The list of output fields to the model.
* For example, you can specify 'regions[...].data.concepts', which will return visual-detector models.
*
*
* repeated string output_fields = 9;
* @param index The index of the element to return.
* @return The outputFields at the given index.
*/
java.lang.String getOutputFields(int index);
/**
*
* The list of output fields to the model.
* For example, you can specify 'regions[...].data.concepts', which will return visual-detector models.
*
*
* repeated string output_fields = 9;
* @param index The index of the value to return.
* @return The bytes of the outputFields at the given index.
*/
com.google.protobuf.ByteString
getOutputFieldsBytes(int index);
/**
*
* Filter by the license of the model version
*
*
* string license = 15;
* @return The license.
*/
java.lang.String getLicense();
/**
*
* Filter by the license of the model version
*
*
* string license = 15;
* @return The bytes for license.
*/
com.google.protobuf.ByteString
getLicenseBytes();
/**
*
* If true, we only return models that are handpicked by clarifai staff
*
*
* bool featured_only = 16;
* @return The featuredOnly.
*/
boolean getFeaturedOnly();
/**
*
* If true, we only return models that are starred by the requesting user
*
*
* bool starred_only = 20;
* @return The starredOnly.
*/
boolean getStarredOnly();
/**
*
* List of toolkit tags to filter by
*
*
* repeated string toolkits = 17;
* @return A list containing the toolkits.
*/
java.util.List
getToolkitsList();
/**
*
* List of toolkit tags to filter by
*
*
* repeated string toolkits = 17;
* @return The count of toolkits.
*/
int getToolkitsCount();
/**
*
* List of toolkit tags to filter by
*
*
* repeated string toolkits = 17;
* @param index The index of the element to return.
* @return The toolkits at the given index.
*/
java.lang.String getToolkits(int index);
/**
*
* List of toolkit tags to filter by
*
*
* repeated string toolkits = 17;
* @param index The index of the value to return.
* @return The bytes of the toolkits at the given index.
*/
com.google.protobuf.ByteString
getToolkitsBytes(int index);
/**
*
* List of use_case tags to filter by
*
*
* repeated string use_cases = 18;
* @return A list containing the useCases.
*/
java.util.List
getUseCasesList();
/**
*
* List of use_case tags to filter by
*
*
* repeated string use_cases = 18;
* @return The count of useCases.
*/
int getUseCasesCount();
/**
*
* List of use_case tags to filter by
*
*
* repeated string use_cases = 18;
* @param index The index of the element to return.
* @return The useCases at the given index.
*/
java.lang.String getUseCases(int index);
/**
*
* List of use_case tags to filter by
*
*
* repeated string use_cases = 18;
* @param index The index of the value to return.
* @return The bytes of the useCases at the given index.
*/
com.google.protobuf.ByteString
getUseCasesBytes(int index);
/**
*
* List of language tags to filter by
*
*
* repeated string languages = 21;
* @return A list containing the languages.
*/
java.util.List
getLanguagesList();
/**
*
* List of language tags to filter by
*
*
* repeated string languages = 21;
* @return The count of languages.
*/
int getLanguagesCount();
/**
*
* List of language tags to filter by
*
*
* repeated string languages = 21;
* @param index The index of the element to return.
* @return The languages at the given index.
*/
java.lang.String getLanguages(int index);
/**
*
* List of language tags to filter by
*
*
* repeated string languages = 21;
* @param index The index of the value to return.
* @return The bytes of the languages at the given index.
*/
com.google.protobuf.ByteString
getLanguagesBytes(int index);
/**
*
* (optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs
*
*
* repeated string additional_fields = 19;
* @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, outputs
*
*
* repeated string additional_fields = 19;
* @return The count of additionalFields.
*/
int getAdditionalFieldsCount();
/**
*
* (optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs
*
*
* repeated string additional_fields = 19;
* @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, outputs
*
*
* repeated string additional_fields = 19;
* @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);
public com.clarifai.grpc.api.ListModelsRequest.SortByCase getSortByCase();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy