| Package | Description |
|---|---|
| com.algolia.search | |
| com.algolia.search.iterators | |
| com.algolia.search.models |
| Modifier and Type | Method and Description |
|---|---|
AddABTestResponse |
AnalyticsClient.addABTest(ABTest abTest,
RequestOptions requestOptions)
Creates a new AB Test with provided configuration
|
CompletableFuture<AddABTestResponse> |
AnalyticsClient.addABTestAsync(ABTest abTest,
RequestOptions requestOptions)
Creates a new AB Test with provided configuration
|
default AddApiKeyResponse |
SearchClientAPIKeys.addApiKey(ApiKey acl,
RequestOptions requestOptions)
Add a new API Key with specific permissions/restrictions
|
default CompletableFuture<AddApiKeyResponse> |
SearchClientAPIKeys.addApiKeyAsync(ApiKey acl,
RequestOptions requestOptions)
Add a new API Key with specific permissions/restrictions
|
default AssignUserIdResponse |
SearchClientMcm.assignUserID(String userId,
String clusterName,
RequestOptions requestOptions)
Assign or Move a userID to a cluster.
|
default CompletableFuture<AssignUserIdResponse> |
SearchClientMcm.assignUserIDAsync(String userId,
String clusterName,
RequestOptions requestOptions)
Assign or Move a userID to a cluster.
|
<E> BatchResponse |
SearchIndex.batch(BatchRequest<E> request,
RequestOptions requestOptions)
Perform several indexing operations in one API call.
|
<E> CompletableFuture<BatchResponse> |
SearchIndex.batchAsync(BatchRequest<E> request,
RequestOptions requestOptions)
Perform several indexing operations in one API call.
|
BrowseIndexResponse<T> |
SearchIndex.browseFrom(BrowseIndexQuery query,
RequestOptions requestOptions)
This method allows you to retrieve all index content It can retrieve up to 1,000 records per
call and supports full text search and filters.
|
CompletableFuture<BrowseIndexResponse<T>> |
SearchIndex.browseFromAsync(BrowseIndexQuery query,
RequestOptions requestOptions)
This method allows you to retrieve all index content It can retrieve up to 1,000 records per
call and supports full text search and filters.
|
default RulesIterable |
SearchIndexRules.browseRules(int hitsPerPage,
RequestOptions requestOptions)
Retrieve an index’s full list of rules using an iterator.
|
default SynonymsIterable |
SearchIndexSynonyms.browseSynonyms(int hitsPerPage,
RequestOptions requestOptions)
Retrieve an index’s complete list of synonyms The list includes all synonyms - whether created
on the dashboard or pushed by the API.
|
DeleteResponse |
SearchIndex.clearObjects(RequestOptions requestOptions)
Clear the records of an index without affecting its settings.
|
CompletableFuture<DeleteResponse> |
SearchIndex.clearObjectsAsync(RequestOptions requestOptions)
Clear the records of an index without affecting its settings.
|
default DeleteResponse |
SearchIndexRules.clearRules(Boolean forwardToReplicas,
RequestOptions requestOptions)
Delete all rules in an index.
|
default DeleteResponse |
SearchIndexRules.clearRules(RequestOptions requestOptions)
Delete all rules in an index.
|
default CompletableFuture<DeleteResponse> |
SearchIndexRules.clearRulesAsync(Boolean forwardToReplicas,
RequestOptions requestOptions)
Delete all rules in an index.
|
default CompletableFuture<DeleteResponse> |
SearchIndexRules.clearRulesAsync(RequestOptions requestOptions)
Delete all rules in an index.
|
default ClearSynonymsResponse |
SearchIndexSynonyms.clearSynonyms(RequestOptions requestOptions)
Remove all synonyms from an index.
|
default CompletableFuture<ClearSynonymsResponse> |
SearchIndexSynonyms.clearSynonymsAsync(RequestOptions requestOptions)
Remove all synonyms from an index.
|
InsightsResult |
UserInsightsClient.clickedFilters(String eventName,
String indexName,
List<String> filters,
RequestOptions requestOptions) |
CompletableFuture<InsightsResult> |
UserInsightsClient.clickedFiltersAsync(String eventName,
String indexName,
List<String> filters,
RequestOptions requestOptions) |
InsightsResult |
UserInsightsClient.clickedObjectIDs(String eventName,
String indexName,
List<String> objectIDs,
RequestOptions requestOptions) |
InsightsResult |
UserInsightsClient.clickedObjectIDsAfterSearch(String eventName,
String indexName,
List<String> objectIDs,
List<Long> positions,
String queryID,
RequestOptions requestOptions) |
CompletableFuture<InsightsResult> |
UserInsightsClient.clickedObjectIDsAfterSearchAsync(String eventName,
String indexName,
List<String> objectIDs,
List<Long> positions,
String queryID,
RequestOptions requestOptions) |
CompletableFuture<InsightsResult> |
UserInsightsClient.clickedObjectIDsAsync(String eventName,
String indexName,
List<String> objectIDs,
RequestOptions requestOptions) |
InsightsResult |
UserInsightsClient.convertedFilters(String eventName,
String indexName,
List<String> filters,
RequestOptions requestOptions) |
CompletableFuture<InsightsResult> |
UserInsightsClient.convertedFiltersAsync(String eventName,
String indexName,
List<String> filters,
RequestOptions requestOptions) |
InsightsResult |
UserInsightsClient.convertedObjectIDs(String eventName,
String indexName,
List<String> objectIDs,
RequestOptions requestOptions) |
InsightsResult |
UserInsightsClient.convertedObjectIDsAfterSearch(String eventName,
String indexName,
List<String> objectIDs,
String queryID,
RequestOptions requestOptions) |
CompletableFuture<InsightsResult> |
UserInsightsClient.convertedObjectIDsAfterSearchAsync(String eventName,
String indexName,
List<String> objectIDs,
String queryID,
RequestOptions requestOptions) |
CompletableFuture<InsightsResult> |
UserInsightsClient.convertedObjectIDsAsync(String eventName,
String indexName,
List<String> objectIDs,
RequestOptions requestOptions) |
static <T> MultiResponse |
AccountClient.copyIndex(SearchIndex<T> sourceIndex,
SearchIndex<T> destinationIndex,
RequestOptions requestOptions)
The method copy settings, synonyms, rules and objects from the source index to the destination
index
|
default CopyResponse |
SearchClientCopyOperations.copyIndex(String sourceIndex,
String destinationIndex,
List<String> scopes,
RequestOptions requestOptions)
Make a copy of an index in the given scope.
|
static <T> CompletableFuture<MultiResponse> |
AccountClient.copyIndexAsync(SearchIndex<T> sourceIndex,
SearchIndex<T> destinationIndex,
RequestOptions requestOptions)
The method copy settings, synonyms, rules and objects from the source index to the destination
index
|
default CompletableFuture<CopyResponse> |
SearchClientCopyOperations.copyIndexAsync(String sourceIndex,
String destinationIndex,
List<String> scopes,
RequestOptions requestOptions)
Make a copy of an index in the given scope.
|
default CopyResponse |
SearchClientCopyOperations.copyRules(String sourceIndex,
String destinationIndex,
RequestOptions requestOptions)
Make a copy of the rules of an index
|
default CompletableFuture<CopyResponse> |
SearchClientCopyOperations.copyRulesAsync(String sourceIndex,
String destinationIndex,
RequestOptions requestOptions)
Make a copy of the rules of an index
|
default CopyResponse |
SearchClientCopyOperations.copySettings(String sourceIndex,
String destinationIndex,
RequestOptions requestOptions)
Make a copy of the settings of an index
|
default CompletableFuture<CopyResponse> |
SearchClientCopyOperations.copySettingsAsync(String sourceIndex,
String destinationIndex,
RequestOptions requestOptions)
Make a copy of the settings of an index
|
default CopyResponse |
SearchClientCopyOperations.copySynonyms(String sourceIndex,
String destinationIndex,
RequestOptions requestOptions)
Make a copy of the synonyms of an index
|
default CompletableFuture<CopyResponse> |
SearchClientCopyOperations.copySynonymsAsync(String sourceIndex,
String destinationIndex,
RequestOptions requestOptions)
Make a copy of the synonyms of an index
|
default <U> U |
SearchClientAdvanced.customRequest(Class<U> returnClazz,
HttpMethod httpMethod,
String path,
CallType callType,
RequestOptions requestOptions)
Executes a custom to the Algolia API under the retry strategy.
|
default <T,U> U |
SearchClientAdvanced.customRequest(T data,
Class<U> returnClazz,
HttpMethod httpMethod,
String path,
CallType callType,
RequestOptions requestOptions)
Executes a custom to the Algolia API under the retry strategy.
|
default <U> CompletableFuture<U> |
SearchClientAdvanced.customRequestAsync(Class<U> returnClazz,
HttpMethod httpMethod,
String path,
CallType callType,
RequestOptions requestOptions)
Executes a custom to the Algolia API under the retry strategy.
|
default <T,U> CompletableFuture<U> |
SearchClientAdvanced.customRequestAsync(T data,
Class<U> returnClazz,
HttpMethod httpMethod,
String path,
CallType callType,
RequestOptions requestOptions)
Executes a custom to the Algolia API under the retry strategy.
|
DeleteResponse |
SearchIndex.delete(RequestOptions requestOptions)
Delete the index and all its settings, including links to its replicas.
|
DeleteAbTestResponse |
AnalyticsClient.deleteABTest(long id,
RequestOptions requestOptions)
Deletes the A/B Test and removes all associated metadata and metrics.
|
CompletableFuture<DeleteAbTestResponse> |
AnalyticsClient.deleteABTestAsync(long id,
RequestOptions requestOptions)
Deletes the A/B Test and removes all associated metadata and metrics.
|
default DeleteApiKeyResponse |
SearchClientAPIKeys.deleteApiKey(String apiKey,
RequestOptions requestOptions)
Delete an existing API Key
|
default CompletableFuture<DeleteApiKeyResponse> |
SearchClientAPIKeys.deleteApiKeyAsync(String apiKey,
RequestOptions requestOptions)
Delete an existing API Key
|
CompletableFuture<DeleteResponse> |
SearchIndex.deleteAsync(RequestOptions requestOptions)
Delete the index and all its settings, including links to its replicas.
|
DeleteResponse |
SearchIndex.deleteBy(Query query,
RequestOptions requestOptions)
Remove all objects matching a filter (including geo filters).
|
CompletableFuture<DeleteResponse> |
SearchIndex.deleteByAsync(Query query,
RequestOptions requestOptions)
Remove all objects matching a filter (including geo filters).
|
DeleteResponse |
SearchIndex.deleteObject(String objectID,
RequestOptions requestOptions)
Remove objects from an index using their object ids.
|
CompletableFuture<DeleteResponse> |
SearchIndex.deleteObjectAsync(String objectID,
RequestOptions requestOptions)
Remove objects from an index using their object ids.
|
BatchIndexingResponse |
SearchIndex.deleteObjects(List<String> objectIDs,
RequestOptions requestOptions)
Remove objects from an index using their object ids.
|
CompletableFuture<BatchIndexingResponse> |
SearchIndex.deleteObjectsAsync(List<String> objectIDs,
RequestOptions requestOptions)
Remove objects from an index using their object ids.
|
default DeleteResponse |
SearchIndexRules.deleteRule(String objectID,
RequestOptions requestOptions)
Delete the rule for the given ruleId
|
default CompletableFuture<DeleteResponse> |
SearchIndexRules.deleteRuleAsync(String objectID,
RequestOptions requestOptions)
Delete the rule for the given ruleId
|
default DeleteResponse |
SearchIndexSynonyms.deleteSynonym(String objectID,
RequestOptions requestOptions)
Remove a single synonym from an index using its object id.
|
default CompletableFuture<DeleteResponse> |
SearchIndexSynonyms.deleteSynonymAsync(String objectID,
RequestOptions requestOptions)
Remove a single synonym from an index using its object id.
|
ABTestResponse |
AnalyticsClient.getABTest(long id,
RequestOptions requestOptions)
Get an A/B test information and results.
|
CompletableFuture<ABTestResponse> |
AnalyticsClient.getABTestAsync(long id,
RequestOptions requestOptions)
Get an A/B test information and results.
|
ABTests |
AnalyticsClient.getABTests(int offset,
int limit,
RequestOptions requestOptions)
Get an A/B test information and results.
|
ABTests |
AnalyticsClient.getABTests(RequestOptions requestOptions)
Get an A/B test information and results.
|
CompletableFuture<ABTests> |
AnalyticsClient.getABTestsAsync(int offset,
int limit,
RequestOptions requestOptions)
Get an A/B test information and results.
|
CompletableFuture<ABTests> |
AnalyticsClient.getABTestsAsync(RequestOptions requestOptions)
Get an A/B test information and results.
|
default ApiKey |
SearchClientAPIKeys.getApiKey(String apiKey,
RequestOptions requestOptions)
Get the permissions of an API Key.
|
default CompletableFuture<ApiKey> |
SearchClientAPIKeys.getApiKeyAsync(String apiKey,
RequestOptions requestOptions)
Get the permissions of an API Key.
|
default List<Log> |
SearchClientAdvanced.getLogs(int offset,
int length,
RequestOptions requestOptions)
Get the logs of the latest search and indexing operations You can retrieve the logs of your
last 1,000 API calls.
|
default List<Log> |
SearchClientAdvanced.getLogs(RequestOptions requestOptions)
Get the logs of the latest search and indexing operations You can retrieve the logs of your
last 1,000 API calls.
|
default CompletableFuture<List<Log>> |
SearchClientAdvanced.getLogsAsync(int offset,
int length,
String logType,
RequestOptions requestOptions)
Get the logs of the latest search and indexing operations You can retrieve the logs of your
last 1,000 API calls.
|
default CompletableFuture<List<Log>> |
SearchClientAdvanced.getLogsAsync(RequestOptions requestOptions)
Get the logs of the latest search and indexing operations You can retrieve the logs of your
last 1,000 API calls.
|
T |
SearchIndex.getObject(String objectID,
List<String> attributesToRetrieve,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
T |
SearchIndex.getObject(String objectID,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
CompletableFuture<T> |
SearchIndex.getObjectAsync(String objectID,
List<String> attributesToRetrieve,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
CompletableFuture<T> |
SearchIndex.getObjectAsync(String objectID,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
List<T> |
SearchIndex.getObjects(List<String> objectIDs,
List<String> attributesToRetrieve,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
List<T> |
SearchIndex.getObjects(List<String> objectIDs,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
CompletableFuture<List<T>> |
SearchIndex.getObjectsAsync(List<String> objectIDs,
List<String> attributesToRetrieve,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
CompletableFuture<List<T>> |
SearchIndex.getObjectsAsync(List<String> objectIDs,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
default GetStrategyResponse |
SearchClientPersonalization.getPersonalizationStrategy(RequestOptions requestOptions)
Returns the personalization strategy of the application
|
default CompletableFuture<GetStrategyResponse> |
SearchClientPersonalization.getPersonalizationStrategyAsync(RequestOptions requestOptions)
Returns the personalization strategy of the application
|
default Rule |
SearchIndexRules.getRule(String objectID,
RequestOptions requestOptions)
Get the specified rule by its objectID
|
default CompletableFuture<Rule> |
SearchIndexRules.getRuleAsync(String objectID,
RequestOptions requestOptions)
Get the specified rule by its objectID
|
default IndexSettings |
SearchIndexSettings.getSettings(RequestOptions requestOptions)
Get the settings of an index.
|
default CompletableFuture<IndexSettings> |
SearchIndexSettings.getSettingsAsync(RequestOptions requestOptions)
Get the settings of an index.
|
default Synonym |
SearchIndexSynonyms.getSynonym(String objectID,
RequestOptions requestOptions)
Get a single synonym using its object id.
|
default CompletableFuture<Synonym> |
SearchIndexSynonyms.getSynonymAsync(String objectID,
RequestOptions requestOptions)
Get a single synonym using its object id.
|
TaskStatusResponse |
SearchIndex.getTask(long taskID,
RequestOptions requestOptions)
Get the status of the given task
|
CompletableFuture<TaskStatusResponse> |
SearchIndex.getTaskAsync(long taskID,
RequestOptions requestOptions)
Get the status of the given task
|
default TopUserIdResponse |
SearchClientMcm.getTopUserID(RequestOptions requestOptions)
Get the top 10 userIDs with the highest number of records per cluster.
|
default CompletableFuture<TopUserIdResponse> |
SearchClientMcm.getTopUserIDAsync(RequestOptions requestOptions)
Get the top 10 userIDs with the highest number of records per cluster.
|
default UserId |
SearchClientMcm.getUserID(String userID,
RequestOptions requestOptions)
Returns the userID data stored in the mapping.
|
default CompletableFuture<UserId> |
SearchClientMcm.getUserIDAsync(String userID,
RequestOptions requestOptions)
Returns the userID data stored in the mapping.
|
default List<ApiKey> |
SearchClientAPIKeys.listApiKeys(RequestOptions requestOptions)
List all existing user keys with their associated ACLs
|
default CompletableFuture<List<ApiKey>> |
SearchClientAPIKeys.listApiKeysAsync(RequestOptions requestOptions)
List asynchronously all existing user keys with their associated ACLs
|
default ListClustersResponse |
SearchClientMcm.listClusters(RequestOptions requestOptions)
List the clusters available in a multi-clusters setup for a single appID
|
default CompletableFuture<ListClustersResponse> |
SearchClientMcm.listClustersAsync(RequestOptions requestOptions)
List the clusters available in a multi-clusters setup for a single appID
|
default List<IndicesResponse> |
SearchClientAdvanced.listIndices(RequestOptions requestOptions)
List all existing indexes
|
default CompletableFuture<List<IndicesResponse>> |
SearchClientAdvanced.listIndicesAsync(RequestOptions requestOptions)
List asynchronously all existing indexes
|
default ListUserIdsResponse |
SearchClientMcm.listUserIDs(int page,
int hitsPerPage,
RequestOptions requestOptions)
List the userIDs assigned to a multi-clusters appID.
|
default ListUserIdsResponse |
SearchClientMcm.listUserIDs(RequestOptions requestOptions)
List the userIDs assigned to a multi-clusters appID.
|
default CompletableFuture<ListUserIdsResponse> |
SearchClientMcm.listUserIDsAsync(int page,
int hitsPerPage,
RequestOptions requestOptions)
List the userIDs assigned to a multi-clusters appID.
|
default CompletableFuture<ListUserIdsResponse> |
SearchClientMcm.listUserIDsAsync(RequestOptions requestOptions)
List the userIDs assigned to a multi-clusters appID.
|
MoveIndexResponse |
SearchIndex.moveFrom(String sourceIndex,
RequestOptions requestOptions)
Rename an index.
|
CompletableFuture<MoveIndexResponse> |
SearchIndex.moveFromAsync(String sourceIndex,
RequestOptions requestOptions)
Rename an index.
|
default MoveIndexResponse |
SearchClientCopyOperations.moveIndex(String sourceIndex,
String destinationIndex,
RequestOptions requestOptions)
Rename an index.
|
default CompletableFuture<MoveIndexResponse> |
SearchClientCopyOperations.moveIndexAsync(String sourceIndex,
String destinationIndex,
RequestOptions requestOptions)
Rename an index.
|
default <T> MultipleIndexBatchIndexingResponse |
SearchClientMultipleOperations.multipleBatch(List<BatchOperation<T>> operations,
RequestOptions requestOptions)
Perform multiple write operations, potentially targeting multiple indices, in a single API
call.
|
default <T> CompletableFuture<MultipleIndexBatchIndexingResponse> |
SearchClientMultipleOperations.multipleBatchAsync(List<BatchOperation<T>> operations,
RequestOptions requestOptions)
Perform multiple write operations, potentially targeting multiple indices, in a single API
call.
|
default <T> MultipleGetObjectsResponse<T> |
SearchClientMultipleOperations.multipleGetObjects(List<MultipleGetObject> queries,
Class<T> clazz,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from different indices, in a single API call.
|
default <T> CompletableFuture<MultipleGetObjectsResponse<T>> |
SearchClientMultipleOperations.multipleGetObjectsAsync(List<MultipleGetObject> queries,
Class<T> clazz,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from different indices, in a single API call.
|
default <T> MultipleQueriesResponse<T> |
SearchClientMultipleOperations.multipleQueries(MultipleQueriesRequest request,
Class<T> clazz,
RequestOptions requestOptions)
This method allows to send multiple search queries, potentially targeting multiple indices, in
a single API call.
|
default <T> CompletableFuture<MultipleQueriesResponse<T>> |
SearchClientMultipleOperations.multipleQueriesAsync(MultipleQueriesRequest request,
Class<T> clazz,
RequestOptions requestOptions)
This method allows to send multiple search queries, potentially targeting multiple indices, in
a single API call.
|
UpdateObjectResponse |
SearchIndex.partialUpdateObject(T data,
Boolean createIfNotExists,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
UpdateObjectResponse |
SearchIndex.partialUpdateObject(T data,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
CompletableFuture<UpdateObjectResponse> |
SearchIndex.partialUpdateObjectAsync(T data,
Boolean createIfNotExists,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
CompletableFuture<UpdateObjectResponse> |
SearchIndex.partialUpdateObjectAsync(T data,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
BatchIndexingResponse |
SearchIndex.partialUpdateObjects(Iterable<T> data,
boolean createIfNotExists,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
BatchIndexingResponse |
SearchIndex.partialUpdateObjects(Iterable<T> data,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
CompletableFuture<BatchIndexingResponse> |
SearchIndex.partialUpdateObjectsAsync(Iterable<T> data,
boolean createIfNotExists,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
CompletableFuture<BatchIndexingResponse> |
SearchIndex.partialUpdateObjectsAsync(Iterable<T> data,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
default RemoveUserIdResponse |
SearchClientMcm.removeUserID(String userId,
RequestOptions requestOptions)
Remove a userID and its associated data from the multi-clusters.
|
default CompletableFuture<RemoveUserIdResponse> |
SearchClientMcm.removeUserIDAsync(String userId,
RequestOptions requestOptions)
Remove a userID and its associated data from the multi-clusters.
|
MultiResponse |
SearchIndex.replaceAllObjects(Iterable<T> data,
RequestOptions requestOptions,
boolean safe)
Push a new set of objects and remove all previous ones.
|
CompletableFuture<MultiResponse> |
SearchIndex.replaceAllObjectsAsync(Iterable<T> data,
RequestOptions requestOptions,
boolean safe)
Push a new set of objects and remove all previous ones.
|
default SaveRuleResponse |
SearchIndexRules.replaceAllRules(Iterable<Rule> rules,
RequestOptions requestOptions)
Push a new set of rules and erase all previous ones.
|
default CompletableFuture<SaveRuleResponse> |
SearchIndexRules.replaceAllRulesAsync(Iterable<Rule> rules,
RequestOptions requestOptions)
Push a new set of rules and erase all previous ones.
|
default SaveSynonymResponse |
SearchIndexSynonyms.replaceAllSynonyms(Iterable<Synonym> synonyms,
RequestOptions requestOptions)
Push a new set of synonyms and erase all previous ones.
|
default CompletableFuture<SaveSynonymResponse> |
SearchIndexSynonyms.replaceAllSynonymsAsync(Iterable<Synonym> synonyms,
RequestOptions requestOptions)
Push a new set of synonyms and erase all previous ones.
|
default RestoreApiKeyResponse |
SearchClientAPIKeys.restoreApiKey(String apiKey,
RequestOptions requestOptions)
Restore the given API Key
|
default CompletableFuture<RestoreApiKeyResponse> |
SearchClientAPIKeys.restoreApiKeyAsync(String apiKey,
RequestOptions requestOptions)
Restore the given API Key
|
BatchIndexingResponse |
SearchIndex.saveObject(T data,
boolean autoGenerateObjectID,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
BatchIndexingResponse |
SearchIndex.saveObject(T data,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
CompletableFuture<BatchIndexingResponse> |
SearchIndex.saveObjectAsync(T data,
boolean autoGenerateObjectID,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
CompletableFuture<BatchIndexingResponse> |
SearchIndex.saveObjectAsync(T data,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
BatchIndexingResponse |
SearchIndex.saveObjects(Iterable<T> data,
boolean autoGenerateObjectID,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
BatchIndexingResponse |
SearchIndex.saveObjects(Iterable<T> data,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
CompletableFuture<BatchIndexingResponse> |
SearchIndex.saveObjectsAsync(Iterable<T> data,
boolean autoGenerateObjectID,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
CompletableFuture<BatchIndexingResponse> |
SearchIndex.saveObjectsAsync(Iterable<T> data,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
default SaveRuleResponse |
SearchIndexRules.saveRule(Rule rule,
Boolean forwardToReplicas,
RequestOptions requestOptions)
Create or update a single rule.
|
default SaveRuleResponse |
SearchIndexRules.saveRule(Rule rule,
RequestOptions requestOptions)
Create or update a single rule.
|
default CompletableFuture<SaveRuleResponse> |
SearchIndexRules.saveRuleAsync(Rule rule,
Boolean forwardToReplicas,
RequestOptions requestOptions)
Create or update a single rule.
|
default CompletableFuture<SaveRuleResponse> |
SearchIndexRules.saveRuleAsync(Rule rule,
RequestOptions requestOptions)
Create or update a single rule.
|
default SaveRuleResponse |
SearchIndexRules.saveRules(Iterable<Rule> rules,
Boolean forwardToReplicas,
Boolean clearExistingRules,
RequestOptions requestOptions)
Create or update a specified set of rules, or all rules.
|
default SaveRuleResponse |
SearchIndexRules.saveRules(Iterable<Rule> rules,
RequestOptions requestOptions)
Create or update a specified set of rules, or all rules.
|
default CompletableFuture<SaveRuleResponse> |
SearchIndexRules.saveRulesAsync(Iterable<Rule> rules,
Boolean forwardToReplicas,
Boolean clearExistingRules,
RequestOptions requestOptions)
Create or update a specified set of rules, or all rules.
|
default CompletableFuture<SaveRuleResponse> |
SearchIndexRules.saveRulesAsync(Iterable<Rule> rules,
RequestOptions requestOptions)
Create or update a specified set of rules, or all rules.
|
default SaveSynonymResponse |
SearchIndexSynonyms.saveSynonym(Synonym synonym,
Boolean forwardToReplicas,
RequestOptions requestOptions)
Create or update a single rule.
|
default SaveSynonymResponse |
SearchIndexSynonyms.saveSynonym(Synonym synonym,
RequestOptions requestOptions)
Create or update a single synonym on an index.
|
default CompletableFuture<SaveSynonymResponse> |
SearchIndexSynonyms.saveSynonymAsync(Synonym synonym,
Boolean forwardToReplicas,
RequestOptions requestOptions)
Create or update a single rule.
|
default CompletableFuture<SaveSynonymResponse> |
SearchIndexSynonyms.saveSynonymAsync(Synonym synonym,
RequestOptions requestOptions)
Create or update a single synonym on an index.
|
default SaveSynonymResponse |
SearchIndexSynonyms.saveSynonyms(Iterable<Synonym> synonyms,
Boolean forwardToReplicas,
Boolean replaceExistingSynonyms,
RequestOptions requestOptions)
Create or update multiple synonyms.
|
default SaveSynonymResponse |
SearchIndexSynonyms.saveSynonyms(Iterable<Synonym> synonyms,
RequestOptions requestOptions)
Create or update multiple synonyms.
|
default CompletableFuture<SaveSynonymResponse> |
SearchIndexSynonyms.saveSynonymsAsync(Iterable<Synonym> synonyms,
Boolean forwardToReplicas,
Boolean replaceExistingSynonyms,
RequestOptions requestOptions)
Create or update multiple synonyms.
|
default CompletableFuture<SaveSynonymResponse> |
SearchIndexSynonyms.saveSynonymsAsync(Iterable<Synonym> synonyms,
RequestOptions requestOptions)
Create or update multiple synonyms.
|
default SearchResult<T> |
SearchIndexSearching.search(Query query,
RequestOptions requestOptions)
Method used for querying an index.
|
default CompletableFuture<SearchResult<T>> |
SearchIndexSearching.searchAsync(Query query,
RequestOptions requestOptions)
Method used for querying an index.
|
default SearchForFacetResponse |
SearchIndexSearching.searchForFacetValues(SearchForFacetRequest query,
RequestOptions requestOptions)
Search for a set of values within a given facet attribute.
|
default CompletableFuture<SearchForFacetResponse> |
SearchIndexSearching.searchForFacetValuesAsync(SearchForFacetRequest query,
RequestOptions requestOptions)
Search for a set of values within a given facet attribute.
|
default SearchResult<Rule> |
SearchIndexRules.searchRules(RuleQuery query,
RequestOptions requestOptions)
Search for rules matching various criteria.
|
default CompletableFuture<SearchResult<Rule>> |
SearchIndexRules.searchRulesAsync(RuleQuery query,
RequestOptions requestOptions)
Search for rules matching various criteria.
|
default SearchResult<Synonym> |
SearchIndexSynonyms.searchSynonyms(SynonymQuery query,
RequestOptions requestOptions)
Get all synonyms that match a query.
|
default CompletableFuture<SearchResult<Synonym>> |
SearchIndexSynonyms.searchSynonymsAsync(SynonymQuery query,
RequestOptions requestOptions)
Get all synonyms that match a query.
|
default SearchResult<UserId> |
SearchClientMcm.searchUserIDs(SearchUserIdsRequest query,
RequestOptions requestOptions)
Search for userIDs The data returned will usually be a few seconds behind real-time, because
userID usage may take up to a few seconds propagate to the different cluster
|
default CompletableFuture<SearchResult<UserId>> |
SearchClientMcm.searchUserIDsAsync(SearchUserIdsRequest query,
RequestOptions requestOptions)
Search for userIDs The data returned will usually be a few seconds behind real-time, because
userID usage may take up to a few seconds propagate to the different cluster
|
InsightsResult |
InsightsClient.sendEvent(InsightsEvent event,
RequestOptions requestOptions)
This command pushes an event to the Insights API.
|
CompletableFuture<InsightsResult> |
InsightsClient.sendEventAsync(InsightsEvent event,
RequestOptions requestOptions)
This command pushes an event to the Insights API.
|
InsightsResult |
InsightsClient.sendEvents(List<InsightsEvent> events,
RequestOptions requestOptions)
This command pushes an array of events to the Insights API.
|
CompletableFuture<InsightsResult> |
InsightsClient.sendEventsAsync(List<InsightsEvent> events,
RequestOptions requestOptions)
This command pushes an array of events to the Insights API.
|
default SetStrategyResponse |
SearchClientPersonalization.setPersonalizationStrategy(SetStrategyRequest request,
RequestOptions requestOptions)
This command configures the personalization strategy
|
default CompletableFuture<SetStrategyResponse> |
SearchClientPersonalization.setPersonalizationStrategyAsync(SetStrategyRequest request,
RequestOptions requestOptions)
This command configures the personalization strategy
|
default SetSettingsResponse |
SearchIndexSettings.setSettings(IndexSettings settings,
Boolean forwardToReplicas,
RequestOptions requestOptions)
Set settings of this index, and do not forward to replicas
|
default SetSettingsResponse |
SearchIndexSettings.setSettings(IndexSettings settings,
RequestOptions requestOptions)
Set settings of this index, and do not forward to slaves
|
default CompletableFuture<SetSettingsResponse> |
SearchIndexSettings.setSettingsAsync(IndexSettings settings,
Boolean forwardToReplicas,
RequestOptions requestOptions)
Set settings of this index, and do not forward to replicas
|
default CompletableFuture<SetSettingsResponse> |
SearchIndexSettings.setSettingsAsync(IndexSettings settings,
RequestOptions requestOptions)
Set settings of this index, and do not forward to slaves
|
StopAbTestResponse |
AnalyticsClient.stopABTest(long id,
RequestOptions requestOptions)
Marks the A/B Test as stopped.
|
CompletableFuture<StopAbTestResponse> |
AnalyticsClient.stopABTestAsync(long id,
RequestOptions requestOptions)
Marks the A/B Test as stopped.
|
default UpdateApiKeyResponse |
SearchClientAPIKeys.updateApiKey(ApiKey request,
RequestOptions requestOptions)
Update the permissions of an existing API Key.
|
default CompletableFuture<UpdateApiKeyResponse> |
SearchClientAPIKeys.updateApiKeyAsync(ApiKey request,
RequestOptions requestOptions)
Update the permissions of an existing API Key.
|
InsightsResult |
UserInsightsClient.viewedFilters(String eventName,
String indexName,
List<String> filters,
RequestOptions requestOptions) |
CompletableFuture<InsightsResult> |
UserInsightsClient.viewedFiltersAsync(String eventName,
String indexName,
List<String> filters,
RequestOptions requestOptions) |
InsightsResult |
UserInsightsClient.viewedObjectIDs(String eventName,
String indexName,
List<String> objectIDs,
RequestOptions requestOptions) |
CompletableFuture<InsightsResult> |
UserInsightsClient.viewedObjectIDsAsync(String eventName,
String indexName,
List<String> objectIDs,
RequestOptions requestOptions) |
void |
SearchIndexBase.waitTask(long taskId,
long timeToWait,
RequestOptions requestOptions) |
void |
SearchIndex.waitTask(long taskId,
long timeToWait,
RequestOptions requestOptions)
Wait for a task to complete before executing the next line of code, to synchronize index
updates.
|
void |
SearchClientBase.waitTask(String indexName,
long taskId,
long timeToWait,
RequestOptions requestOptions) |
void |
SearchClient.waitTask(String indexName,
long taskID,
long timeToWait,
RequestOptions requestOptions)
Wait for a task to complete before executing the next line of code, to synchronize index
updates.
|
void |
SearchClient.waitTask(String indexName,
long taskID,
RequestOptions requestOptions)
Wait for a task to complete before executing the next line of code, to synchronize index
updates.
|
| Constructor and Description |
|---|
IndexIterable(SearchIndex<E> index,
BrowseIndexQuery query,
RequestOptions requestOptions) |
IndexIterator(SearchIndex<E> index,
BrowseIndexQuery query,
RequestOptions requestOptions) |
RulesIterable(SearchIndex<?> index,
Integer hitsPerPage,
RequestOptions requestOptions) |
RulesIterator(SearchIndex<?> index,
Integer hitsPerPage,
RequestOptions requestOptions) |
SynonymsIterable(SearchIndex<?> index,
Integer hitsPerPage,
RequestOptions requestOptions) |
SynonymsIterator(SearchIndex<?> index,
Integer hitsPerPage,
RequestOptions requestOptions) |
| Modifier and Type | Method and Description |
|---|---|
RequestOptions |
RequestOptions.addExtraHeader(String key,
String value) |
RequestOptions |
RequestOptions.addExtraQueryParameters(String key,
String value) |
RequestOptions |
RequestOptions.setTimeout(Integer timeout) |
Copyright © 2019. All rights reserved.