public class Index<T> extends Object implements SyncDeleteByQuery<T>, SyncBrowse<T>, SyncSynonyms<T>, SyncPartialUpdate<T>, SyncSearchForFacet<T>, SyncKey<T>, SyncSettings<T>, SyncObjects<T>, SyncTasks<T>, SyncIndexCRUD<T>, SyncRules<T>
| Modifier and Type | Class and Description |
|---|---|
static class |
Index.Attributes |
| Modifier and Type | Method and Description |
|---|---|
TaskSingleIndex |
batch(List<BatchOperation> operations)
Custom batch
|
TaskSingleIndex |
batch(List<BatchOperation> operations,
RequestOptions requestOptions)
Custom batch
|
APIClient |
getApiClient() |
Class<T> |
getKlass() |
String |
getName() |
SearchResult<T> |
search(Query query)
Search in the index throws a
AlgoliaIndexNotFoundException if the index does not exists |
SearchResult<T> |
search(Query query,
RequestOptions requestOptions)
Search in the index throws a
AlgoliaIndexNotFoundException if the index does not exists |
String |
toString() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitdeleteBy, deleteBy, deleteByQuery, deleteByQuery, deleteByQuery, deleteByQuerybrowse, browse, browseFrom, browseFrombatchSynonyms, batchSynonyms, batchSynonyms, batchSynonyms, batchSynonyms, batchSynonyms, clearSynonyms, clearSynonyms, clearSynonyms, clearSynonyms, deleteSynonym, deleteSynonym, deleteSynonym, deleteSynonym, getSynonym, getSynonym, saveSynonym, saveSynonym, saveSynonym, saveSynonym, searchSynonyms, searchSynonymspartialUpdateObject, partialUpdateObject, partialUpdateObject, partialUpdateObject, partialUpdateObject, partialUpdateObject, partialUpdateObjects, partialUpdateObjects, partialUpdateObjects, partialUpdateObjectssearchFacet, searchFacet, searchForFacetValues, searchForFacetValues, searchForFacetValues, searchForFacetValues, searchInFacetValues, searchInFacetValuesaddApiKey, addApiKey, addKey, deleteApiKey, deleteApiKey, deleteKey, getApiKey, getApiKey, getKey, listApiKeys, listApiKeys, listKeys, updateApiKey, updateApiKey, updateKey, updateKeygetSettings, getSettings, setSettings, setSettings, setSettings, setSettingsaddObject, addObject, addObject, addObject, addObjects, addObjects, deleteObject, deleteObject, deleteObjects, deleteObjects, getObject, getObject, getObjects, getObjects, getObjects, getObjects, saveObject, saveObject, saveObjects, saveObjectswaitTask, waitTask, waitTask, waitTask, waitTask, waitTaskclear, clear, copyTo, copyTo, copyTo, copyTo, delete, delete, moveTo, moveTobatchRules, batchRules, batchRules, batchRules, batchRules, batchRules, clearRules, clearRules, clearRules, clearRules, deleteRule, deleteRule, deleteRule, getRule, getRule, saveRule, saveRule, saveRule, saveRule, searchRules, searchRulespublic String getName()
getName in interface AbstractIndex<T>public Class<T> getKlass()
getKlass in interface AbstractIndex<T>public APIClient getApiClient()
getApiClient in interface SyncBaseIndex<T>public SearchResult<T> search(@Nonnull Query query) throws AlgoliaException
AlgoliaIndexNotFoundException if the index does not existsquery - the queryAlgoliaExceptionpublic SearchResult<T> search(@Nonnull Query query, @Nonnull RequestOptions requestOptions) throws AlgoliaException
AlgoliaIndexNotFoundException if the index does not existsquery - the queryAlgoliaExceptionpublic TaskSingleIndex batch(@Nonnull List<BatchOperation> operations) throws AlgoliaException
All operations must have index name set to null
operations - the list of operations to perform on this indexAlgoliaException& subclassespublic TaskSingleIndex batch(@Nonnull List<BatchOperation> operations, @Nonnull RequestOptions requestOptions) throws AlgoliaException
All operations must have index name set to null
operations - the list of operations to perform on this indexrequestOptions - Options to pass to this requestAlgoliaException& subclassesCopyright © 2018. All rights reserved.