Index (Algolia Search Client 1.3.13 API)

A B C D E F G H I L M N O P Q R S T U V W

A

addObject(JSONObject) - Method in class com.algolia.search.saas.Index: Add an object in this index
addObject(JSONObject, String) - Method in class com.algolia.search.saas.Index: Add an object in this index with a uniq identifier
addObjects(List<JSONObject>) - Method in class com.algolia.search.saas.Index: Add several objects
addObjects(JSONArray) - Method in class com.algolia.search.saas.Index: Add several objects
addUserKey(JSONObject) - Method in class com.algolia.search.saas.APIClient: Create a new user key
addUserKey(List<String>) - Method in class com.algolia.search.saas.APIClient: Create a new user key
addUserKey(List<String>, int, int, int) - Method in class com.algolia.search.saas.APIClient: Create a new user key
addUserKey(List<String>, int, int, int, List<String>) - Method in class com.algolia.search.saas.APIClient: Create a new user key
addUserKey(JSONObject) - Method in class com.algolia.search.saas.Index: Create a new user key
addUserKey(List<String>) - Method in class com.algolia.search.saas.Index: Create a new user key
addUserKey(List<String>, int, int, int) - Method in class com.algolia.search.saas.Index: Create a new user key
advancedSyntax - Variable in class com.algolia.search.saas.Query
AlgoliaException - Exception in com.algolia.search.saas
AlgoliaException(String) - Constructor for exception com.algolia.search.saas.AlgoliaException
AlgoliaException(int, String) - Constructor for exception com.algolia.search.saas.AlgoliaException
allowTyposOnNumericTokens - Variable in class com.algolia.search.saas.Query
analytics - Variable in class com.algolia.search.saas.Query
analyticsTags - Variable in class com.algolia.search.saas.Query
APIClient - Class in com.algolia.search.saas: Entry point in the Java API.
APIClient(String, String) - Constructor for class com.algolia.search.saas.APIClient: Algolia Search initialization
APIClient(String, String, List<String>) - Constructor for class com.algolia.search.saas.APIClient: Algolia Search initialization
APIClient(String, String, List<String>, List<String>) - Constructor for class com.algolia.search.saas.APIClient: Algolia Search initialization
APIClient.IndexQuery - Class in com.algolia.search.saas
APIClient.IndexQuery(String, Query) - Constructor for class com.algolia.search.saas.APIClient.IndexQuery
APIClient.LogType - Enum in com.algolia.search.saas
aroundLatitudeLongitude(float, float, int) - Method in class com.algolia.search.saas.Query: Search for entries around a given latitude/longitude.
aroundLatitudeLongitude(float, float, int, int) - Method in class com.algolia.search.saas.Query: Search for entries around a given latitude/longitude.
aroundLatitudeLongitudeViaIP(boolean, int) - Method in class com.algolia.search.saas.Query: Search for entries around the latitude/longitude of user (using IP geolocation)
aroundLatitudeLongitudeViaIP(boolean, int, int) - Method in class com.algolia.search.saas.Query: Search for entries around the latitude/longitude of user (using IP geolocation)
aroundLatLong - Variable in class com.algolia.search.saas.Query
aroundLatLongViaIP - Variable in class com.algolia.search.saas.Query
attributes - Variable in class com.algolia.search.saas.Query
attributesToHighlight - Variable in class com.algolia.search.saas.Query
attributesToSnippet - Variable in class com.algolia.search.saas.Query

B

batch(JSONArray) - Method in class com.algolia.search.saas.APIClient: Custom batch
batch(List<JSONObject>) - Method in class com.algolia.search.saas.APIClient: Custom batch
batch(JSONArray) - Method in class com.algolia.search.saas.Index: Custom batch
batch(List<JSONObject>) - Method in class com.algolia.search.saas.Index: Custom batch
browse(int) - Method in class com.algolia.search.saas.Index: Deprecated.
Use the `browse(Query params)` version
browse(Query) - Method in class com.algolia.search.saas.Index: Browse all index content
browse(int, int) - Method in class com.algolia.search.saas.Index: Browse all index content
browseFrow(Query, String) - Method in class com.algolia.search.saas.Index: Browse all index content starting from a cursor

C

clearIndex() - Method in class com.algolia.search.saas.Index: Delete the index content without removing settings and index specific API keys.
com.algolia.search.saas - package com.algolia.search.saas
copyIndex(String, String) - Method in class com.algolia.search.saas.APIClient: Copy an existing index.

D

deleteByQuery(Query) - Method in class com.algolia.search.saas.Index: Delete all objects matching a query
deleteIndex(String) - Method in class com.algolia.search.saas.APIClient: Delete an index
deleteObject(String) - Method in class com.algolia.search.saas.Index: Delete an object from the index
deleteObjects(List<String>) - Method in class com.algolia.search.saas.Index: Delete several objects
deleteRequest(String, boolean) - Method in class com.algolia.search.saas.APIClient
deleteUserKey(String) - Method in class com.algolia.search.saas.APIClient: Delete an existing user key
deleteUserKey(String) - Method in class com.algolia.search.saas.Index: Delete an existing user key
disableRateLimitForward() - Method in class com.algolia.search.saas.APIClient: Disable IP rate limit enabled with enableRateLimitForward() function
distinct - Variable in class com.algolia.search.saas.Query

E

enableAnalytics(boolean) - Method in class com.algolia.search.saas.Query
enableAvancedSyntax(boolean) - Method in class com.algolia.search.saas.Query: Enable the advanced query syntax.
enableDistinct(boolean) - Method in class com.algolia.search.saas.Query
enableDistinct(int) - Method in class com.algolia.search.saas.Query: This feature is similar to the distinct just before but instead of keeping the best value per value of attributeForDistinct, it allows to keep N values.
enableRateLimitForward(String, String, String) - Method in class com.algolia.search.saas.APIClient: Allow to use IP rate limit when you have a proxy between end-user and Algolia.
enableReplaceSynonymsInHighlight(boolean) - Method in class com.algolia.search.saas.Query
enableSynonyms(boolean) - Method in class com.algolia.search.saas.Query
enableTyposOnNumericTokens(boolean) - Method in class com.algolia.search.saas.Query
enableTypoTolerance(boolean) - Method in class com.algolia.search.saas.Query

F

facetFilters - Variable in class com.algolia.search.saas.Query
facets - Variable in class com.algolia.search.saas.Query

G

generateSecuredApiKey(String, String) - Method in class com.algolia.search.saas.APIClient: Generate a secured and public API Key from a list of tagFilters and an optional user token identifying the current user
generateSecuredApiKey(String, Query) - Method in class com.algolia.search.saas.APIClient: Generate a secured and public API Key from a query and an optional user token identifying the current user
generateSecuredApiKey(String, String, String) - Method in class com.algolia.search.saas.APIClient: Generate a secured and public API Key from a list of tagFilters and an optional user token identifying the current user
generateSecuredApiKey(String, Query, String) - Method in class com.algolia.search.saas.APIClient: Generate a secured and public API Key from a query and an optional user token identifying the current user
getAnalyticsTags() - Method in class com.algolia.search.saas.Query
getAroundLatLong() - Method in class com.algolia.search.saas.Query
getAttributes() - Method in class com.algolia.search.saas.Query
getAttributesToHighlight() - Method in class com.algolia.search.saas.Query
getAttributesToSnippet() - Method in class com.algolia.search.saas.Query
getCode() - Method in exception com.algolia.search.saas.AlgoliaException
getDistinct() - Method in class com.algolia.search.saas.Query
getFacetFilters() - Method in class com.algolia.search.saas.Query
getFacets() - Method in class com.algolia.search.saas.Query
getHitsPerPage() - Method in class com.algolia.search.saas.Query
getIndex() - Method in class com.algolia.search.saas.APIClient.IndexQuery
getIndexName() - Method in class com.algolia.search.saas.Index
getInsideBoundingBox() - Method in class com.algolia.search.saas.Query
getLogs() - Method in class com.algolia.search.saas.APIClient: Return 10 last log entries.
getLogs(int, int) - Method in class com.algolia.search.saas.APIClient: Return last logs entries.
getLogs(int, int, boolean) - Method in class com.algolia.search.saas.APIClient: Return last logs entries.
getLogs(int, int, APIClient.LogType) - Method in class com.algolia.search.saas.APIClient: Return last logs entries.
getMaxNumberOfFacets() - Method in class com.algolia.search.saas.Query
getMinWordSizeForApprox1() - Method in class com.algolia.search.saas.Query
getMinWordSizeForApprox2() - Method in class com.algolia.search.saas.Query
getNumerics() - Method in class com.algolia.search.saas.Query
getObject(String) - Method in class com.algolia.search.saas.Index: Get an object from this index.
getObject(String, List<String>) - Method in class com.algolia.search.saas.Index: Get an object from this index
getObjects(List<String>) - Method in class com.algolia.search.saas.Index: Get several objects from this index
getOptionalWords() - Method in class com.algolia.search.saas.Query
getPage() - Method in class com.algolia.search.saas.Query
getQuery() - Method in class com.algolia.search.saas.APIClient.IndexQuery
getQuery() - Method in class com.algolia.search.saas.Query
getQueryString() - Method in class com.algolia.search.saas.Query
getQueryType() - Method in class com.algolia.search.saas.Query
getRankingInfo - Variable in class com.algolia.search.saas.Query
getRankingInfo(boolean) - Method in class com.algolia.search.saas.Query: if set, the result hits will contain ranking information in _rankingInfo attribute.
getRemoveWordsIfNoResult() - Method in class com.algolia.search.saas.Query
getRequest(String, boolean) - Method in class com.algolia.search.saas.APIClient
getRestrictSearchableAttributes() - Method in class com.algolia.search.saas.Query
getSettings() - Method in class com.algolia.search.saas.Index: Get settings of this index
getTags() - Method in class com.algolia.search.saas.Query
getTypoTolerance() - Method in class com.algolia.search.saas.Query
getUserKeyACL(String) - Method in class com.algolia.search.saas.APIClient: Get ACL of a user key
getUserKeyACL(String) - Method in class com.algolia.search.saas.Index: Get ACL of a user key

H

highlightPostTag - Variable in class com.algolia.search.saas.Query
highlightPreTag - Variable in class com.algolia.search.saas.Query
hitsPerPage - Variable in class com.algolia.search.saas.Query

I

ignorePlural - Variable in class com.algolia.search.saas.Query
ignorePlural(boolean) - Method in class com.algolia.search.saas.Query: If set to true, plural won't be considered as a typo (for example car/cars will be considered as equals).
Index - Class in com.algolia.search.saas: Contains all the functions related to one index You should use APIClient.initIndex(indexName) to retrieve this object
Index(APIClient, String) - Constructor for class com.algolia.search.saas.Index: Index initialization (You should not call this yourself)
initIndex(String) - Method in class com.algolia.search.saas.APIClient: Get the index object initialized (no server call needed for initialization)
insideBoundingBox - Variable in class com.algolia.search.saas.Query
insideBoundingBox(float, float, float, float) - Method in class com.algolia.search.saas.Query: Search for entries inside a given area defined by the two extreme points of a rectangle.
isAdvancedSyntax() - Method in class com.algolia.search.saas.Query
isAllowTyposOnNumericTokens() - Method in class com.algolia.search.saas.Query
isAnalytics() - Method in class com.algolia.search.saas.Query
isAroundLatLongViaIP() - Method in class com.algolia.search.saas.Query
isDistinct() - Method in class com.algolia.search.saas.Query
isGetRankingInfo() - Method in class com.algolia.search.saas.Query
isIgnorePlural() - Method in class com.algolia.search.saas.Query
isReplaceSynonyms() - Method in class com.algolia.search.saas.Query
isSynonyms() - Method in class com.algolia.search.saas.Query

L

listIndexes() - Method in class com.algolia.search.saas.APIClient: List all existing indexes return an JSON Object in the form: { "items": [ {"name": "contacts", "createdAt": "2013-01-18T15:33:13.556Z"}, {"name": "notes", "createdAt": "2013-01-18T15:33:13.556Z"}]}
listUserKeys() - Method in class com.algolia.search.saas.APIClient: List all existing user keys with their associated ACLs
listUserKeys() - Method in class com.algolia.search.saas.Index: List all existing user keys with their associated ACLs

M

maxNumberOfFacets - Variable in class com.algolia.search.saas.Query
minProximity - Variable in class com.algolia.search.saas.Query
minWordSizeForApprox1 - Variable in class com.algolia.search.saas.Query
minWordSizeForApprox2 - Variable in class com.algolia.search.saas.Query
moveIndex(String, String) - Method in class com.algolia.search.saas.APIClient: Move an existing index.
multipleQueries(List<APIClient.IndexQuery>) - Method in class com.algolia.search.saas.APIClient: This method allows to query multiple indexes with one API call
multipleQueries(List<APIClient.IndexQuery>, String) - Method in class com.algolia.search.saas.APIClient

N

numerics - Variable in class com.algolia.search.saas.Query

O

optionalWords - Variable in class com.algolia.search.saas.Query

P

page - Variable in class com.algolia.search.saas.Query
partialUpdateObject(JSONObject, String) - Method in class com.algolia.search.saas.Index: Update partially an object (only update attributes passed in argument), create the object if it does not exist
partialUpdateObjectNoCreate(JSONObject, String) - Method in class com.algolia.search.saas.Index: Update partially an object (only update attributes passed in argument), do nothing if object does not exist
partialUpdateObjects(JSONArray) - Method in class com.algolia.search.saas.Index: Partially Override the content of several objects
partialUpdateObjects(List<JSONObject>) - Method in class com.algolia.search.saas.Index: Partially Override the content of several objects
postRequest(String, String, boolean, boolean) - Method in class com.algolia.search.saas.APIClient
putRequest(String, String, boolean) - Method in class com.algolia.search.saas.APIClient

Q

Query - Class in com.algolia.search.saas
Query(String) - Constructor for class com.algolia.search.saas.Query
Query() - Constructor for class com.algolia.search.saas.Query
Query(Query) - Constructor for class com.algolia.search.saas.Query
query - Variable in class com.algolia.search.saas.Query
Query.QueryType - Enum in com.algolia.search.saas
Query.RemoveWordsType - Enum in com.algolia.search.saas
Query.TypoTolerance - Enum in com.algolia.search.saas
queryType - Variable in class com.algolia.search.saas.Query

R

removeWordsIfNoResult - Variable in class com.algolia.search.saas.Query
removeWordsIfNoResult(Query.RemoveWordsType) - Method in class com.algolia.search.saas.Query: Select the strategy to adopt when a query does not return any result.
replaceSynonyms - Variable in class com.algolia.search.saas.Query
restrictSearchableAttributes - Variable in class com.algolia.search.saas.Query
restrictSearchableAttributes(String) - Method in class com.algolia.search.saas.Query: List of object attributes you want to use for textual search (must be a subset of the attributesToIndex index setting).

S

saveObject(JSONObject, String) - Method in class com.algolia.search.saas.Index: Override the content of object
saveObjects(List<JSONObject>) - Method in class com.algolia.search.saas.Index: Override the content of several objects
saveObjects(JSONArray) - Method in class com.algolia.search.saas.Index: Override the content of several objects
search(Query) - Method in class com.algolia.search.saas.Index: Search inside the index
searchDisjunctiveFaceting(Query, List<String>, Map<String, List<String>>) - Method in class com.algolia.search.saas.Index: Perform a search with disjunctive facets generating as many queries as number of disjunctive facets
searchDisjunctiveFaceting(Query, List<String>) - Method in class com.algolia.search.saas.Index
setAnalyticsTags(String) - Method in class com.algolia.search.saas.Query
setAttributesToHighlight(List<String>) - Method in class com.algolia.search.saas.Query: Specify the list of attribute names to highlight.
setAttributesToRetrieve(List<String>) - Method in class com.algolia.search.saas.Query: Specify the list of attribute names to retrieve.
setAttributesToSnippet(List<String>) - Method in class com.algolia.search.saas.Query: Specify the list of attribute names to Snippet alongside the number of words to return (syntax is 'attributeName:nbWords').
setExtraHeader(String, String) - Method in class com.algolia.search.saas.APIClient: Allow to set custom headers
setFacetFilters(List<String>) - Method in class com.algolia.search.saas.Query: Filter the query by a list of facets.
setFacetFilters(String) - Method in class com.algolia.search.saas.Query: Filter the query by a list of facets.
setFacets(List<String>) - Method in class com.algolia.search.saas.Query: List of object attributes that you want to use for faceting.
setHighlightingTags(String, String) - Method in class com.algolia.search.saas.Query
setHitsPerPage(int) - Method in class com.algolia.search.saas.Query: Set the number of hits per page.
setIndex(String) - Method in class com.algolia.search.saas.APIClient.IndexQuery
setMaxNumberOfFacets(int) - Method in class com.algolia.search.saas.Query: Limit the number of facet values returned for each facet.
setMinProximity(int) - Method in class com.algolia.search.saas.Query
setMinWordSizeToAllowOneTypo(int) - Method in class com.algolia.search.saas.Query: Specify the minimum number of characters in a query word to accept one typo in this word.
setMinWordSizeToAllowTwoTypos(int) - Method in class com.algolia.search.saas.Query: Specify the minimum number of characters in a query word to accept two typos in this word.
setNbHitsPerPage(int) - Method in class com.algolia.search.saas.Query: Deprecated.
Use setHitsPerPage
setNumericFilters(String) - Method in class com.algolia.search.saas.Query: Add a list of numeric filters separated by a comma.
setNumericFilters(List<String>) - Method in class com.algolia.search.saas.Query: Add a list of numeric filters separated by a comma.
setOptionalWords(String) - Method in class com.algolia.search.saas.Query: Set the list of words that should be considered as optional when found in the query.
setOptionalWords(List<String>) - Method in class com.algolia.search.saas.Query: Set the list of words that should be considered as optional when found in the query.
setPage(int) - Method in class com.algolia.search.saas.Query: Set the page to retrieve (zero base).
setQuery(Query) - Method in class com.algolia.search.saas.APIClient.IndexQuery
setQueryString(String) - Method in class com.algolia.search.saas.Query: Set the full text query
setQueryType(Query.QueryType) - Method in class com.algolia.search.saas.Query: Select how the query words are interpreted:
setSettings(JSONObject) - Method in class com.algolia.search.saas.Index: Set settings for this index
setTagFilters(String) - Method in class com.algolia.search.saas.Query: Filter the query by a set of tags.
setTimeout(int, int) - Method in class com.algolia.search.saas.APIClient: Allow to set the timeout
setTypoTolerance(Query.TypoTolerance) - Method in class com.algolia.search.saas.Query
setUserAgent(String, String) - Method in class com.algolia.search.saas.APIClient: Allow to modify the user-agent in order to add the user agent of the integration
synonyms - Variable in class com.algolia.search.saas.Query

T

tags - Variable in class com.algolia.search.saas.Query
typoTolerance - Variable in class com.algolia.search.saas.Query

U

updateUserKey(String, JSONObject) - Method in class com.algolia.search.saas.APIClient: Update a user key
updateUserKey(String, List<String>) - Method in class com.algolia.search.saas.APIClient: Update a user key
updateUserKey(String, List<String>, int, int, int) - Method in class com.algolia.search.saas.APIClient: Update a user key
updateUserKey(String, List<String>, int, int, int, List<String>) - Method in class com.algolia.search.saas.APIClient: Update a user key
updateUserKey(String, JSONObject) - Method in class com.algolia.search.saas.Index: Update a new user key
updateUserKey(String, List<String>) - Method in class com.algolia.search.saas.Index: Update a user key
updateUserKey(String, List<String>, int, int, int) - Method in class com.algolia.search.saas.Index: Update a user key

V

valueOf(String) - Static method in enum com.algolia.search.saas.APIClient.LogType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.algolia.search.saas.Query.QueryType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.algolia.search.saas.Query.RemoveWordsType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.algolia.search.saas.Query.TypoTolerance: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.algolia.search.saas.APIClient.LogType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.algolia.search.saas.Query.QueryType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.algolia.search.saas.Query.RemoveWordsType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.algolia.search.saas.Query.TypoTolerance: Returns an array containing the constants of this enum type, in the order they are declared.

W

waitTask(String, long) - Method in class com.algolia.search.saas.Index: Wait the publication of a task on the server.
waitTask(String) - Method in class com.algolia.search.saas.Index: Wait the publication of a task on the server.

A B C D E F G H I L M N O P Q R S T U V W