All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description ABTest ABTestABTestResponse ABTests AccountClient The account client performs cross indices operations This class is an helper and it doesn't hold resources.ActionEnum Actions that need to be performed.AddABTestResponse AddApiKeyResponse AlgoliaApiException Exception thrown in case of API failure such as 4XX, 5XX error.AlgoliaRetryException Exception thrown when an error occurs during the retry strategy.AlgoliaRuntimeException Exception thrown when an error occurs during the Serialization/Deserialization processAlgoliaUtils Alternative Alternatives Alternatives may transform into JSON object in the future.AnalyticsClient Algolia's REST analytics client that wraps an instance of the transporterHttpTransportwhich wraps the HTTP Client This client allows to build typed requests and read typed responses.AnalyticsConfig AnalyticsConfig.Builder ApiKey ApiKeys AroundPrecision AroundRadius AssignUserIdRequest AssignUserIdResponse AssignUserIdsRequest AssignUserIdsResponse AutomaticFacetFilter Automatic facet filters parameter.BatchIndexingResponse BatchOperation<T> BatchRequest<T> BatchResponse BrowseIndexQuery BrowseIndexResponse<T> CallType ClearSynonymsResponse Cluster CompletableFutureUtils Compound Represents an entry for Compounds dictionary.CompoundType CompressionType Condition Condition parameter.ConfigBase Algolia's clients common configurationConfigBase.Builder<T extends ConfigBase.Builder<T>> Config base builder to ensure the immutability of the configuration.Consequence Consequence parameter.ConsequenceParams Consequence parameter.ConsequencePromote Consequence parameter.ConsequenceQuery Consequence parameter.CopyResponse CopyScope The “scope” parameter is an array of strings that refer to the following items:CopyToRequest CopyToResponse Defaults Class holding shared objects between all clients.DeleteAbTestResponse DeleteApiKeyResponse DeletePersonalizationProfileResponse Delete the user profile response.DeleteResponse Dictionary Represents a linguistic resources provided by Algolia.DictionaryEntry DictionaryRequest DictionaryResponse DictionarySettings Represents Dictionary settings.DisableStandardEntries Map of language ISO code supported by the dictionary (e.g., “en” for English) to a boolean value.Distinct Edit Edit parameter.EditType Edit type.EventScoring Deprecated. EventsScoring Explain FacetFilters Facet filters More information:FacetFiltersAsListOfList FacetFiltersAsListOfString FacetHit FacetOrdering Facets and facets values ordering rules container.FacetScoring Deprecated. FacetsOrder Define or override the way facet attributes are displayed.FacetsScoring FacetStats FacetValuesOrder Facet values ordering rule container.FlatListDeserializer FlatListSerializer FrequentlyBoughtTogetherQuery GetRecommendationsResponse<T extends RecommendHit> Response from Recommend API.GetStrategyResponse Deprecated. GetStrategyResponse HasPendingMappingsResponse Hide Hide parameter.HitsWithPosition<T> HmacShaUtils HttpMethod HttpRequest HttpRequester This contract allows you to inject a custom HTTPClient to any Algolia clients of the library.HttpResponse HttpStatusCodeUtils HttpTransport The transport layer is responsible of the serialization/deserialization and the retry strategy.IgnorePlurals IndexingResponse IndexIterable<E> IndexIterator<E> IndexSettings Here is the list of parameters you can use with the set settings method.IndicesResponse InnerQuery InsightsClient Algolia's REST insights client that wraps an instance of the transporterHttpTransportwhich wraps the HTTP Client This client allows to build typed requests and read typed responses.InsightsConfig InsightsConfig.Builder InsightsEvent InsightsRequest InsightsResult LaunderThrowable ListClustersResponse ListIndicesResponse ListUserIdsResponse Log Logs LogType MoveIndexRequest MoveIndexResponse MoveType MultipleGetObject MultipleGetObjectsRequest MultipleGetObjectsResponse<T> MultipleIndexBatchIndexingResponse MultipleQueries MultipleQueriesRequest MultipleQueriesResponse<T> MultiResponse PartialUpdateOperation<T> PartialUpdateOperationType PersonalizationClient Algolia's REST recommendation client that wraps an instance of the transporterHttpTransportwhich wraps the HTTP Client This client allows to build typed requests and read typed responses.PersonalizationConfig PersonalizationConfig.Builder PersonalizationProfileResponse User profile built from Personalization strategy.Plural Represents an entry for Plurals dictionary.Query Algolia Search QueryQueryMatch QuerySerializer Customer serializer to serialize an Algolia search query as URL parametersQueryStringUtils RecommendationClient Deprecated. usePersonalizationClientinsteadRecommendationConfig Deprecated. usePersonalizationConfiginsteadRecommendationConfig.Builder RecommendationsQuery RecommendationsRequests<T extends com.algolia.search.models.recommend.RecommendationsOptions> RecommendationsResult<T extends RecommendHit> Result of a recommendation request.RecommendClient Algolia's REST recommend client that wraps an instance of the transporterHttpTransportwhich wraps the HTTP Client This client allows to build typed requests and read typed responses.RecommendHit Recommend hit, similar to a search hit but associated with a score.RelatedProductsQuery RemoveStopWords RemoveUserIdResponse RemoveWordsType RenderingContent Content defining how the search interface should be rendered.RequestOptions Request options are used to pass extra parameters, headers, timeout to the request.RestoreApiKeyResponse RetryOutcome Rule Query Rules allows performing pre- and post-processing on queries matching specific patterns.RuleQuery Query Rules allows performing pre- and post-processing on queries matching specific patterns.RulesIterable RulesIterator SaveRuleResponse SaveSynonymResponse SearchClient Algolia's REST search client that wraps an instance of the transporterHttpTransportwhich wraps the HttpClient This client allows to build typed requests and read typed responses.SearchClientAdvanced SearchClientAPIKeys SearchClientBase SearchClientCopyOperations SearchClientDictionary SearchClientMcm SearchClientMultipleOperations SearchClientPersonalization SearchConfig SearchConfig.Builder SearchForFacetRequest SearchForFacetResponse SearchIndex<T> This class holds all endpoints for an Index.SearchIndexBase<T> This interface holds all index common methods.SearchIndexRules<T> This interface holds all endpoints for Query Rules.SearchIndexSearching<T> This interface holds all endpoints related to search.SearchIndexSettings<T> This interface holds all endpoints for Index Settings.SearchIndexSynonyms<T> This interface holds all endpoints for Synonyms.SearchParameters<T extends SearchParameters<T>> SearchResult<T> SearchUserIdsRequest SecuredApiKeyRestriction SetSettingsResponse SetStrategyRequest Deprecated. SetStrategyRequest SetStrategyResponse Deprecated. SetStrategyResponse StatefulHost StopAbTestResponse Stopword Represents an entry for Stopword dictionary.StrategyType Synonym Synonyms tell the engine which words and expressions should be considered equal - for example, pants ⇔ trousers or mad ⇔ angry.SynonymQuery Synonym query.SynonymsIterable SynonymsIterator SynonymType Synonym type.TaskStatusResponse TimeRange TopUserIdResponse TypoTolerance UpdateApiKeyResponse UpdateObjectResponse UserId UserInsightsClient Variant VariantWaitableResponse All write operations in Algolia are asynchronous by design.