| Package | Description |
|---|---|
| com.algolia.search | |
| com.algolia.search.http | |
| com.algolia.search.iterators | |
| com.algolia.search.objects | |
| com.algolia.search.objects.tasks.sync |
| Modifier and Type | Method and Description |
|---|---|
CompletableFuture<CreateUpdateKey> |
AsyncAPIClient.addApiKey(ApiKey key,
RequestOptions requestOptions)
Create a new key
|
default CompletableFuture<CreateUpdateKey> |
AsyncKey.addApiKey(ApiKey key,
RequestOptions requestOptions)
Deprecated.
|
default CreateUpdateKey |
SyncKey.addApiKey(ApiKey key,
RequestOptions requestOptions)
Deprecated.
|
CreateUpdateKey |
APIClient.addApiKey(ApiKey key,
RequestOptions requestOptions)
Create a new key
|
default TaskIndexing |
SyncObjects.addObject(String objectID,
T object,
RequestOptions requestOptions)
Add an object in this index with a unique identifier
|
default CompletableFuture<AsyncTaskIndexing> |
AsyncObjects.addObject(String objectID,
T object,
RequestOptions requestOptions)
Add an object in this index with a unique identifier
|
default TaskIndexing |
SyncObjects.addObject(T object,
RequestOptions requestOptions)
Add an object in this index
|
default CompletableFuture<AsyncTaskIndexing> |
AsyncObjects.addObject(T object,
RequestOptions requestOptions)
Add an object in this index
|
default TaskSingleIndex |
SyncObjects.addObjects(List<T> objects,
RequestOptions requestOptions)
Add several objects
|
default CompletableFuture<AsyncTaskSingleIndex> |
AsyncObjects.addObjects(List<T> objects,
RequestOptions requestOptions)
Add several objects
|
CompletableFuture<AssignUserID> |
AsyncAPIClient.assignUserID(String userID,
String clusterName,
RequestOptions requestOptions) |
AssignUserID |
APIClient.assignUserID(String userID,
String clusterName,
RequestOptions requestOptions) |
CompletableFuture<AsyncTasksMultipleIndex> |
AsyncAPIClient.batch(List<BatchOperation> operations,
RequestOptions requestOptions)
Custom batch
|
CompletableFuture<AsyncTaskSingleIndex> |
AsyncIndex.batch(List<BatchOperation> operations,
RequestOptions requestOptions)
Custom batch
|
TaskSingleIndex |
Index.batch(List<BatchOperation> operations,
RequestOptions requestOptions)
Custom batch
|
TasksMultipleIndex |
APIClient.batch(List<BatchOperation> operations,
RequestOptions requestOptions)
Custom batch
|
default CompletableFuture<AsyncTask> |
AsyncRules.batchRules(List<Rule> rules,
boolean forwardToReplicas,
boolean clearExistingRules,
RequestOptions requestOptions)
Add or replace a list of Rules
|
default Task |
SyncRules.batchRules(List<Rule> rules,
boolean forwardToReplicas,
boolean clearExistingRules,
RequestOptions requestOptions)
Add or replace a list of query Rules
|
default CompletableFuture<AsyncTask> |
AsyncRules.batchRules(List<Rule> rules,
boolean forwardToReplicas,
RequestOptions requestOptions)
Add or Replace a list of Rules, no replacement
|
default Task |
SyncRules.batchRules(List<Rule> rules,
boolean forwardToReplicas,
RequestOptions requestOptions)
Add or replace a list of Rules, no replacement
|
default CompletableFuture<AsyncTask> |
AsyncRules.batchRules(List<Rule> rules,
RequestOptions requestOptions)
Add or Replace a list of Rules, no forward to replicas, and no replacement
|
default Task |
SyncRules.batchRules(List<Rule> rules,
RequestOptions requestOptions)
Add or replace a list of Rules, no forward to replicas, and no replacement
|
default CompletableFuture<AsyncTask> |
AsyncSynonyms.batchSynonyms(List<AbstractSynonym> synonyms,
boolean forwardToReplicas,
boolean replaceExistingSynonyms,
RequestOptions requestOptions)
Add or Replace a list of synonyms
|
default Task |
SyncSynonyms.batchSynonyms(List<AbstractSynonym> synonyms,
boolean forwardToReplicas,
boolean replaceExistingSynonyms,
RequestOptions requestOptions)
Add or Replace a list of synonyms
|
default CompletableFuture<AsyncTask> |
AsyncSynonyms.batchSynonyms(List<AbstractSynonym> synonyms,
boolean forwardToReplicas,
RequestOptions requestOptions)
Add or Replace a list of synonyms, no replacement
|
default Task |
SyncSynonyms.batchSynonyms(List<AbstractSynonym> synonyms,
boolean forwardToReplicas,
RequestOptions requestOptions)
Add or Replace a list of synonyms, no replacement
|
default CompletableFuture<AsyncTask> |
AsyncSynonyms.batchSynonyms(List<AbstractSynonym> synonyms,
RequestOptions requestOptions)
Add or Replace a list of synonyms, no forward to slaves, and no replacement
|
default Task |
SyncSynonyms.batchSynonyms(List<AbstractSynonym> synonyms,
RequestOptions requestOptions)
Add or Replace a list of synonyms, no forward to slaves, and no replacement
|
default IndexIterable<T> |
SyncBrowse.browse(Query query,
RequestOptions requestOptions)
Browse all the content of this index
|
<T> BrowseResult<T> |
APIClient.browse(String indexName,
Query query,
String cursor,
Class<T> klass,
RequestOptions requestOptions) |
default BrowseResult<T> |
SyncBrowse.browseFrom(Query query,
String cursor,
RequestOptions requestOptions)
Browse all the content of this index
|
default CompletableFuture<AsyncTask> |
AsyncIndexCRUD.clear(RequestOptions requestOptions)
Delete the index content without removing settings and index specific API keys.
|
default Task |
SyncIndexCRUD.clear(RequestOptions requestOptions)
Delete the index content without removing settings and index specific API keys.
|
default CompletableFuture<AsyncTask> |
AsyncRules.clearRules(boolean forwardToReplicas,
RequestOptions requestOptions)
Clears all Rules
|
default Task |
SyncRules.clearRules(boolean forwardToReplicas,
RequestOptions requestOptions)
Clears all Rules
|
default CompletableFuture<AsyncTask> |
AsyncRules.clearRules(RequestOptions requestOptions)
Clear all Rules and NOT forwarding it to the replicas
|
default Task |
SyncRules.clearRules(RequestOptions requestOptions)
Clear all query Rules and NOT forwarding it to the replicas
|
default CompletableFuture<AsyncTask> |
AsyncSynonyms.clearSynonyms(boolean forwardToReplicas,
RequestOptions requestOptions)
Clears all synonyms
|
default Task |
SyncSynonyms.clearSynonyms(boolean forwardToReplicas,
RequestOptions requestOptions)
Clears all synonyms
|
default CompletableFuture<AsyncTask> |
AsyncSynonyms.clearSynonyms(RequestOptions requestOptions)
Clear all synonyms and NOT forwarding it to the slaves
|
default Task |
SyncSynonyms.clearSynonyms(RequestOptions requestOptions)
Clear all synonyms and NOT forwarding it to the replicas
|
CompletableFuture<AsyncTask> |
AsyncAPIClient.copyIndex(String srcIndexName,
String dstIndexName,
List<String> scope,
RequestOptions requestOptions)
Copy an existing index
|
Task |
APIClient.copyIndex(String srcIndexName,
String dstIndexName,
List<String> scope,
RequestOptions requestOptions)
Copy an existing index
|
CompletableFuture<AsyncTask> |
AsyncAPIClient.copyIndex(String srcIndexName,
String dstIndexName,
RequestOptions requestOptions)
Copy an existing index
|
Task |
APIClient.copyIndex(String srcIndexName,
String dstIndexName,
RequestOptions requestOptions)
Copy an existing index
|
default CompletableFuture<AsyncTask> |
AsyncIndexCRUD.copyTo(String dstIndexName,
List<String> scope,
RequestOptions requestOptions)
Copy an existing index
|
default Task |
SyncIndexCRUD.copyTo(String dstIndexName,
List<String> scope,
RequestOptions requestOptions)
Copy an existing index
|
default CompletableFuture<AsyncTask> |
AsyncIndexCRUD.copyTo(String dstIndexName,
RequestOptions requestOptions)
Copy an existing index
|
default Task |
SyncIndexCRUD.copyTo(String dstIndexName,
RequestOptions requestOptions)
Copy an existing index
|
default CompletableFuture<AsyncTask> |
AsyncIndexCRUD.delete(RequestOptions requestOptions)
Deletes the index
|
default Task |
SyncIndexCRUD.delete(RequestOptions requestOptions)
Deletes the index
|
CompletableFuture<DeleteKey> |
AsyncAPIClient.deleteApiKey(String key,
RequestOptions requestOptions)
Delete an existing key
|
default CompletableFuture<DeleteKey> |
AsyncKey.deleteApiKey(String key,
RequestOptions requestOptions)
Deprecated.
|
default DeleteKey |
SyncKey.deleteApiKey(String key,
RequestOptions requestOptions)
Deprecated.
|
DeleteKey |
APIClient.deleteApiKey(String key,
RequestOptions requestOptions)
Delete an existing key
|
default Task |
SyncDeleteByQuery.deleteBy(Query query,
RequestOptions requestOptions)
Delete records matching a query
|
default CompletableFuture<AsyncTask> |
AsyncDeleteByQuery.deleteBy(Query query,
RequestOptions requestOptions)
Delete records matching a query Deprecated, use deleteBy
|
default void |
SyncDeleteByQuery.deleteByQuery(Query query,
int batchSize,
RequestOptions requestOptions)
Deprecated.
|
default void |
SyncDeleteByQuery.deleteByQuery(Query query,
RequestOptions requestOptions)
Deprecated.
|
CompletableFuture<AsyncTask> |
AsyncAPIClient.deleteIndex(String indexName,
RequestOptions requestOptions)
Delete an existing index
|
Task |
APIClient.deleteIndex(String indexName,
RequestOptions requestOptions)
Delete an existing index
|
default Task |
SyncObjects.deleteObject(String objectID,
RequestOptions requestOptions)
Delete an object from the index
|
default CompletableFuture<AsyncTask> |
AsyncObjects.deleteObject(String objectID,
RequestOptions requestOptions)
Delete an object from the index
|
default TaskSingleIndex |
SyncObjects.deleteObjects(List<String> objectIDs,
RequestOptions requestOptions)
Delete objects from the index
|
default CompletableFuture<AsyncTaskSingleIndex> |
AsyncObjects.deleteObjects(List<String> objectIDs,
RequestOptions requestOptions)
Delete objects from the index
|
default CompletableFuture<AsyncTask> |
AsyncRules.deleteRule(String ruleID,
boolean forwardToReplicas,
RequestOptions requestOptions)
Deletes a rule
|
default Task |
SyncRules.deleteRule(String ruleId,
boolean forwardToReplicas,
RequestOptions requestOptions)
Deletes a query rule
|
default CompletableFuture<AsyncTask> |
AsyncRules.deleteRule(String ruleID,
RequestOptions requestOptions)
Deletes a rule by ID and NOT forwarding it to the replicas
|
default Task |
SyncRules.deleteRule(String ruleId,
RequestOptions requestOptions)
Deletes a query rule by ID and NOT forwarding it to the replicas
|
default CompletableFuture<AsyncTask> |
AsyncSynonyms.deleteSynonym(String synonymID,
boolean forwardToReplicas,
RequestOptions requestOptions)
Deletes a synonym
|
default Task |
SyncSynonyms.deleteSynonym(String synonymID,
boolean forwardToReplicas,
RequestOptions requestOptions)
Deletes a synonym
|
default CompletableFuture<AsyncTask> |
AsyncSynonyms.deleteSynonym(String synonymID,
RequestOptions requestOptions)
Deletes a synonym by ID and NOT forwarding it to the slaves
|
default Task |
SyncSynonyms.deleteSynonym(String synonymID,
RequestOptions requestOptions)
Deletes a synonym by ID and NOT forwarding it to the replicas
|
CompletableFuture<Optional<ApiKey>> |
AsyncAPIClient.getApiKey(String key,
RequestOptions requestOptions)
Get an Key from it's name
|
default CompletableFuture<Optional<ApiKey>> |
AsyncKey.getApiKey(String key,
RequestOptions requestOptions)
Deprecated.
|
default Optional<ApiKey> |
SyncKey.getApiKey(String key,
RequestOptions requestOptions)
Deprecated.
|
Optional<ApiKey> |
APIClient.getApiKey(String key,
RequestOptions requestOptions)
Get a Key from its name
|
CompletableFuture<List<Log>> |
AsyncAPIClient.getLogs(Integer offset,
Integer length,
LogType logType,
RequestOptions requestOptions)
Return last logs entries
|
List<Log> |
APIClient.getLogs(Integer offset,
Integer length,
LogType logType,
RequestOptions requestOptions)
Return last logs entries
|
CompletableFuture<List<Log>> |
AsyncAPIClient.getLogs(RequestOptions requestOptions)
Return 10 last log entries.
|
List<Log> |
APIClient.getLogs(RequestOptions requestOptions)
Return 10 last log entries.
|
default Optional<T> |
SyncObjects.getObject(String objectID,
RequestOptions requestOptions)
Get an object from this index
|
default CompletableFuture<Optional<T>> |
AsyncObjects.getObject(String objectID,
RequestOptions requestOptions)
Get an object from this index
|
default List<T> |
SyncObjects.getObjects(List<String> objectIDs,
List<String> attributesToRetrieve,
RequestOptions requestOptions)
Get several objects from this index
|
default CompletableFuture<List<T>> |
AsyncObjects.getObjects(List<String> objectIDs,
List<String> attributesToRetrieve,
RequestOptions requestOptions)
Get several objects from this index
|
default List<T> |
SyncObjects.getObjects(List<String> objectIDs,
RequestOptions requestOptions)
Get several objects from this index
|
default CompletableFuture<List<T>> |
AsyncObjects.getObjects(List<String> objectIDs,
RequestOptions requestOptions)
Get several objects from this index
|
default CompletableFuture<Optional<Rule>> |
AsyncRules.getRule(String ruleID,
RequestOptions requestOptions)
Get a rule by ID
|
default Optional<Rule> |
SyncRules.getRule(String ruleId,
RequestOptions requestOptions)
Get a rule by Id
|
default IndexSettings |
SyncSettings.getSettings(RequestOptions requestOptions)
Get settings of this index
|
default CompletableFuture<IndexSettings> |
AsyncSettings.getSettings(RequestOptions requestOptions)
Get settings of this index
|
default CompletableFuture<Optional<AbstractSynonym>> |
AsyncSynonyms.getSynonym(String synonymID,
RequestOptions requestOptions)
Get a synonym by ID
|
default Optional<AbstractSynonym> |
SyncSynonyms.getSynonym(String synonymID,
RequestOptions requestOptions)
Get a synonym by ID
|
CompletableFuture<Map<String,List<UserID>>> |
AsyncAPIClient.getTopUserID(RequestOptions requestOptions) |
Map<String,List<UserID>> |
APIClient.getTopUserID(RequestOptions requestOptions) |
CompletableFuture<UserID> |
AsyncAPIClient.getUserID(String userID,
RequestOptions requestOptions) |
UserID |
APIClient.getUserID(String userID,
RequestOptions requestOptions) |
CompletableFuture<List<ApiKey>> |
AsyncAPIClient.listApiKeys(RequestOptions requestOptions)
List all existing user keys with their associated ACLs
|
default CompletableFuture<List<ApiKey>> |
AsyncKey.listApiKeys(RequestOptions requestOptions)
Deprecated.
|
default List<ApiKey> |
SyncKey.listApiKeys(RequestOptions requestOptions)
Deprecated.
|
List<ApiKey> |
APIClient.listApiKeys(RequestOptions requestOptions)
List all existing user keys with their associated ACLs
|
CompletableFuture<List<Cluster>> |
AsyncAPIClient.listClusters(RequestOptions requestOptions) |
List<Cluster> |
APIClient.listClusters(RequestOptions requestOptions) |
List<Index.Attributes> |
APIClient.listIndexes(RequestOptions requestOptions)
List all existing indexes
|
CompletableFuture<List<Index.Attributes>> |
AsyncAPIClient.listIndices(RequestOptions requestOptions)
List all existing indexes
|
List<Index.Attributes> |
APIClient.listIndices(RequestOptions requestOptions)
Deprecated.
|
CompletableFuture<UserIDs> |
AsyncAPIClient.listUserIDs(Integer page,
Integer hitsPerPage,
RequestOptions requestOptions) |
UserIDs |
APIClient.listUserIDs(Integer page,
Integer hitsPerPage,
RequestOptions requestOptions) |
CompletableFuture<AsyncTask> |
AsyncAPIClient.moveIndex(String srcIndexName,
String dstIndexName,
RequestOptions requestOptions)
Moves an existing index
|
Task |
APIClient.moveIndex(String srcIndexName,
String dstIndexName,
RequestOptions requestOptions)
Moves an existing index
|
default CompletableFuture<AsyncTask> |
AsyncIndexCRUD.moveTo(String dstIndexName,
RequestOptions requestOptions)
Moves an existing index
|
default Task |
SyncIndexCRUD.moveTo(String dstIndexName,
RequestOptions requestOptions)
Moves an existing index
|
CompletableFuture<MultiQueriesResult> |
AsyncAPIClient.multipleQueries(List<IndexQuery> queries,
MultiQueriesStrategy strategy,
RequestOptions requestOptions)
Performs multiple searches on multiple indices
|
MultiQueriesResult |
APIClient.multipleQueries(List<IndexQuery> queries,
MultiQueriesStrategy strategy,
RequestOptions requestOptions)
Performs multiple searches on multiple indices
|
CompletableFuture<MultiQueriesResult> |
AsyncAPIClient.multipleQueries(List<IndexQuery> queries,
RequestOptions requestOptions)
Performs multiple searches on multiple indices with the strategy
MultiQueriesStrategy.NONE |
MultiQueriesResult |
APIClient.multipleQueries(List<IndexQuery> queries,
RequestOptions requestOptions)
Performs multiple searches on multiple indices with the strategy
MultiQueriesStrategy.NONE |
default CompletableFuture<AsyncTaskSingleIndex> |
AsyncPartialUpdate.partialUpdateObject(PartialUpdateOperation operation,
boolean createIfNotExists,
RequestOptions requestOptions)
Partially update an object
|
default TaskSingleIndex |
SyncPartialUpdate.partialUpdateObject(PartialUpdateOperation operation,
boolean createIfNotExists,
RequestOptions requestOptions)
Partially update an object
|
default CompletableFuture<AsyncTaskSingleIndex> |
AsyncPartialUpdate.partialUpdateObject(PartialUpdateOperation operation,
RequestOptions requestOptions)
Partially update an object, create the object if it does not exist
|
default TaskSingleIndex |
SyncPartialUpdate.partialUpdateObject(PartialUpdateOperation operation,
RequestOptions requestOptions)
Partially update an object, create the object if it does not exist
|
default CompletableFuture<AsyncTaskSingleIndex> |
AsyncPartialUpdate.partialUpdateObject(String objectID,
Object object,
RequestOptions requestOptions)
Partially update an object
|
default TaskSingleIndex |
SyncPartialUpdate.partialUpdateObject(String objectID,
Object object,
RequestOptions requestOptions)
Partially update an object
|
default CompletableFuture<AsyncTaskSingleIndex> |
AsyncPartialUpdate.partialUpdateObjects(List<Object> objects,
boolean createIfNotExists,
RequestOptions requestOptions)
Partially update a objects
|
default TaskSingleIndex |
SyncPartialUpdate.partialUpdateObjects(List<Object> objects,
boolean createIfNotExists,
RequestOptions requestOptions)
Partially update a objects
|
default CompletableFuture<AsyncTaskSingleIndex> |
AsyncPartialUpdate.partialUpdateObjects(List<Object> objects,
RequestOptions requestOptions)
Partially update a objects
|
default TaskSingleIndex |
SyncPartialUpdate.partialUpdateObjects(List<Object> objects,
RequestOptions requestOptions)
Partially update a objects
|
CompletableFuture<DeleteUserID> |
AsyncAPIClient.removeUserID(String userID,
RequestOptions requestOptions) |
DeleteUserID |
APIClient.removeUserID(String userID,
RequestOptions requestOptions) |
default Task |
SyncObjects.saveObject(String objectID,
T object,
RequestOptions requestOptions)
Override the content of object
|
default CompletableFuture<AsyncTask> |
AsyncObjects.saveObject(String objectID,
T object,
RequestOptions requestOptions)
Override the content of object
|
default TaskSingleIndex |
SyncObjects.saveObjects(List<T> objects,
RequestOptions requestOptions)
Override the content the list of objects
|
default CompletableFuture<AsyncTaskSingleIndex> |
AsyncObjects.saveObjects(List<T> objects,
RequestOptions requestOptions)
Override the content the list of objects
|
default CompletableFuture<AsyncTask> |
AsyncRules.saveRule(String ruleID,
Rule rule,
boolean forwardToReplicas,
RequestOptions requestOptions)
Saves/updates a rule
|
default Task |
SyncRules.saveRule(String queryRuleID,
Rule content,
boolean forwardToReplicas,
RequestOptions requestOptions)
Saves/updates a queryRule without replacing
|
default CompletableFuture<AsyncTask> |
AsyncRules.saveRule(String ruleID,
Rule rule,
RequestOptions requestOptions)
Saves/updates a rule without replacing it and NOT forwarding it to the replicas
|
default Task |
SyncRules.saveRule(String queryRuleID,
Rule content,
RequestOptions requestOptions)
Saves/updates a query rule without replacing it and NOT forwarding it to the replicas
|
default CompletableFuture<AsyncTask> |
AsyncSynonyms.saveSynonym(String synonymID,
AbstractSynonym content,
boolean forwardToReplicas,
RequestOptions requestOptions)
Saves/updates a synonym without replacing
|
default Task |
SyncSynonyms.saveSynonym(String synonymID,
AbstractSynonym content,
boolean forwardToReplicas,
RequestOptions requestOptions)
Saves/updates a synonym without replacing
|
default CompletableFuture<AsyncTask> |
AsyncSynonyms.saveSynonym(String synonymID,
AbstractSynonym content,
RequestOptions requestOptions)
Saves/updates a synonym without replacing it and NOT forwarding it to the slaves
|
default Task |
SyncSynonyms.saveSynonym(String synonymID,
AbstractSynonym content,
RequestOptions requestOptions)
Saves/updates a synonym without replacing it and NOT forwarding it to the slaves
|
CompletableFuture<SearchResult<T>> |
AsyncIndex.search(Query query,
RequestOptions requestOptions)
Search in the index
|
SearchResult<T> |
Index.search(Query query,
RequestOptions requestOptions)
Search in the index throws a
AlgoliaIndexNotFoundException if the index does not exists |
default CompletableFuture<SearchFacetResult> |
AsyncSearchForFacet.searchForFacetValues(String facetName,
String facetQuery,
Query query,
RequestOptions requestOptions)
Search in a facet
|
default SearchFacetResult |
SyncSearchForFacet.searchForFacetValues(String facetName,
String facetQuery,
Query query,
RequestOptions requestOptions)
Search in a facet throws a
AlgoliaIndexNotFoundException
if the index does not exists |
default CompletableFuture<SearchFacetResult> |
AsyncSearchForFacet.searchForFacetValues(String facetName,
String facetQuery,
RequestOptions requestOptions)
Search in a facet
|
default SearchFacetResult |
SyncSearchForFacet.searchForFacetValues(String facetName,
String facetQuery,
RequestOptions requestOptions)
Search in a facet throws a
AlgoliaIndexNotFoundException
if the index does not exists |
default CompletableFuture<SearchRuleResult> |
AsyncRules.searchRules(RuleQuery query,
RequestOptions requestOptions)
Search for Rules
|
default SearchRuleResult |
SyncRules.searchRules(RuleQuery query,
RequestOptions requestOptions)
Search for Rules
|
default CompletableFuture<SearchSynonymResult> |
AsyncSynonyms.searchSynonyms(SynonymQuery query,
RequestOptions requestOptions)
Search for synonyms
|
default SearchSynonymResult |
SyncSynonyms.searchSynonyms(SynonymQuery query,
RequestOptions requestOptions)
Search for synonyms
|
CompletableFuture<SearchUserIDs> |
AsyncAPIClient.searchUserIDs(String query,
String clusterName,
int page,
int hitsPerPage,
RequestOptions requestOptions) |
SearchUserIDs |
APIClient.searchUserIDs(String query,
String clusterName,
int page,
int hitsPerPage,
RequestOptions requestOptions) |
CompletableFuture<SearchUserIDs> |
AsyncAPIClient.searchUserIDs(String query,
String clusterName,
RequestOptions requestOptions) |
SearchUserIDs |
APIClient.searchUserIDs(String query,
String clusterName,
RequestOptions requestOptions) |
default Task |
SyncSettings.setSettings(IndexSettings settings,
Boolean forwardToReplicas,
RequestOptions requestOptions)
Set settings of this index
|
default CompletableFuture<AsyncTask> |
AsyncSettings.setSettings(IndexSettings settings,
Boolean forwardToReplicas,
RequestOptions requestOptions)
Set settings of this index
|
default Task |
SyncSettings.setSettings(IndexSettings settings,
RequestOptions requestOptions)
Set settings of this index, and do not forward to slaves
|
default CompletableFuture<AsyncTask> |
AsyncSettings.setSettings(IndexSettings settings,
RequestOptions requestOptions)
Set settings of this index, and do not forward to slaves
|
CompletableFuture<CreateUpdateKey> |
AsyncAPIClient.updateApiKey(String keyName,
ApiKey key,
RequestOptions requestOptions)
Update a key
|
default CompletableFuture<CreateUpdateKey> |
AsyncKey.updateApiKey(String keyName,
ApiKey key,
RequestOptions requestOptions)
Deprecated.
|
default CreateUpdateKey |
SyncKey.updateApiKey(String keyName,
ApiKey key,
RequestOptions requestOptions)
Deprecated.
|
CreateUpdateKey |
APIClient.updateApiKey(String keyName,
ApiKey key,
RequestOptions requestOptions)
Update a key
|
default CreateUpdateKey |
SyncKey.updateKey(String keyName,
ApiKey key,
RequestOptions requestOptions)
Deprecated.
|
<T> void |
AsyncAPIClient.waitTask(AsyncGenericTask<T> task,
long timeToWait,
RequestOptions requestOptions)
Wait for the completion of this task /!\ WARNING /!\ This method is blocking
|
default void |
AsyncTasks.waitTask(AsyncTask task,
long timeToWait,
RequestOptions requestOptions)
Wait for the completion of a task
|
default void |
AsyncTasks.waitTask(AsyncTask task,
RequestOptions requestOptions)
Wait for the completion of a task, for 100ms
|
<T> void |
APIClient.waitTask(GenericTask<T> task,
long timeToWait,
RequestOptions requestOptions)
Wait for the completion of this task
|
default void |
SyncTasks.waitTask(Long taskID,
RequestOptions requestOptions)
Wait for the completion of a task, for 100ms
|
default void |
SyncTasks.waitTask(Task task,
long timeToWait,
RequestOptions requestOptions)
Wait for the completion of a task
|
default void |
SyncTasks.waitTask(Task task,
RequestOptions requestOptions)
Wait for the completion of a task, for 100ms
|
| Constructor and Description |
|---|
AlgoliaRequest(HttpMethod method,
AlgoliaRequestKind kind,
List<String> path,
RequestOptions options,
Class<T> resultClass) |
AlgoliaRequest(HttpMethod method,
AlgoliaRequestKind kind,
List<String> path,
RequestOptions options,
Class<T> collectionClass,
Class<?> elementClass) |
| Constructor and Description |
|---|
IndexIterable(APIClient apiClient,
String indexName,
Query query,
RequestOptions requestOptions,
Class<T> klass) |
IndexIterable(APIClient apiClient,
String indexName,
Query query,
RequestOptions requestOptions,
String cursor,
Class<T> klass) |
| Modifier and Type | Method and Description |
|---|---|
RequestOptions |
RequestOptions.addExtraHeader(String key,
String value) |
RequestOptions |
RequestOptions.addExtraQueryParameters(String key,
String value) |
RequestOptions |
RequestOptions.setForwardedFor(String forwardedFor) |
| Modifier and Type | Method and Description |
|---|---|
void |
Task.waitForCompletion(long timeToWait,
RequestOptions requestOptions)
Wait for the completion of this task
|
void |
Task.waitForCompletion(RequestOptions requestOptions)
Wait for the completion of this task
|
Copyright © 2018. All rights reserved.