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

A

addApiKey(JSONObject) - Method in class com.algolia.search.saas.APIClient

Create a new api key

addApiKey(JSONObject, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Create a new api key

addApiKey(List<String>) - Method in class com.algolia.search.saas.APIClient

Create a new api key

addApiKey(List<String>, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Create a new api key

addApiKey(List<String>, int, int, int) - Method in class com.algolia.search.saas.APIClient

Create a new api key

addApiKey(List<String>, int, int, int, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Create a new api key

addApiKey(List<String>, int, int, int, List<String>) - Method in class com.algolia.search.saas.APIClient

Create a new user key

addApiKey(List<String>, int, int, int, List<String>, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Create a new user key

addApiKey(JSONObject) - Method in class com.algolia.search.saas.Index

Create a new api key

addApiKey(JSONObject, RequestOptions) - Method in class com.algolia.search.saas.Index

Create a new api key

addApiKey(List<String>) - Method in class com.algolia.search.saas.Index

Create a new api key

addApiKey(List<String>, int, int, int) - Method in class com.algolia.search.saas.Index

Create a new api key

addApiKey(List<String>, int, int, int, RequestOptions) - Method in class com.algolia.search.saas.Index

Create a new api key

addExtraHeader(String, String) - Method in class com.algolia.search.saas.RequestOptions

addExtraQueryParameters(String, String) - Method in class com.algolia.search.saas.RequestOptions

addInsidePolygon(float, float) - Method in class com.algolia.search.saas.Query

Add a point to the polygon of geo-search (requires a minimum of three points to define a valid polygon) At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form "_geoloc":{"lat":48.853409, "lng":2.348800} or "_geoloc":[{"lat":48.853409, "lng":2.348800},{"lat":48.547456, "lng":2.972075}] if you have several geo-locations in your record).

addObject(JSONObject) - Method in class com.algolia.search.saas.Index

Add an object in this index

addObject(JSONObject, RequestOptions) - 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

addObject(JSONObject, String, RequestOptions) - 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(List<JSONObject>, RequestOptions) - Method in class com.algolia.search.saas.Index

Add several objects

addObjects(JSONArray) - Method in class com.algolia.search.saas.Index

Add several objects

addObjects(JSONArray, RequestOptions) - Method in class com.algolia.search.saas.Index

Add several objects

addUserKey(JSONObject) - Method in class com.algolia.search.saas.APIClient

Deprecated.

addUserKey(List<String>) - Method in class com.algolia.search.saas.APIClient

Deprecated.

addUserKey(List<String>, int, int, int) - Method in class com.algolia.search.saas.APIClient

Deprecated.

addUserKey(List<String>, int, int, int, List<String>) - Method in class com.algolia.search.saas.APIClient

Deprecated.

addUserKey(JSONObject) - Method in class com.algolia.search.saas.Index

Deprecated.

addUserKey(List<String>) - Method in class com.algolia.search.saas.Index

Deprecated.

addUserKey(List<String>, int, int, int) - Method in class com.algolia.search.saas.Index

Deprecated.

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

AlgoliaException - Exception in com.algolia.search.saas

AlgoliaException(Throwable) - Constructor for exception com.algolia.search.saas.AlgoliaException

AlgoliaException(String) - Constructor for exception com.algolia.search.saas.AlgoliaException

AlgoliaException(int, String) - Constructor for exception com.algolia.search.saas.AlgoliaException

AlgoliaException(String, Throwable) - Constructor for exception com.algolia.search.saas.AlgoliaException

AlgoliaInnerException - Exception in com.algolia.search.saas

AlgoliaInnerException(String, Throwable) - Constructor for exception com.algolia.search.saas.AlgoliaInnerException

AlgoliaInnerException(String, String) - Constructor for exception com.algolia.search.saas.AlgoliaInnerException

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

alternativesAsExact - 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.LogType - Enum in com.algolia.search.saas

aroundLatitudeLongitude(float, float) - Method in class com.algolia.search.saas.Query

Search for entries around a given latitude/longitude with an automatic radius computed depending of the density of the area.

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) - Method in class com.algolia.search.saas.Query

Search for entries around the latitude/longitude of user (using IP geolocation) with an automatic radius depending on area density

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

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

aroundRadius - 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(JSONArray, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Custom batch

batch(List<JSONObject>) - Method in class com.algolia.search.saas.APIClient

Custom batch

batch(List<JSONObject>, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Custom batch

batch(JSONArray) - Method in class com.algolia.search.saas.Index

Custom batch

batch(JSONArray, RequestOptions) - Method in class com.algolia.search.saas.Index

Custom batch

batch(List<JSONObject>) - Method in class com.algolia.search.saas.Index

Custom batch

batch(List<JSONObject>, RequestOptions) - Method in class com.algolia.search.saas.Index

Custom batch

batchRules(List<JSONObject>, boolean, boolean) - Method in class com.algolia.search.saas.Index

Add or Replace a list of synonyms

batchRules(List<JSONObject>, boolean, boolean, RequestOptions) - Method in class com.algolia.search.saas.Index

Add or Replace a list of synonyms

batchRules(List<JSONObject>, boolean) - Method in class com.algolia.search.saas.Index

Add or Replace a list of synonyms

batchRules(List<JSONObject>) - Method in class com.algolia.search.saas.Index

Add or Replace a list of synonyms

batchSynonyms(List<JSONObject>, boolean, boolean) - Method in class com.algolia.search.saas.Index

Add or Replace a list of synonyms

batchSynonyms(List<JSONObject>, boolean, boolean, RequestOptions) - Method in class com.algolia.search.saas.Index

Add or Replace a list of synonyms

batchSynonyms(List<JSONObject>, boolean) - Method in class com.algolia.search.saas.Index

Add or Replace a list of synonyms

batchSynonyms(List<JSONObject>, boolean, RequestOptions) - Method in class com.algolia.search.saas.Index

Add or Replace a list of synonyms

batchSynonyms(List<JSONObject>) - Method in class com.algolia.search.saas.Index

Add or Replace a list of synonyms

batchSynonyms(List<JSONObject>, RequestOptions) - Method in class com.algolia.search.saas.Index

Add or Replace a list of synonyms

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(Query, RequestOptions) - 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

browse(int, int, RequestOptions) - Method in class com.algolia.search.saas.Index

Browse all index content

browseFrom(Query, String) - Method in class com.algolia.search.saas.Index

Browse all index content starting from a cursor

browseFrom(Query, String, RequestOptions) - Method in class com.algolia.search.saas.Index

Browse all index content starting from a cursor

browseFrow(Query, String) - Method in class com.algolia.search.saas.Index

Deprecated.

C

clearIndex() - Method in class com.algolia.search.saas.Index

Delete the index content without removing settings and index specific API keys.

clearIndex(RequestOptions) - Method in class com.algolia.search.saas.Index

Delete the index content without removing settings and index specific API keys.

clearRules(boolean) - Method in class com.algolia.search.saas.Index

Delete all query rules

clearRules(boolean, RequestOptions) - Method in class com.algolia.search.saas.Index

Delete all query rules

clearRules() - Method in class com.algolia.search.saas.Index

Delete all query rules

clearSynonyms(boolean) - Method in class com.algolia.search.saas.Index

Delete all synonym set

clearSynonyms(boolean, RequestOptions) - Method in class com.algolia.search.saas.Index

Delete all synonym set

clearSynonyms() - Method in class com.algolia.search.saas.Index

Delete all synonym set

clearSynonyms(RequestOptions) - Method in class com.algolia.search.saas.Index

Delete all synonym set

com.algolia.search.saas - package com.algolia.search.saas

copyIndex(String, String) - Method in class com.algolia.search.saas.APIClient

Copy an existing index.

copyIndex(String, String, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Copy an existing index.

D

deleteApiKey(String) - Method in class com.algolia.search.saas.APIClient

Delete an existing api key

deleteApiKey(String, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Delete an existing api key

deleteApiKey(String) - Method in class com.algolia.search.saas.Index

Delete an existing api key

deleteApiKey(String, RequestOptions) - Method in class com.algolia.search.saas.Index

Delete an existing api key

deleteByQuery(Query) - Method in class com.algolia.search.saas.Index

Delete all objects matching a query

deleteByQuery(Query, RequestOptions) - Method in class com.algolia.search.saas.Index

Delete all objects matching a query

deleteByQuery(Query, int) - Method in class com.algolia.search.saas.Index

deleteByQuery(Query, int, RequestOptions) - Method in class com.algolia.search.saas.Index

deleteIndex(String) - Method in class com.algolia.search.saas.APIClient

Delete an index

deleteIndex(String, RequestOptions) - 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

deleteObject(String, RequestOptions) - 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

deleteObjects(List<String>, RequestOptions) - Method in class com.algolia.search.saas.Index

Delete several objects

deleteRequest(String, RequestOptions) - Method in class com.algolia.search.saas.APIClient

deleteRule(String) - Method in class com.algolia.search.saas.Index

Delete a query rule

deleteRule(String, RequestOptions) - Method in class com.algolia.search.saas.Index

Delete a query rule

deleteSynonym(String, boolean) - Method in class com.algolia.search.saas.Index

Delete one synonym

deleteSynonym(String, boolean, RequestOptions) - Method in class com.algolia.search.saas.Index

Delete one synonym

deleteSynonym(String) - Method in class com.algolia.search.saas.Index

Delete one synonym

deleteSynonym(String, RequestOptions) - Method in class com.algolia.search.saas.Index

Delete one synonym

deleteUserKey(String) - Method in class com.algolia.search.saas.APIClient

Deprecated.

deleteUserKey(String) - Method in class com.algolia.search.saas.Index

Deprecated.

disableRateLimitForward() - Method in class com.algolia.search.saas.APIClient

Disable IP rate limit enabled with enableRateLimitForward() function

disableTypoToleranceOnAttributes(List<String>) - Method in class com.algolia.search.saas.Query

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

E

empty - Static variable in class com.algolia.search.saas.RequestOptions

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.

enableRemoveStopWords(boolean) - Method in class com.algolia.search.saas.Query

Enable the removal of stop words.

enableRemoveStopWords(String) - Method in class com.algolia.search.saas.Query

Enable to pass a list of ISO codes

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

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

F

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

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

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

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

from(String, List<AlgoliaInnerException>) - Static method in exception com.algolia.search.saas.AlgoliaException

G

generateExtraHeaders() - Method in class com.algolia.search.saas.RequestOptions

generateExtraQueryParams() - Method in class com.algolia.search.saas.RequestOptions

generateSecuredApiKey(String, String) - Method in class com.algolia.search.saas.APIClient

Deprecated.

Use `generateSecuredApiKey(String privateApiKey, Query query)` version

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

Deprecated.

Use `generateSecuredApiKey(String privateApiKey, Query query, String userToken)` version

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

getAnchoring() - Method in class com.algolia.search.saas.RuleQuery

getApiKey(String) - Method in class com.algolia.search.saas.APIClient

Get an api key

getApiKey(String, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Get an api key

getApiKey(String) - Method in class com.algolia.search.saas.Index

Get ACL of an api key

getApiKey(String, RequestOptions) - Method in class com.algolia.search.saas.Index

Get ACL of an api key

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

getContext() - Method in class com.algolia.search.saas.RuleQuery

getCursor() - Method in class com.algolia.search.saas.Index.IndexBrowser

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

getFilters() - Method in class com.algolia.search.saas.Query

getForwardedFor() - Method in class com.algolia.search.saas.RequestOptions

getHitsPerPage() - Method in class com.algolia.search.saas.Query

getHitsPerPage() - Method in class com.algolia.search.saas.RuleQuery

getHitsPerPage() - Method in class com.algolia.search.saas.SynonymQuery

getHost() - Method in exception com.algolia.search.saas.AlgoliaInnerException

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(RequestOptions) - 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, RequestOptions) - 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, boolean, RequestOptions) - 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.

getLogs(int, int, APIClient.LogType, RequestOptions) - 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, RequestOptions) - 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

getObject(String, List<String>, RequestOptions) - 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

getObjects(List<String>, RequestOptions) - Method in class com.algolia.search.saas.Index

Get several objects from this index

getObjects(List<String>, List<String>) - Method in class com.algolia.search.saas.Index

Get several objects from this index

getObjects(List<String>, List<String>, RequestOptions) - 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

getPage() - Method in class com.algolia.search.saas.RuleQuery

getPage() - Method in class com.algolia.search.saas.SynonymQuery

getQuery() - Method in class com.algolia.search.saas.APIClient.IndexQuery

getQuery() - Method in class com.algolia.search.saas.Query

getQuery() - Method in class com.algolia.search.saas.RuleQuery

getQueryString() - Method in class com.algolia.search.saas.SynonymQuery

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, RequestOptions) - Method in class com.algolia.search.saas.APIClient

getResponseFields() - Method in class com.algolia.search.saas.Query

getRestrictIndices() - Method in class com.algolia.search.saas.Query

getRestrictSearchableAttributes() - Method in class com.algolia.search.saas.Query

getRestrictSources() - Method in class com.algolia.search.saas.Query

Restrict calls on the API only from this IP range

getRule(String) - Method in class com.algolia.search.saas.Index

Get a query rule

getRule(String, RequestOptions) - Method in class com.algolia.search.saas.Index

Get a query rule

getSettings() - Method in class com.algolia.search.saas.Index

Get settings of this index

getSettings(RequestOptions) - Method in class com.algolia.search.saas.Index

Get settings of this index

getSimilarQuery() - Method in class com.algolia.search.saas.Query

getSynonym(String) - Method in class com.algolia.search.saas.Index

Get one synonym

getSynonym(String, RequestOptions) - Method in class com.algolia.search.saas.Index

Get one synonym

getTags() - Method in class com.algolia.search.saas.Query

getTypes() - Method in class com.algolia.search.saas.SynonymQuery

getTypoTolerance() - Method in class com.algolia.search.saas.Query

getUserKeyACL(String) - Method in class com.algolia.search.saas.APIClient

Deprecated.

getUserKeyACL(String) - Method in class com.algolia.search.saas.Index

Deprecated.

getValidUntil() - Method in class com.algolia.search.saas.Query

H

hasNext() - Method in class com.algolia.search.saas.Index.IndexBrowser

hasTypes() - Method in class com.algolia.search.saas.SynonymQuery

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)

Index.IndexBrowser - Class in com.algolia.search.saas

This class iterates over an index using the cursor-based browse mechanism

IndexQuery(String, Query) - Constructor for class com.algolia.search.saas.APIClient.IndexQuery

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.

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

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

listApiKeys() - Method in class com.algolia.search.saas.APIClient

List all existing api keys with their associated ACLs

listApiKeys(RequestOptions) - Method in class com.algolia.search.saas.APIClient

List all existing api keys with their associated ACLs

listApiKeys() - Method in class com.algolia.search.saas.Index

List all existing api keys with their associated ACLs

listApiKeys(RequestOptions) - Method in class com.algolia.search.saas.Index

List all existing api keys with their associated ACLs

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"}]}

listIndexes(RequestOptions) - 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

Deprecated.

listUserKeys() - Method in class com.algolia.search.saas.Index

Deprecated.

M

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

minimumAroundRadius - 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.

moveIndex(String, String, RequestOptions) - 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>, RequestOptions) - Method in class com.algolia.search.saas.APIClient

This method allows to query multiple indexes with one API call

multipleQueries(List<APIClient.IndexQuery>, String, RequestOptions) - Method in class com.algolia.search.saas.APIClient

N

name - Variable in enum com.algolia.search.saas.SynonymQuery.SynonymType

next() - Method in class com.algolia.search.saas.Index.IndexBrowser

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

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

partialUpdateObject(JSONObject, String, RequestOptions) - 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

partialUpdateObjectNoCreate(JSONObject, String, RequestOptions) - 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(JSONArray, RequestOptions) - 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

partialUpdateObjects(List<JSONObject>, RequestOptions) - Method in class com.algolia.search.saas.Index

Partially Override the content of several objects

postRequest(String, String, boolean, boolean, RequestOptions) - Method in class com.algolia.search.saas.APIClient

putRequest(String, String, RequestOptions) - 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

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

remove() - Method in class com.algolia.search.saas.Index.IndexBrowser

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

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

RequestOptions - Class in com.algolia.search.saas

RequestOptions() - Constructor for class com.algolia.search.saas.RequestOptions

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

restrictIndices - 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).

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

RuleQuery - Class in com.algolia.search.saas

RuleQuery(String) - Constructor for class com.algolia.search.saas.RuleQuery

RuleQuery() - Constructor for class com.algolia.search.saas.RuleQuery

S

saveObject(JSONObject, String) - Method in class com.algolia.search.saas.Index

Override the content of object

saveObject(JSONObject, String, RequestOptions) - 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(List<JSONObject>, RequestOptions) - 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

saveObjects(JSONArray, RequestOptions) - Method in class com.algolia.search.saas.Index

Override the content of several objects

saveRule(String, JSONObject, boolean) - Method in class com.algolia.search.saas.Index

Save a query rule

saveRule(String, JSONObject, boolean, RequestOptions) - Method in class com.algolia.search.saas.Index

Save a query rule

saveRule(String, JSONObject) - Method in class com.algolia.search.saas.Index

Save a query rule

saveSynonym(String, JSONObject, boolean) - Method in class com.algolia.search.saas.Index

Update one synonym

saveSynonym(String, JSONObject, boolean, RequestOptions) - Method in class com.algolia.search.saas.Index

Update one synonym

saveSynonym(String, JSONObject) - Method in class com.algolia.search.saas.Index

Update one synonym

saveSynonym(String, JSONObject, RequestOptions) - Method in class com.algolia.search.saas.Index

Update one synonym

search(Query) - Method in class com.algolia.search.saas.Index

Search inside the index

search(Query, RequestOptions) - 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

searchInFacetValues(String, String, Query) - Method in class com.algolia.search.saas.Index

Search into a facet value

searchInFacetValues(String, String, Query, RequestOptions) - Method in class com.algolia.search.saas.Index

Search into a facet value

searchRules(RuleQuery) - Method in class com.algolia.search.saas.Index

Search for query rules

searchRules(RuleQuery, RequestOptions) - Method in class com.algolia.search.saas.Index

Search for query rules

searchSynonyms(SynonymQuery) - Method in class com.algolia.search.saas.Index

Search for synonyms

searchSynonyms(SynonymQuery, RequestOptions) - Method in class com.algolia.search.saas.Index

Search for synonyms

setAlternativesAsExact(String) - Method in class com.algolia.search.saas.Query

setAnalyticsTags(String) - Method in class com.algolia.search.saas.Query

setAnchoring(String) - Method in class com.algolia.search.saas.RuleQuery

Set the anchoring, restricts the search to rules with a specific anchoring type

setAroundPrecision(int) - Method in class com.algolia.search.saas.Query

Change the precision of around latitude/longitude query

setAroundRadius(int) - Method in class com.algolia.search.saas.Query

Change the radius of around latitude/longitude query

setAroundRadiusAll() - Method in class com.algolia.search.saas.Query

Change the radius of around latitude/longitude to `all`

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').

setContext(String) - Method in class com.algolia.search.saas.RuleQuery

Set the context, restricts the search to rules with a specific context (exact match)

setExactOnSingleWordQuery(String) - Method in class com.algolia.search.saas.Query

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.

setFilters(String) - Method in class com.algolia.search.saas.Query

Filter the query with numeric, facet or/and tag filters.

setForwardedFor(String) - Method in class com.algolia.search.saas.RequestOptions

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.

setHitsPerPage(Integer) - Method in class com.algolia.search.saas.RuleQuery

Set the number of hits per page.

setHitsPerPage(Integer) - Method in class com.algolia.search.saas.SynonymQuery

Set the number of hits per page.

setHostDownTimeoutMS(int) - Method in class com.algolia.search.saas.APIClient

Allow to set the timeout for a down host

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.

setMinimumAroundRadius(int) - Method in class com.algolia.search.saas.Query

Change the minimum radius of around latitude/longitude query

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).

setPage(Integer) - Method in class com.algolia.search.saas.RuleQuery

Set the page to retrieve (zero base).

setPage(Integer) - Method in class com.algolia.search.saas.SynonymQuery

Set the page to retrieve (zero base).

setQuery(Query) - Method in class com.algolia.search.saas.APIClient.IndexQuery

setQuery(String) - Method in class com.algolia.search.saas.RuleQuery

Set the full text query

setQueryString(String) - Method in class com.algolia.search.saas.Query

Set the full text query

setQueryString(String) - Method in class com.algolia.search.saas.SynonymQuery

Set the full text query

setQueryType(Query.QueryType) - Method in class com.algolia.search.saas.Query

Select how the query words are interpreted:

setReferers(String) - Method in class com.algolia.search.saas.Query

Set the referers used to restrict the query from a specific website.

setResponseFields(List<String>) - Method in class com.algolia.search.saas.Query

setRestrictIndicies(String) - Method in class com.algolia.search.saas.Query

setRestrictSources(String) - Method in class com.algolia.search.saas.Query

setSettings(JSONObject) - Method in class com.algolia.search.saas.Index

Set settings for this index

setSettings(JSONObject, RequestOptions) - Method in class com.algolia.search.saas.Index

Set settings for this index

setSettings(JSONObject, Boolean) - Method in class com.algolia.search.saas.Index

setSettings(JSONObject, Boolean, RequestOptions) - Method in class com.algolia.search.saas.Index

setSimilarQueryString(String) - Method in class com.algolia.search.saas.Query

Set the full text similar query string

setSnippetEllipsisText(String) - Method in class com.algolia.search.saas.Query

Specify the string that is used as an ellipsis indicator when a snippet is truncated (defaults to the empty string).

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

setTypes(List<SynonymQuery.SynonymType>) - Method in class com.algolia.search.saas.SynonymQuery

Set the types of Synonym to search

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

setUserToken(String) - Method in class com.algolia.search.saas.Query

Set the userToken used as identifier for the ratelimit

setValidUntil(Integer) - Method in class com.algolia.search.saas.Query

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

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

SynonymQuery - Class in com.algolia.search.saas

SynonymQuery(String) - Constructor for class com.algolia.search.saas.SynonymQuery

SynonymQuery() - Constructor for class com.algolia.search.saas.SynonymQuery

SynonymQuery.SynonymType - Enum in com.algolia.search.saas

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

T

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

toString() - Method in class com.algolia.search.saas.RequestOptions

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

U

updateApiKey(String, JSONObject) - Method in class com.algolia.search.saas.APIClient

Update an api key

updateApiKey(String, JSONObject, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Update an api key

updateApiKey(String, List<String>) - Method in class com.algolia.search.saas.APIClient

Update an api key

updateApiKey(String, List<String>, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Update an api key

updateApiKey(String, List<String>, int, int, int) - Method in class com.algolia.search.saas.APIClient

Update an api key

updateApiKey(String, List<String>, int, int, int, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Update an api key

updateApiKey(String, List<String>, int, int, int, List<String>) - Method in class com.algolia.search.saas.APIClient

Update an api key

updateApiKey(String, List<String>, int, int, int, List<String>, RequestOptions) - Method in class com.algolia.search.saas.APIClient

Update an api key

updateApiKey(String, JSONObject) - Method in class com.algolia.search.saas.Index

Update a new api key

updateApiKey(String, JSONObject, RequestOptions) - Method in class com.algolia.search.saas.Index

Update a new api key

updateApiKey(String, List<String>) - Method in class com.algolia.search.saas.Index

Update an api key

updateApiKey(String, List<String>, int, int, int) - Method in class com.algolia.search.saas.Index

Update an api key

updateApiKey(String, List<String>, int, int, int, RequestOptions) - Method in class com.algolia.search.saas.Index

Update an api key

updateUserKey(String, JSONObject) - Method in class com.algolia.search.saas.APIClient

Deprecated.

updateUserKey(String, List<String>) - Method in class com.algolia.search.saas.APIClient

Deprecated.

updateUserKey(String, List<String>, int, int, int) - Method in class com.algolia.search.saas.APIClient

Deprecated.

updateUserKey(String, List<String>, int, int, int, List<String>) - Method in class com.algolia.search.saas.APIClient

Deprecated.

updateUserKey(String, JSONObject) - Method in class com.algolia.search.saas.Index

Deprecated.

updateUserKey(String, List<String>) - Method in class com.algolia.search.saas.Index

Deprecated.

updateUserKey(String, List<String>, int, int, int) - Method in class com.algolia.search.saas.Index

Deprecated.

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

V

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

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.

valueOf(String) - Static method in enum com.algolia.search.saas.SynonymQuery.SynonymType

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.

values() - Static method in enum com.algolia.search.saas.SynonymQuery.SynonymType

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, long, RequestOptions) - 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