com.clarifai.grpc.api.ListWorkflowsRequestOrBuilder 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 ListWorkflowsRequestOrBuilder extends
// @@protoc_insertion_point(interface_extends:clarifai.api.ListWorkflowsRequest)
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();
/**
*
* (optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars
*
*
* repeated string additional_fields = 10;
* @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
*
*
* repeated string additional_fields = 10;
* @return The count of additionalFields.
*/
int getAdditionalFieldsCount();
/**
*
* (optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars
*
*
* repeated string additional_fields = 10;
* @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
*
*
* repeated string additional_fields = 10;
* @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 options:
* Whether to sort in ascending order. If false, will order in descending order.
*
*
* bool sort_ascending = 5;
* @return The sortAscending.
*/
boolean getSortAscending();
/**
*
* Whether to order by the name
*
*
* bool sort_by_id = 6;
* @return Whether the sortById field is set.
*/
boolean hasSortById();
/**
*
* Whether to order by the name
*
*
* bool sort_by_id = 6;
* @return The sortById.
*/
boolean getSortById();
/**
*
* Whether to order by the modified_at time.
* If none of the sort options is set to true, will sort by modified_at.
*
*
* bool sort_by_modified_at = 7;
* @return Whether the sortByModifiedAt field is set.
*/
boolean hasSortByModifiedAt();
/**
*
* Whether to order by the modified_at time.
* If none of the sort options is set to true, will sort by modified_at.
*
*
* bool sort_by_modified_at = 7;
* @return The sortByModifiedAt.
*/
boolean getSortByModifiedAt();
/**
*
* Whether to order by the created_at time.
*
*
* bool sort_by_created_at = 13;
* @return Whether the sortByCreatedAt field is set.
*/
boolean hasSortByCreatedAt();
/**
*
* Whether to order by the created_at time.
*
*
* bool sort_by_created_at = 13;
* @return The sortByCreatedAt.
*/
boolean getSortByCreatedAt();
/**
*
* Whether to order by the number of users stared the workflow
*
*
* bool sort_by_star_count = 14;
* @return Whether the sortByStarCount field is set.
*/
boolean hasSortByStarCount();
/**
*
* Whether to order by the number of users stared the workflow
*
*
* bool sort_by_star_count = 14;
* @return The sortByStarCount.
*/
boolean getSortByStarCount();
/**
*
* Filtering options:
* If true, we only return workflows that are handpicked by clarifai staff
*
*
* bool featured_only = 9;
* @return The featuredOnly.
*/
boolean getFeaturedOnly();
/**
*
* If true, we only return workflows that are starred by the requesting user
*
*
* bool starred_only = 11;
* @return The starredOnly.
*/
boolean getStarredOnly();
/**
*
* Filter workflows by bookmark. If set, only return bookmarked workflows. Otherwise none bookmarked workflows only.
*
*
* bool bookmark = 15;
* @return The bookmark.
*/
boolean getBookmark();
/**
*
* Searching options:
* Specify a search parameter in order to perform keyword search on the
* following fields of the workflow:
* - id
* - description
* - notes
* - user_id (unless user_app_id.user_id is already set)
* Keywords are both normalized for search (so searching for "satisfy" matches "satisfied")
* and used for partial prefix-matching (so searching for "clari" 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 = 16;
* @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 workflow:
* - id
* - description
* - notes
* - user_id (unless user_app_id.user_id is already set)
* Keywords are both normalized for search (so searching for "satisfy" matches "satisfied")
* and used for partial prefix-matching (so searching for "clari" 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 = 16;
* @return The bytes for search.
*/
com.google.protobuf.ByteString
getSearchBytes();
/**
*
* Query various text fields (id, description and notes) that can contain the words in the query string.
* Deprecated: use search instead.
*
*
* string query = 8 [deprecated = true];
* @deprecated clarifai.api.ListWorkflowsRequest.query is deprecated.
* See proto/clarifai/api/service.proto;l=6526
* @return The query.
*/
@java.lang.Deprecated java.lang.String getQuery();
/**
*
* Query various text fields (id, description and notes) that can contain the words in the query string.
* Deprecated: use search instead.
*
*
* string query = 8 [deprecated = true];
* @deprecated clarifai.api.ListWorkflowsRequest.query is deprecated.
* See proto/clarifai/api/service.proto;l=6526
* @return The bytes for query.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getQueryBytes();
/**
*
* Filter by the id of the workflow. This supports wilcard queries like "gen*" to match "general" as an example.
* Deprecated: use search instead.
*
*
* string id = 4 [deprecated = true];
* @deprecated clarifai.api.ListWorkflowsRequest.id is deprecated.
* See proto/clarifai/api/service.proto;l=6529
* @return The id.
*/
@java.lang.Deprecated java.lang.String getId();
/**
*
* Filter by the id of the workflow. This supports wilcard queries like "gen*" to match "general" as an example.
* Deprecated: use search instead.
*
*
* string id = 4 [deprecated = true];
* @deprecated clarifai.api.ListWorkflowsRequest.id is deprecated.
* See proto/clarifai/api/service.proto;l=6529
* @return The bytes for id.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getIdBytes();
/**
*
* Full text and prefix matching on id, owner id, description and notes. Searchable fields may be added
* Deprecated: use search instead.
*
*
* string search_term = 12 [deprecated = true];
* @deprecated clarifai.api.ListWorkflowsRequest.search_term is deprecated.
* See proto/clarifai/api/service.proto;l=6532
* @return The searchTerm.
*/
@java.lang.Deprecated java.lang.String getSearchTerm();
/**
*
* Full text and prefix matching on id, owner id, description and notes. Searchable fields may be added
* Deprecated: use search instead.
*
*
* string search_term = 12 [deprecated = true];
* @deprecated clarifai.api.ListWorkflowsRequest.search_term is deprecated.
* See proto/clarifai/api/service.proto;l=6532
* @return The bytes for searchTerm.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getSearchTermBytes();
public com.clarifai.grpc.api.ListWorkflowsRequest.SortByCase getSortByCase();
}