Serialized Form (algoliasearch-core 3.16.5 API)

Package com.algolia.search.exceptions
- Class com.algolia.search.exceptions.AlgoliaApiException extends AlgoliaRuntimeException implements Serializable
  - Serialized Fields
    - httpErrorCode
      
      int httpErrorCode
- Class com.algolia.search.exceptions.AlgoliaRetryException extends AlgoliaRuntimeException implements Serializable
- Class com.algolia.search.exceptions.AlgoliaRuntimeException extends RuntimeException implements Serializable
Package com.algolia.search.models
- Class com.algolia.search.models.RequestOptions extends Object implements Serializable
  - Serialized Fields
    - headers
      
      Map<String,String> headers
    - queryParams
      
      Map<String,String> queryParams
    - timeout
      
      Integer timeout
Package com.algolia.search.models.analytics
- Class com.algolia.search.models.analytics.ABTest extends Object implements Serializable
  - Serialized Fields
    - endAt
      
      OffsetDateTime endAt
    - name
      
      String name
    - variants
      
      List<Variant> variants
- Class com.algolia.search.models.analytics.ABTestResponse extends ABTest implements Serializable
  - Serialized Fields
    - abTestID
      
      long abTestID
    - clickSignificance
      
      int clickSignificance
    - conversionSignificance
      
      int conversionSignificance
    - createdAt
      
      ZonedDateTime createdAt
    - status
      
      String status
- Class com.algolia.search.models.analytics.ABTests extends Object implements Serializable
  - Serialized Fields
    - abtests
      
      ArrayList<ABTestResponse> abtests
    - count
      
      int count
    - total
      
      int total
- Class com.algolia.search.models.analytics.AddABTestResponse extends Object implements Serializable
  - Serialized Fields
    - abTestID
      
      long abTestID
    - index
      
      String index
    - taskID
      
      long taskID
- Class com.algolia.search.models.analytics.DeleteAbTestResponse extends Object implements Serializable
  - Serialized Fields
    - index
      
      String index
    - taskID
      
      Long taskID
- Class com.algolia.search.models.analytics.StopAbTestResponse extends Object implements Serializable
  - Serialized Fields
    - index
      
      String index
    - taskID
      
      Long taskID
- Class com.algolia.search.models.analytics.Variant extends Object implements Serializable
  - Serialized Fields
    - averageClickPosition
      
      Float averageClickPosition
    - clickThroughRate
      
      Float clickThroughRate
    - conversionRate
      
      Float conversionRate
    - customSearchParameters
      
      Query customSearchParameters
    - description
      
      String description
    - index
      
      String index
    - noResultCount
      
      Integer noResultCount
    - searchCount
      
      Long searchCount
    - trackedSearchCount
      
      Long trackedSearchCount
    - trafficPercentage
      
      int trafficPercentage
    - userCount
      
      Long userCount
Package com.algolia.search.models.apikeys
- Class com.algolia.search.models.apikeys.AddApiKeyResponse extends Object implements Serializable
  - Serialized Fields
    - createdAt
      
      OffsetDateTime createdAt
    - getApiKeyFunction
      
      Function<String,ApiKey> getApiKeyFunction
    - key
      
      String key
- Class com.algolia.search.models.apikeys.ApiKey extends Object implements Serializable
  - Serialized Fields
    - acl
      
      List<String> acl
    - description
      
      String description
    - indexes
      
      List<String> indexes
    - maxHitsPerQuery
      
      Long maxHitsPerQuery
    - maxQueriesPerIPPerHour
      
      Integer maxQueriesPerIPPerHour
    - queryParameters
      
      String queryParameters
    - referers
      
      List<String> referers
    - validity
      
      Long validity
    - value
      
      String value
- Class com.algolia.search.models.apikeys.ApiKeys extends Object implements Serializable
  - Serialized Fields
    - keys
      
      List<ApiKey> keys
- Class com.algolia.search.models.apikeys.DeleteApiKeyResponse extends Object implements Serializable
  - Serialized Fields
    - deletedAt
      
      OffsetDateTime deletedAt
    - getApiKeyFunction
      
      Function<String,ApiKey> getApiKeyFunction
    - key
      
      String key
- Class com.algolia.search.models.apikeys.RestoreApiKeyResponse extends Object implements Serializable
  - Serialized Fields
    - createdAt
      
      OffsetDateTime createdAt
    - getApiKeyFunction
      
      Function<String,ApiKey> getApiKeyFunction
    - key
      
      String key
- Class com.algolia.search.models.apikeys.UpdateApiKeyResponse extends Object implements Serializable
  - Serialized Fields
    - getApiKeyFunction
      
      Function<String,ApiKey> getApiKeyFunction
    - key
      
      String key
    - pendingKey
      
      ApiKey pendingKey
    - updatedAt
      
      OffsetDateTime updatedAt
Package com.algolia.search.models.common
- Class com.algolia.search.models.common.InnerQuery extends Object implements Serializable
  - Serialized Fields
    - indexName
      
      String indexName
    - offset
      
      Integer offset
    - queryID
      
      String queryID
    - userToken
      
      String userToken
- Class com.algolia.search.models.common.Log extends Object implements Serializable
  - Serialized Fields
    - answer
      
      String answer
    - answerCode
      
      String answerCode
    - innerQueries
      
      List<InnerQuery> innerQueries
    - ip
      
      String ip
    - method
      
      String method
    - queryBody
      
      String queryBody
    - queryHeaders
      
      String queryHeaders
    - sha1
      
      String sha1
    - timestamp
      
      String timestamp
    - url
      
      String url
- Class com.algolia.search.models.common.Logs extends Object implements Serializable
  - Serialized Fields
    - logs
      
      List<Log> logs
- Class com.algolia.search.models.common.TaskStatusResponse extends Object implements Serializable
  - Serialized Fields
    - pendingTask
      
      boolean pendingTask
    - status
      
      String status
Package com.algolia.search.models.dictionary
- Class com.algolia.search.models.dictionary.Compound extends Object implements Serializable
  - Serialized Fields
    - decomposition
      
      List<String> decomposition
      
      When empty, the key word is considered as a compound atom. Otherwise, it is the decomposition of word.
    - language
      
      String language
    - objectID
      
      String objectID
    - word
      
      String word
      
      When decomposition is empty: adds word as a compound atom. For example, atom “kino” decomposes the query “kopfkino” into “kopf” and “kino”. When decomposition isn’t empty: creates a decomposition exception. For example, when decomposition is set to ["hund", "hutte"], exception “hundehutte” decomposes the word into “hund” and “hutte”, discarding the linking morpheme “e”.
- Class com.algolia.search.models.dictionary.DictionaryResponse extends Object implements Serializable
  - Serialized Fields
    - taskID
      
      Long taskID
    - updatedAt
      
      ZonedDateTime updatedAt
    - waitConsumer
      
      Consumer<Long> waitConsumer
- Class com.algolia.search.models.dictionary.DictionarySettings extends Object implements Serializable
  - Serialized Fields
    - disableStandardEntries
      
      DisableStandardEntries disableStandardEntries
- Class com.algolia.search.models.dictionary.DisableStandardEntries extends Object implements Serializable
  - Serialized Fields
    - stopwords
      
      Map<String,Boolean> stopwords
      
      Settings for the stop word dictionary.
- Class com.algolia.search.models.dictionary.Plural extends Object implements Serializable
  - Serialized Fields
    - language
      
      String language
    - objectID
      
      String objectID
    - words
      
      List<String> words
      
      List of word declensions. The entry overrides existing entries when any of these words are defined in the standard dictionary provided by Algolia.
- Class com.algolia.search.models.dictionary.Stopword extends Object implements Serializable
  - Serialized Fields
    - language
      
      String language
    - objectID
      
      String objectID
    - state
      
      String state
      
      The state of the entry. Can be either "enabled" or "disabled".
    - word
      
      String word
      
      The stop word being added or modified. When word already exists in the standard dictionary provided by Algolia, the entry can be overridden by the one provided by the user.
Package com.algolia.search.models.indexing
- Class com.algolia.search.models.indexing.AroundPrecision extends Object implements Serializable
  - Serialized Fields
    - from
      
      long from
    - value
      
      long value
- Class com.algolia.search.models.indexing.AroundRadius extends Object implements Serializable
- Class com.algolia.search.models.indexing.BatchIndexingResponse extends Object implements Serializable
  - Serialized Fields
    - responses
      
      List<BatchResponse> responses
- Class com.algolia.search.models.indexing.BatchOperation extends Object implements Serializable
  - Serialized Fields
    - action
      
      String action
    - body
      
      T body
    - indexName
      
      String indexName
- Class com.algolia.search.models.indexing.BatchRequest extends Object implements Serializable
  - Serialized Fields
    - requests
      
      List<BatchOperation<T>> requests
- Class com.algolia.search.models.indexing.BatchResponse extends IndexingResponse implements Serializable
  - Serialized Fields
    - objectIDs
      
      List<String> objectIDs
- Class com.algolia.search.models.indexing.BrowseIndexQuery extends SearchParameters<BrowseIndexQuery> implements Serializable
  - Serialized Fields
    - cursor
      
      String cursor
- Class com.algolia.search.models.indexing.BrowseIndexResponse extends SearchResult<T> implements Serializable
  - Serialized Fields
    - cursor
      
      String cursor
- Class com.algolia.search.models.indexing.CopyResponse extends Object implements Serializable
  - Serialized Fields
    - indexName
      
      String indexName
    - taskID
      
      Long taskID
    - updatedAt
      
      OffsetDateTime updatedAt
    - waitConsumer
      
      BiConsumer<String,Long> waitConsumer
- Class com.algolia.search.models.indexing.CopyToRequest extends Object implements Serializable
  - Serialized Fields
    - destination
      
      String destination
    - operation
      
      String operation
    - scope
      
      List<String> scope
- Class com.algolia.search.models.indexing.CopyToResponse extends IndexingResponse implements Serializable
  - Serialized Fields
    - updatedAt
      
      OffsetDateTime updatedAt
- Class com.algolia.search.models.indexing.DeleteResponse extends IndexingResponse implements Serializable
  - Serialized Fields
    - updatedAt
      
      ZonedDateTime updatedAt
- Class com.algolia.search.models.indexing.FacetHit extends Object implements Serializable
  - Serialized Fields
    - count
      
      Long count
    - highlighted
      
      String highlighted
    - value
      
      String value
- Class com.algolia.search.models.indexing.FacetStats extends Object implements Serializable
  - Serialized Fields
    - avg
      
      Float avg
    - max
      
      Float max
    - min
      
      Float min
    - sum
      
      Float sum
- Class com.algolia.search.models.indexing.FlatListDeserializer extends com.fasterxml.jackson.databind.deser.std.StdDeserializer<String> implements Serializable
- Class com.algolia.search.models.indexing.FlatListSerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<List<String>> implements Serializable
- Class com.algolia.search.models.indexing.IndexingResponse extends Object implements Serializable
  - Serialized Fields
    - taskID
      
      Long taskID
    - waitConsumer
      
      Consumer<Long> waitConsumer
- Class com.algolia.search.models.indexing.IndicesResponse extends Object implements Serializable
  - Serialized Fields
    - abTest
      
      ABTest abTest
    - createdAt
      
      OffsetDateTime createdAt
    - dataSize
      
      long dataSize
    - entries
      
      long entries
    - fileSize
      
      long fileSize
    - lastBuildTimes
      
      long lastBuildTimes
    - name
      
      String name
    - numberOfPendingTasks
      
      long numberOfPendingTasks
    - pendingTask
      
      boolean pendingTask
    - primary
      
      String primary
    - replicas
      
      List<String> replicas
    - sourceABTest
      
      String sourceABTest
    - updatedAt
      
      OffsetDateTime updatedAt
- Class com.algolia.search.models.indexing.ListIndicesResponse extends Object implements Serializable
  - Serialized Fields
    - items
      
      List<IndicesResponse> items
- Class com.algolia.search.models.indexing.MoveIndexRequest extends Object implements Serializable
  - Serialized Fields
    - destination
      
      String destination
    - operation
      
      String operation
- Class com.algolia.search.models.indexing.MoveIndexResponse extends Object implements Serializable
  - Serialized Fields
    - indexName
      
      String indexName
    - taskID
      
      Long taskID
    - updatedAt
      
      OffsetDateTime updatedAt
    - waitBiConsumer
      
      BiConsumer<String,Long> waitBiConsumer
    - waitConsumer
      
      Consumer<Long> waitConsumer
- Class com.algolia.search.models.indexing.MultipleGetObject extends Object implements Serializable
  - Serialized Fields
    - attributesToRetrieve
      
      List<String> attributesToRetrieve
    - indexName
      
      String indexName
    - objectID
      
      String objectID
- Class com.algolia.search.models.indexing.MultipleGetObjectsRequest extends Object implements Serializable
  - Serialized Fields
    - requests
      
      List<MultipleGetObject> requests
- Class com.algolia.search.models.indexing.MultipleGetObjectsResponse extends Object implements Serializable
  - Serialized Fields
    - results
      
      List<T> results
- Class com.algolia.search.models.indexing.MultipleIndexBatchIndexingResponse extends Object implements Serializable
  - Serialized Fields
    - objectIDs
      
      List<String> objectIDs
    - taskID
      
      Map<String,Long> taskID
    - waitConsumer
      
      BiConsumer<String,Long> waitConsumer
- Class com.algolia.search.models.indexing.MultipleQueries extends Object implements Serializable
  - Serialized Fields
    - indexName
      
      String indexName
    - params
      
      Query params
- Class com.algolia.search.models.indexing.MultipleQueriesRequest extends Object implements Serializable
  - Serialized Fields
    - requests
      
      List<MultipleQueries> requests
    - strategy
      
      String strategy
- Class com.algolia.search.models.indexing.MultipleQueriesResponse extends Object implements Serializable
  - Serialized Fields
    - results
      
      List<SearchResult<T>> results
- Class com.algolia.search.models.indexing.MultiResponse extends Object implements Serializable
  - Serialized Fields
    - responses
      
      List<WaitableResponse> responses
- Class com.algolia.search.models.indexing.Query extends SearchParameters<Query> implements Serializable
- Class com.algolia.search.models.indexing.QuerySerializer extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Query> implements Serializable
- Class com.algolia.search.models.indexing.RecommendationsResult extends SearchResult<T extends RecommendHit> implements Serializable
- Class com.algolia.search.models.indexing.SearchForFacetRequest extends Object implements Serializable
  - Serialized Fields
    - facetName
      
      String facetName
    - facetQuery
      
      String facetQuery
    - searchParameters
      
      Query searchParameters
- Class com.algolia.search.models.indexing.SearchForFacetResponse extends Object implements Serializable
  - Serialized Fields
    - ExhaustiveFacetsCount
      
      Boolean ExhaustiveFacetsCount
    - facetHits
      
      List<FacetHit> facetHits
    - processingTimeMS
      
      Integer processingTimeMS
- Class com.algolia.search.models.indexing.SearchParameters extends Object implements Serializable
  - Serialized Fields
    - advancedSyntax
      
      Boolean advancedSyntax
    - advancedSyntaxFeatures
      
      List<String> advancedSyntaxFeatures
    - allowTyposOnNumericTokens
      
      Boolean allowTyposOnNumericTokens
    - alternativesAsExact
      
      List<String> alternativesAsExact
    - analytics
      
      Boolean analytics
    - analyticsTags
      
      List<String> analyticsTags
    - aroundLatLng
      
      String aroundLatLng
    - aroundLatLngViaIP
      
      Boolean aroundLatLngViaIP
    - aroundPrecision
      
      List<AroundPrecision> aroundPrecision
    - aroundRadius
      
      AroundRadius aroundRadius
    - attributesToHighlight
      
      List<String> attributesToHighlight
    - attributesToRetrieve
      
      List<String> attributesToRetrieve
    - attributesToSnippet
      
      List<String> attributesToSnippet
    - clickAnalytics
      
      Boolean clickAnalytics
    - customParameters
      
      Map<String,Object> customParameters
    - decompoundQuery
      
      Boolean decompoundQuery
    - disableExactOnAttributes
      
      List<String> disableExactOnAttributes
    - disableTypoToleranceOnAttributes
      
      List<String> disableTypoToleranceOnAttributes
    - distinct
      
      Distinct distinct
    - enableABTest
      
      Boolean enableABTest
    - enablePersonalization
      
      Boolean enablePersonalization
    - enableReRanking
      
      Boolean enableReRanking
    - enableRules
      
      Boolean enableRules
    - exactOnSingleWordQuery
      
      String exactOnSingleWordQuery
    - explain
      
      List<String> explain
    - facetFilters
      
      List<List<String>> facetFilters
    - facetingAfterDistinct
      
      Boolean facetingAfterDistinct
    - facets
      
      List<String> facets
    - filters
      
      String filters
    - getRankingInfo
      
      Boolean getRankingInfo
    - highlightPostTag
      
      String highlightPostTag
    - highlightPreTag
      
      String highlightPreTag
    - hitsPerPage
      
      Integer hitsPerPage
    - ignorePlurals
      
      IgnorePlurals ignorePlurals
    - insideBoundingBox
      
      List<List<Float>> insideBoundingBox
    - insidePolygon
      
      List<List<Float>> insidePolygon
    - length
      
      Integer length
    - maxFacetHits
      
      Long maxFacetHits
    - maxValuesPerFacet
      
      Long maxValuesPerFacet
    - minimumAroundRadius
      
      Integer minimumAroundRadius
    - minProximity
      
      Integer minProximity
    - minWordSizefor1Typo
      
      Integer minWordSizefor1Typo
    - minWordSizefor2Typos
      
      Integer minWordSizefor2Typos
    - naturalLanguages
      
      List<String> naturalLanguages
    - numericFilters
      
      List<List<String>> numericFilters
    - offset
      
      Integer offset
    - optionalFilters
      
      List<List<String>> optionalFilters
    - optionalWords
      
      List<String> optionalWords
    - page
      
      Integer page
    - percentileComputation
      
      Boolean percentileComputation
    - personalizationImpact
      
      Integer personalizationImpact
    - query
      
      String query
    - queryLanguages
      
      List<String> queryLanguages
    - queryType
      
      String queryType
    - relevancyStrictness
      
      Integer relevancyStrictness
    - removeStopWords
      
      RemoveStopWords removeStopWords
    - removeWordsIfNoResults
      
      RemoveWordsType removeWordsIfNoResults
    - replaceSynonymsInHighlight
      
      Boolean replaceSynonymsInHighlight
    - responseFields
      
      List<String> responseFields
    - restrictHighlightAndSnippetArrays
      
      Boolean restrictHighlightAndSnippetArrays
    - restrictIndices
      
      List<String> restrictIndices
    - restrictSearchableAttributes
      
      List<String> restrictSearchableAttributes
    - restrictSources
      
      String restrictSources
    - ruleContexts
      
      List<String> ruleContexts
    - similarQuery
      
      String similarQuery
    - snippetEllipsisText
      
      String snippetEllipsisText
    - sortFacetValuesBy
      
      String sortFacetValuesBy
    - sumOrFiltersScores
      
      Boolean sumOrFiltersScores
    - synonyms
      
      Boolean synonyms
    - tagFilters
      
      List<List<String>> tagFilters
    - typoTolerance
      
      TypoTolerance typoTolerance
    - userToken
      
      String userToken
    - validUntil
      
      Integer validUntil
- Class com.algolia.search.models.indexing.SearchResult extends Object implements Serializable
  - Serialized Fields
    - abTestVariantID
      
      Long abTestVariantID
    - appliedRelevancyStrictness
      
      Integer appliedRelevancyStrictness
    - appliedRules
      
      List<Map<String,Object>> appliedRules
    - aroundLatLng
      
      String aroundLatLng
    - automaticRadius
      
      String automaticRadius
    - exhaustiveFacetsCount
      
      Boolean exhaustiveFacetsCount
    - exhaustiveNbHits
      
      Boolean exhaustiveNbHits
    - explain
      
      Explain explain
    - facets
      
      Map<String,Map<String,Long>> facets
    - facets_stats
      
      Map<String,FacetStats> facets_stats
    - hits
      
      List<T> hits
    - hitsPerPage
      
      Long hitsPerPage
    - index
      
      String index
    - indexUsed
      
      String indexUsed
    - length
      
      Long length
    - message
      
      String message
    - nbHits
      
      Long nbHits
    - nbPages
      
      Long nbPages
    - nbSortedHits
      
      Integer nbSortedHits
    - offset
      
      Long offset
    - page
      
      Long page
    - params
      
      String params
    - parsedQuery
      
      String parsedQuery
    - processed
      
      Boolean processed
    - processingTimeMS
      
      Long processingTimeMS
    - query
      
      String query
    - queryAfterRemoval
      
      String queryAfterRemoval
    - queryID
      
      String queryID
    - renderingContent
      
      RenderingContent renderingContent
    - serverUsed
      
      String serverUsed
    - userData
      
      List<Map<String,Object>> userData
- Class com.algolia.search.models.indexing.UpdateObjectResponse extends IndexingResponse implements Serializable
  - Serialized Fields
    - objectID
      
      String objectID
    - updatedAt
      
      ZonedDateTime updatedAt
Package com.algolia.search.models.insights
- Class com.algolia.search.models.insights.InsightsEvent extends Object implements Serializable
  - Serialized Fields
    - eventName
      
      String eventName
    - eventType
      
      String eventType
    - filters
      
      List<String> filters
    - index
      
      String index
    - objectIDs
      
      List<String> objectIDs
    - positions
      
      List<Long> positions
    - queryID
      
      String queryID
    - timestamp
      
      Long timestamp
    - userToken
      
      String userToken
- Class com.algolia.search.models.insights.InsightsRequest extends Object implements Serializable
  - Serialized Fields
    - events
      
      List<InsightsEvent> events
- Class com.algolia.search.models.insights.InsightsResult extends Object implements Serializable
  - Serialized Fields
    - message
      
      String message
    - status
      
      int status
Package com.algolia.search.models.mcm
- Class com.algolia.search.models.mcm.AssignUserIdRequest extends Object implements Serializable
  - Serialized Fields
    - cluster
      
      String cluster
- Class com.algolia.search.models.mcm.AssignUserIdResponse extends Object implements Serializable
  - Serialized Fields
    - createdAt
      
      ZonedDateTime createdAt
    - userId
      
      String userId
- Class com.algolia.search.models.mcm.AssignUserIdsRequest extends Object implements Serializable
  - Serialized Fields
    - cluster
      
      String cluster
    - users
      
      List<String> users
- Class com.algolia.search.models.mcm.AssignUserIdsResponse extends Object implements Serializable
  - Serialized Fields
    - createdAt
      
      ZonedDateTime createdAt
- Class com.algolia.search.models.mcm.Cluster extends Object implements Serializable
  - Serialized Fields
    - clusterName
      
      String clusterName
    - dataSize
      
      Long dataSize
    - nbRecords
      
      Long nbRecords
    - nbUserIDs
      
      Integer nbUserIDs
- Class com.algolia.search.models.mcm.HasPendingMappingsResponse extends Object implements Serializable
  - Serialized Fields
    - clusters
      
      Map<String,List<String>> clusters
    - pending
      
      Boolean pending
- Class com.algolia.search.models.mcm.ListClustersResponse extends Object implements Serializable
  - Serialized Fields
    - clusters
      
      List<Cluster> clusters
- Class com.algolia.search.models.mcm.ListUserIdsResponse extends Object implements Serializable
  - Serialized Fields
    - userIDs
      
      List<UserId> userIDs
- Class com.algolia.search.models.mcm.RemoveUserIdResponse extends Object implements Serializable
  - Serialized Fields
    - deletedAt
      
      ZonedDateTime deletedAt
    - userId
      
      String userId
- Class com.algolia.search.models.mcm.SearchUserIdsRequest extends Object implements Serializable
  - Serialized Fields
    - cluster
      
      String cluster
    - hitsPerPage
      
      Integer hitsPerPage
    - page
      
      Integer page
    - query
      
      String query
- Class com.algolia.search.models.mcm.TopUserIdResponse extends Object implements Serializable
  - Serialized Fields
    - topUsers
      
      HashMap<String,List<UserId>> topUsers
- Class com.algolia.search.models.mcm.UserId extends Object implements Serializable
  - Serialized Fields
    - clusterName
      
      String clusterName
    - dataSize
      
      Integer dataSize
    - nbRecords
      
      Integer nbRecords
    - userID
      
      String userID
Package com.algolia.search.models.personalization
- Class com.algolia.search.models.personalization.EventScoring extends Object implements Serializable
  - Serialized Fields
    - score
      
      long score
      
      Deprecated.
    - type
      
      String type
      
      Deprecated.
- Class com.algolia.search.models.personalization.FacetScoring extends Object implements Serializable
  - Serialized Fields
    - score
      
      long score
      
      Deprecated.
- Class com.algolia.search.models.personalization.GetStrategyResponse extends Object implements Serializable
  - Serialized Fields
    - eventsScoring
      
      Map<String,EventScoring> eventsScoring
      
      Deprecated.
    - facetsScoring
      
      Map<String,FacetScoring> facetsScoring
      
      Deprecated.
    - taskId
      
      Long taskId
      
      Deprecated.
- Class com.algolia.search.models.personalization.SetStrategyRequest extends Object implements Serializable
  - Serialized Fields
    - eventsScoring
      
      Map<String,EventScoring> eventsScoring
      
      Deprecated.
    - facetsScoring
      
      Map<String,FacetScoring> facetsScoring
      
      Deprecated.
- Class com.algolia.search.models.personalization.SetStrategyResponse extends Object implements Serializable
  - Serialized Fields
    - updatedAt
      
      ZonedDateTime updatedAt
      
      Deprecated.
Package com.algolia.search.models.recommend
- Class com.algolia.search.models.recommend.GetRecommendationsResponse extends Object implements Serializable
  - Serialized Fields
    - results
      
      List<RecommendationsResult<T extends RecommendHit>> results
      
      List of results in the order they were submitted, one per request.
Package com.algolia.search.models.recommendation
- Class com.algolia.search.models.recommendation.EventsScoring extends Object implements Serializable
  - Serialized Fields
    - eventName
      
      String eventName
    - eventType
      
      String eventType
    - score
      
      int score
- Class com.algolia.search.models.recommendation.FacetsScoring extends Object implements Serializable
  - Serialized Fields
    - facetName
      
      String facetName
    - score
      
      int score
- Class com.algolia.search.models.recommendation.GetStrategyResponse extends Object implements Serializable
  - Serialized Fields
    - eventsScoring
      
      List<EventsScoring> eventsScoring
    - facetsScoring
      
      List<FacetsScoring> facetsScoring
    - personalizationImpact
      
      Integer personalizationImpact
- Class com.algolia.search.models.recommendation.SetStrategyRequest extends Object implements Serializable
  - Serialized Fields
    - eventsScoring
      
      List<EventsScoring> eventsScoring
    - facetsScoring
      
      List<FacetsScoring> facetsScoring
    - personalizationImpact
      
      int personalizationImpact
- Class com.algolia.search.models.recommendation.SetStrategyResponse extends Object implements Serializable
  - Serialized Fields
    - message
      
      String message
    - status
      
      Integer status
Package com.algolia.search.models.rules
- Class com.algolia.search.models.rules.Alternatives extends Object implements Serializable
- Class com.algolia.search.models.rules.AutomaticFacetFilter extends Object implements Serializable
  - Serialized Fields
    - disjunctive
      
      Boolean disjunctive
    - facet
      
      String facet
    - score
      
      Integer score
- Class com.algolia.search.models.rules.Condition extends Object implements Serializable
  - Serialized Fields
    - alternatives
      
      Alternatives alternatives
    - anchoring
      
      String anchoring
    - context
      
      String context
    - filters
      
      String filters
    - pattern
      
      String pattern
- Class com.algolia.search.models.rules.Consequence extends Object implements Serializable
  - Serialized Fields
    - filterPromotes
      
      Boolean filterPromotes
    - hide
      
      List<Hide> hide
    - params
      
      ConsequenceParams params
    - promote
      
      List<ConsequencePromote> promote
    - userData
      
      Map<String,Object> userData
- Class com.algolia.search.models.rules.ConsequenceParams extends SearchParameters<ConsequenceParams> implements Serializable
  - Serialized Fields
    - automaticFacetFilters
      
      List<AutomaticFacetFilter> automaticFacetFilters
    - automaticOptionalFacetFilters
      
      List<AutomaticFacetFilter> automaticOptionalFacetFilters
    - query
      
      ConsequenceQuery query
    - renderingContent
      
      RenderingContent renderingContent
- Class com.algolia.search.models.rules.ConsequencePromote extends Object implements Serializable
  - Serialized Fields
    - objectID
      
      String objectID
    - objectIDs
      
      List<String> objectIDs
    - position
      
      Integer position
- Class com.algolia.search.models.rules.ConsequenceQuery extends Object implements Serializable
  - Serialized Fields
    - edits
      
      List<Edit> edits
    - queryString
      
      String queryString
- Class com.algolia.search.models.rules.Edit extends Object implements Serializable
  - Serialized Fields
    - delete
      
      String delete
    - insert
      
      String insert
    - type
      
      String type
- Class com.algolia.search.models.rules.FacetFilters extends Object implements Serializable
- Class com.algolia.search.models.rules.FacetFiltersAsListOfList extends FacetFilters implements Serializable
  - Serialized Fields
    - filters
      
      List<List<String>> filters
- Class com.algolia.search.models.rules.FacetFiltersAsListOfString extends FacetFilters implements Serializable
  - Serialized Fields
    - filters
      
      List<String> filters
- Class com.algolia.search.models.rules.FacetOrdering extends Object implements Serializable
  - Serialized Fields
    - facets
      
      FacetsOrder facets
    - values
      
      Map<String,FacetValuesOrder> values
- Class com.algolia.search.models.rules.FacetsOrder extends Object implements Serializable
  - Serialized Fields
    - order
      
      List<String> order
- Class com.algolia.search.models.rules.FacetValuesOrder extends Object implements Serializable
  - Serialized Fields
    - order
      
      List<String> order
    - sortRemainingBy
      
      String sortRemainingBy
- Class com.algolia.search.models.rules.RenderingContent extends Object implements Serializable
  - Serialized Fields
    - facetOrdering
      
      FacetOrdering facetOrdering
- Class com.algolia.search.models.rules.Rule extends Object implements Serializable
  - Serialized Fields
    - condition
      
      Condition condition
    - conditions
      
      List<Condition> conditions
    - consequence
      
      Consequence consequence
    - description
      
      String description
    - enabled
      
      Boolean enabled
    - objectID
      
      String objectID
    - validity
      
      List<TimeRange> validity
- Class com.algolia.search.models.rules.RuleQuery extends Object implements Serializable
  - Serialized Fields
    - anchoring
      
      String anchoring
    - context
      
      String context
    - enabled
      
      Boolean enabled
    - hitsPerPage
      
      Long hitsPerPage
    - page
      
      Long page
    - query
      
      String query
- Class com.algolia.search.models.rules.SaveRuleResponse extends IndexingResponse implements Serializable
  - Serialized Fields
    - updatedAt
      
      OffsetDateTime updatedAt
- Class com.algolia.search.models.rules.TimeRange extends Object implements Serializable
  - Serialized Fields
    - from
      
      OffsetDateTime from
    - until
      
      OffsetDateTime until

Package com.algolia.search.models.settings

Class com.algolia.search.models.settings.Distinct extends Object implements Serializable
Class com.algolia.search.models.settings.IgnorePlurals extends Object implements Serializable

Class com.algolia.search.models.settings.IndexSettings extends Object implements Serializable

Serialized Fields

advancedSyntax
```
Boolean advancedSyntax
```
advancedSyntaxFeatures
```
List<String> advancedSyntaxFeatures
```
allowCompressionOfIntegerArray
```
Boolean allowCompressionOfIntegerArray
```
allowTyposOnNumericTokens
```
Boolean allowTyposOnNumericTokens
```
alternativesAsExact
```
List<String> alternativesAsExact
```

attributeCriteriaComputedByMinProximity

Boolean attributeCriteriaComputedByMinProximity

attributeForDistinct
```
String attributeForDistinct
```
attributesForFaceting
```
List<String> attributesForFaceting
```
attributesToHighlight
```
List<String> attributesToHighlight
```
attributesToRetrieve
```
List<String> attributesToRetrieve
```
attributesToSnippet
```
List<String> attributesToSnippet
```
attributesToTransliterate
```
List<String> attributesToTransliterate
```
camelCaseAttributes
```
List<String> camelCaseAttributes
```

customNormalization

Map<String,Map<String,String>> customNormalization

customRanking
```
List<String> customRanking
```
customSettings
```
Map<String,Object> customSettings
```

decompoundedAttributes

Map<String,List<String>> decompoundedAttributes

decompoundQuery
```
Boolean decompoundQuery
```
disableExactOnAttributes
```
List<String> disableExactOnAttributes
```
disablePrefixOnAttributes
```
List<String> disablePrefixOnAttributes
```

disableTypoToleranceOnAttributes

List<String> disableTypoToleranceOnAttributes

disableTypoToleranceOnWords

List<String> disableTypoToleranceOnWords

distinct
```
Distinct distinct
```
enablePersonalization
```
Boolean enablePersonalization
```
enableRules
```
Boolean enableRules
```
exactOnSingleWordQuery
```
String exactOnSingleWordQuery
```
highlightPostTag
```
String highlightPostTag
```
highlightPreTag
```
String highlightPreTag
```
hitsPerPage
```
Long hitsPerPage
```
ignorePlurals
```
IgnorePlurals ignorePlurals
```
indexLanguages
```
List<String> indexLanguages
```
keepDiacriticsOnCharacters
```
String keepDiacriticsOnCharacters
```
maxFacetHits
```
Integer maxFacetHits
```
maxValuesPerFacet
```
Long maxValuesPerFacet
```
minProximity
```
Integer minProximity
```
minWordSizefor1Typo
```
Integer minWordSizefor1Typo
```
minWordSizefor2Typos
```
Integer minWordSizefor2Typos
```

numericAttributesForFiltering

List<String> numericAttributesForFiltering

optionalWords
```
List<String> optionalWords
```
paginationLimitedTo
```
Long paginationLimitedTo
```
primary
```
String primary
```
queryLanguages
```
List<String> queryLanguages
```
queryType
```
String queryType
```
ranking
```
List<String> ranking
```
relevancyStrictness
```
Integer relevancyStrictness
```
removeStopWords
```
RemoveStopWords removeStopWords
```
removeWordsIfNoResults
```
String removeWordsIfNoResults
```
renderingContent
```
RenderingContent renderingContent
```
replaceSynonymsInHighlight
```
Boolean replaceSynonymsInHighlight
```
replicas
```
List<String> replicas
```
responseFields
```
List<String> responseFields
```

restrictHighlightAndSnippetArrays

Boolean restrictHighlightAndSnippetArrays

searchableAttributes
```
List<String> searchableAttributes
```
separatorsToIndex
```
String separatorsToIndex
```
snippetEllipsisText
```
String snippetEllipsisText
```
sortFacetValuesBy
```
String sortFacetValuesBy
```
typoTolerance
```
TypoTolerance typoTolerance
```
unretrievableAttributes
```
List<String> unretrievableAttributes
```
userData
```
Map<String,Object> userData
```

Class com.algolia.search.models.settings.RemoveStopWords extends Object implements Serializable
Class com.algolia.search.models.settings.SetSettingsResponse extends IndexingResponse implements Serializable
- Serialized Fields
  - updatedAt
```
ZonedDateTime updatedAt
```
Class com.algolia.search.models.settings.TypoTolerance extends Object implements Serializable

Package com.algolia.search.models.synonyms
- Class com.algolia.search.models.synonyms.ClearSynonymsResponse extends IndexingResponse implements Serializable
  - Serialized Fields
    - updatedAt
      
      OffsetDateTime updatedAt
- Class com.algolia.search.models.synonyms.SaveSynonymResponse extends IndexingResponse implements Serializable
  - Serialized Fields
    - id
      
      String id
    - updatedAt
      
      OffsetDateTime updatedAt
- Class com.algolia.search.models.synonyms.Synonym extends Object implements Serializable
  - Serialized Fields
    - corrections
      
      List<String> corrections
    - input
      
      String input
    - objectID
      
      String objectID
    - placeholder
      
      String placeholder
    - replacements
      
      List<String> replacements
    - synonyms
      
      List<String> synonyms
    - type
      
      String type
    - word
      
      String word
- Class com.algolia.search.models.synonyms.SynonymQuery extends Object implements Serializable
  - Serialized Fields
    - hitsPerPage
      
      Long hitsPerPage
    - page
      
      Long page
    - query
      
      String query
    - type
      
      List<String> type

Serialized Form

Package com.algolia.search.exceptions

Class com.algolia.search.exceptions.AlgoliaApiException extends AlgoliaRuntimeException implements Serializable

Serialized Fields

httpErrorCode

Class com.algolia.search.exceptions.AlgoliaRetryException extends AlgoliaRuntimeException implements Serializable

Class com.algolia.search.exceptions.AlgoliaRuntimeException extends RuntimeException implements Serializable

Package com.algolia.search.models

Class com.algolia.search.models.RequestOptions extends Object implements Serializable

Serialized Fields

headers

queryParams

timeout

Package com.algolia.search.models.analytics

Class com.algolia.search.models.analytics.ABTest extends Object implements Serializable

Serialized Fields

endAt

name

variants

Class com.algolia.search.models.analytics.ABTestResponse extends ABTest implements Serializable

Serialized Fields

abTestID

clickSignificance

conversionSignificance

createdAt

status

Class com.algolia.search.models.analytics.ABTests extends Object implements Serializable

Serialized Fields

abtests

count

total

Class com.algolia.search.models.analytics.AddABTestResponse extends Object implements Serializable

Serialized Fields

abTestID

index

taskID

Class com.algolia.search.models.analytics.DeleteAbTestResponse extends Object implements Serializable

Serialized Fields

index

taskID

Class com.algolia.search.models.analytics.StopAbTestResponse extends Object implements Serializable

Serialized Fields

index

taskID

Class com.algolia.search.models.analytics.Variant extends Object implements Serializable

Serialized Fields

averageClickPosition

clickThroughRate

conversionRate

customSearchParameters

description

index

noResultCount

searchCount

trackedSearchCount

trafficPercentage

userCount

Package com.algolia.search.models.apikeys

Class com.algolia.search.models.apikeys.AddApiKeyResponse extends Object implements Serializable

Serialized Fields

createdAt

getApiKeyFunction

key

Class com.algolia.search.models.apikeys.ApiKey extends Object implements Serializable

Serialized Fields

acl

description

indexes

maxHitsPerQuery

maxQueriesPerIPPerHour

queryParameters

referers

validity

value

Class com.algolia.search.models.apikeys.ApiKeys extends Object implements Serializable

Serialized Fields

keys

Class com.algolia.search.models.apikeys.DeleteApiKeyResponse extends Object implements Serializable

Serialized Fields

deletedAt