Packages

p

algolia

definitions

package definitions

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. case class AddABTestDefinition(abtest: ABTest)(implicit formats: Formats) extends Definition with Product with Serializable
  2. case class AddKeyDefinition(key: ApiKey, indexName: Option[String] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  3. case class AppTaskStatusDefinition(taskId: Long, requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  4. case class AssignUserIDDefinition(assignment: UserIDAssignment, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  5. case class AssignUserIDsDefinition(assignment: UserIDsAssignment, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  6. sealed trait BatchDictionaryDefinition extends Definition
  7. trait BatchOperationUtils extends AnyRef
  8. case class BatchRulesDefinition(rules: Iterable[Rule], index: Option[String] = None, forwardToReplicas: Option[ForwardToReplicas] = None, clearExistingRules: Option[ClearExistingRules] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  9. case class BatchSynonymsDefinition(synonyms: Iterable[AbstractSynonym], index: Option[String] = None, forward: Option[ForwardToReplicas] = None, replace: Option[ClearExistingSynonyms] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  10. case class BrowseIndexDefinition(source: String, query: Option[Query] = None, cursor: Option[String] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  11. case class ClearDictionaryDefinition(dictionary: Dictionary[DictionaryEntry], requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends BatchDictionaryDefinition with Product with Serializable
  12. case class ClearIndexDefinition(index: String, requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  13. case class ClearRulesDefinition(index: Option[String] = None, option: Option[ForwardToReplicas] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  14. case class ClearSynonymsDefinition(index: Option[String] = None, option: Option[ForwardToReplicas] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  15. case class CopyIndexDefinition(source: String, destination: Option[String] = None, scope: Option[Seq[String]] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  16. case class CustomRequestDefinition(customRequest: CustomRequest)(implicit formats: Formats) extends Definition with Product with Serializable
  17. trait Definition extends AnyRef
  18. case class DeleteABTestDefinition(id: Int)(implicit formats: Formats) extends Definition with Product with Serializable
  19. case class DeleteByDefinition(index: Option[String], query: Query, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  20. case class DeleteDictionaryDefinition(dictionary: Dictionary[DictionaryEntry], objectIDs: Seq[String] = List(), requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends BatchDictionaryDefinition with Product with Serializable
  21. case class DeleteIndexDefinition(index: String, requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  22. case class DeleteKeyDefinition(keyName: String, indexName: Option[String] = None, requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  23. case class DeleteObjectDefinition(index: Option[String] = None, oid: Option[String] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  24. case class DeletePersonalizationProfileDefinition(userToken: String, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  25. case class DeleteRuleDefinition(objectId: String, index: Option[String] = None, option: Option[ForwardToReplicas] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  26. case class DeleteSynonymDefinition(synId: String, index: Option[String] = None, option: Option[ForwardToReplicas] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  27. case class GeStrategyDefinition(requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  28. case class GetABTestDefinition(id: Int)(implicit formats: Formats) extends Definition with Product with Serializable
  29. case class GetABTestsDefinition(offset: Int = 0, limit: Int = 10)(implicit formats: Formats) extends Definition with Product with Serializable
  30. case class GetKeyDefinition(keyName: String, indexName: Option[String] = None, requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  31. case class GetObjectDefinition(index: Option[String] = None, oid: Option[String] = None, attributesToRetrieve: Iterable[String] = Iterable.empty, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  32. case class GetObjectsDefinition(index: Option[String], oids: Seq[String] = Seq(), requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  33. case class GetPersonalizationProfileDefinition(userToken: String, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  34. case class GetRecommendationDefinition(queries: List[RecommendationsOptions], requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  35. case class GetRuleDefinition(objectId: String, index: Option[String] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  36. case class GetSettingsDictionaryDefinition(requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  37. case class GetSynonymDefinition(synId: String, index: Option[String] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  38. case class GetTopUserIDDefinition(requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  39. case class GetUserIDDefinition(userID: String, requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  40. case class HadPendingMappingsDefinition(pending: Boolean = false, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  41. case class IndexChangeSettingsDefinition(index: String, settings: IndexSettings, forward: Option[ForwardToReplicas] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  42. case class IndexSettingsDefinition(index: String, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  43. case class IndexingBatchDefinition(index: String, definitions: Iterable[Definition] = Iterable(), requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with BatchOperationUtils with Product with Serializable
  44. case class IndexingDefinition(index: String, objectId: Option[String] = None, obj: Option[AnyRef] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  45. trait IndexingDsl extends AnyRef
  46. case class InsightsEventDefinition(events: Iterable[InsightsEvent], requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  47. case class ListClustersDefinition(requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  48. case class ListIndexesDefinition(requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  49. case class ListKeysDefinition(indexName: Option[String] = None, requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  50. case class ListUserIDsDefinition(page: Int = 0, hitsPerPage: Int = 20, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  51. case class LogsDefinition(offset: Option[Int] = None, length: Option[Int] = None, type: Option[LogType] = None, requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  52. case class MoveIndexDefinition(source: String, destination: Option[String] = None, scope: Option[Seq[String]] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  53. case class MultiQueriesDefinition(definitions: Iterable[SearchDefinition], strategy: Option[Strategy] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  54. case class PartialUpdateObjectDefinition(index: Option[String] = None, objectId: Option[String] = None, attribute: Option[String] = None, value: Option[Any] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  55. case class PartialUpdateObjectOperationDefinition(operation: Operation, index: Option[String] = None, objectId: Option[String] = None, attribute: Option[String] = None, value: Option[Any] = None, createIfNotExists: Boolean = true, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  56. case class PartialUpdateOneObjectDefinition(index: String, object: Option[ObjectID] = None, createIfNotExists: Boolean = true, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  57. case class RemoveUserIDDefinition(userID: String, requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  58. case class ReplaceDictionaryDefinition[A <: DictionaryEntry](dictionary: Dictionary[A], dictionaryEntries: Seq[A] = List(), requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends BatchDictionaryDefinition with Product with Serializable
  59. case class RestoreKeyDefinition(key: String, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  60. case class SafeDeleteObjectDefinition(op: SafeDeleteObjectOperation, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  61. case class SaveDictionaryDefinition[A <: DictionaryEntry](dictionary: Dictionary[A], dictionaryEntries: Seq[A] = List(), requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends BatchDictionaryDefinition with Product with Serializable
  62. case class SaveRuleDefinition(rule: Rule, index: Option[String] = None, forwardToReplicas: Option[ForwardToReplicas] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  63. case class SaveSynonymDefinition(synonym: AbstractSynonym, index: Option[String] = None, option: Option[ForwardToReplicas] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  64. case class SearchDefinition(index: String, query: Option[Query] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  65. case class SearchDictionaryDefinition[A <: DictionaryEntry](dictionary: Dictionary[A], query: QueryDictionary = QueryDictionary(), requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  66. case class SearchFacetDefinition(index: String, facetName: String, values: String, query: Query = Query(), requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  67. case class SearchRulesDefinition(indx: Option[String] = None, query: Option[QueryRules] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  68. case class SearchSynonymsDefinition(indx: Option[String] = None, query: Option[QuerySynonyms] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  69. case class SearchUserIDDefinition(query: String, cluster: String = "", page: Int = 0, hitsPerPage: Int = 20, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  70. case class SetSettingsDictionaryDefinition(dictionarySettings: DictionarySettings, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  71. case class SetStrategyDefinition(s: SetStrategyRequest, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  72. case class StopABTestDefinition(id: Int)(implicit formats: Formats) extends Definition with Product with Serializable
  73. sealed trait TaskDefinition extends Definition
  74. case class TaskStatusDefinition(taskId: Long, index: Option[String] = None, requestOptions: Option[RequestOptions] = None) extends Definition with Product with Serializable
  75. case class UpdateKeyDefinition(keyName: String, key: Option[ApiKey] = None, indexName: Option[String] = None, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
  76. case class WaitForAppTaskDefinition(taskId: Long, baseDelay: Long = 100, maxDelay: Long = Long.MaxValue, requestOptions: Option[RequestOptions] = None) extends TaskDefinition with Product with Serializable
  77. case class WaitForTaskDefinition(taskId: Long, index: Option[String] = None, baseDelay: Long = 100, maxDelay: Long = Long.MaxValue, requestOptions: Option[RequestOptions] = None) extends TaskDefinition with Product with Serializable
  78. case class WaitForTimeoutException(message: String) extends Exception with Product with Serializable
  79. case class BatchDefinition(definitions: Iterable[Definition], requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with BatchOperationUtils with Product with Serializable
    Annotations
    @deprecated
    Deprecated

    Send one batch per index. Use IndexingBatchDefinition instead.

  80. case class GetPersonalizationStrategyDefinition(requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
    Annotations
    @deprecated
    Deprecated

    (Since version 1.41.0) use personalization instead

  81. case class GetRecommendationStrategyDefinition(requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
    Annotations
    @deprecated
    Deprecated

    (Since version 1.41.0) use personalization instead

  82. case class SetPersonalizationStrategyDefinition(s: Strategy, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
    Annotations
    @deprecated
    Deprecated

    (Since version 1.41.0) use personalization instead

  83. case class SetRecommendationStrategyDefinition(s: SetStrategyRequest, requestOptions: Option[RequestOptions] = None)(implicit formats: Formats) extends Definition with Product with Serializable
    Annotations
    @deprecated
    Deprecated

    (Since version 1.41.0) use personalization instead

Value Members

  1. object Add extends Operation with Product with Serializable
  2. object AddUnique extends Operation with Product with Serializable
  3. object Decrement extends Operation with Product with Serializable
  4. object Increment extends Operation with Product with Serializable
  5. object IncrementFrom extends Operation with Product with Serializable
  6. object IncrementSet extends Operation with Product with Serializable
  7. object Remove extends Operation with Product with Serializable

Ungrouped