Client

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def bulk(index: Option[String] = None, type: Option[String] = None, data: String): Future[Response]

   

   Use the bulk API to perform many index/delete operations in a single call.

   Use the bulk API to perform many index/delete operations in a single call.

   index

   The optional index name.

   type

   The optional type.

   data

   The operations to perform as described by the ElasticSearch Bulk API.

6. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

7. def count(indices: Seq[String], types: Seq[String], query: String): Future[Response]

   

   Request a count of the documents matching a query.

   Request a count of the documents matching a query.

   indices

   A sequence of index names for which mappings will be fetched.

   types

   A sequence of types for which mappings will be fetched.

   query

   The query to count documents from.

8. def createAlias(actions: String): Future[Response]

   

   Create aliases.

   Create aliases.

   actions

   A String of JSON containing the actions to be performed. This string will be placed within the actions array passed As defined in the ElasticSearch Admin Indices API this method takes a string representing a list of operations to be performed. Remember to

   val actions = """{ "add": { "index": "index1", "alias": "alias1" } }, { "add": { "index": "index2", "alias": "alias2" } }"""

9. def createIndex(name: String, settings: Option[String] = None): Future[Response]

   

   Create an index, optionally using the supplied settings.

   Create an index, optionally using the supplied settings.

   name

   The name of the index.

   settings

   Optional settings

10. def debug(msg: ⇒ Any, t: ⇒ Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

11. def debug(msg: ⇒ Any): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

12. def delete(index: String, type: String, id: String): Future[Response]

    

    Delete a document from the index.

    Delete a document from the index.

    index

    The name of the index.

    type

    The type of document to delete.

    id

    The ID of the document.

13. def deleteAlias(index: String, alias: String): Future[Response]

    

    Delete an index alias.

    Delete an index alias.

    index

    The name of the index.

    alias

    The name of the alias.

14. def deleteByQuery(indices: Seq[String], types: Seq[String], query: String): Future[Response]

    

    Delete documents that match a query.

    Delete documents that match a query.

    indices

    A sequence of index names for which mappings will be fetched.

    types

    A sequence of types for which mappings will be fetched.

    query

    The query to count documents from.

15. def deleteIndex(name: String): Future[Response]

    

    Delete an index

    Delete an index

    name

    The name of the index to delete.

16. def deleteWarmer(index: String, name: String): Future[Response]

    

    Delete a warmer.

    Delete a warmer.

    index

    The index of the warmer.

    name

    The name of the warmer.

17. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

18. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

19. def error(msg: ⇒ Any, t: ⇒ Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

20. def error(msg: ⇒ Any): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

21. def explain(index: String, type: String, id: String, query: String): Future[Response]

    

    Explain a query and document.

    Explain a query and document.

    index

    The name of the index.

    type

    The optional type document to explain.

    id

    The ID of the document.

    query

    The query.

22. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

23. def get(index: String, type: String, id: String): Future[Response]

    

    Get a document by ID.

    Get a document by ID.

    index

    The name of the index.

    type

    The type of the document.

    id

    The id of the document.

24. def getAliases(index: Option[String], query: String = "*"): Future[Response]

    

    Get aliases for indices.

    Get aliases for indices.

    index

    Optional name of an index. If no index is supplied, then the query will check all indices.

    query

    The name of alias to return in the response. Like the index option, this option supports wildcards and the option the specify multiple alias names separated by a comma.

25. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

26. def getMapping(indices: Seq[String], types: Seq[String]): Future[Response]

    

    Get the mappings for a list of indices.

    Get the mappings for a list of indices.

    indices

    A sequence of index names for which mappings will be fetched.

    types

    A sequence of types for which mappings will be fetched.

27. def getSettings(indices: Seq[String]): Future[Response]

    

    Get the settings for a list of indices.

    Get the settings for a list of indices.

    indices

    A sequence of index names for which settings will be fetched.

28. def getWarmers(index: String, name: String): Future[Response]

    

    Get matching warmers.

    Get matching warmers.

    index

    Name of index to check.

    name

    Expression to match warmer.

29. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

30. def health(indices: Seq[String] = Seq.empty[String], level: Option[String] = None, waitForStatus: Option[String] = None, waitForRelocatingShards: Option[String] = None, waitForNodes: Option[String] = None, timeout: Option[String] = None): Future[Response]

    

    Query ElasticSearch for it's health.

    Query ElasticSearch for it's health.

    indices

    Optional list of index names. Defaults to empty.

    level

    Can be one of cluster, indices or shards. Controls the details level of the health information returned.

    waitForStatus

    One of green, yellow or red. Will wait until the status of the cluster changes to the one provided, or until the timeout expires.

    waitForRelocatingShards

    A number controlling to how many relocating shards to wait for.

    waitForNodes

    The request waits until the specified number N of nodes is available. Is a string because >N and ge(N) type notations are allowed.

    timeout

    A time based parameter controlling how long to wait if one of the waitForXXX are provided.

31. def index(index: String, type: String, id: Option[String] = None, data: String, refresh: Boolean = false): Future[Response]

    

    Index a document.

    Index a document.

    Adds or updates a JSON documented of the specified type in the specified index.

    index

    The index in which to place the document

    type

    The type of document to be indexed

    id

    The id of the document. Specifying None will trigger automatic ID generation by ElasticSearch

    data

    The document to index, which should be a JSON string

    refresh

    If true then ElasticSearch will refresh the index so that the indexed document is immediately searchable.

32. def info(msg: ⇒ Any, t: ⇒ Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

33. def info(msg: ⇒ Any): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

34. def isDebugEnabled: Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

35. def isErrorEnabled: Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

36. def isInfoEnabled: Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

37. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

38. def isTraceEnabled: Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

39. def isWarnEnabled: Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

40. def logger: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

41. def loggerName: String

    

    Attributes

    protected

    Definition Classes

    Logging

42. def mget(index: Option[String], type: Option[String], query: String, uriParameters: MGetUriParameters = MGetUriParameters.withDefaults): Future[Response]

    

    Get multiple documents by ID.

    Get multiple documents by ID.

    index

    The optional name of the index.

    type

    The optional type of the document.

    query

    The query to execute.

    uriParameters

    The query uri parameters.

43. def msearch(index: Option[String] = None, type: Option[String] = None, query: String): Future[Response]

    

    Get multiple documents by ID.

    Get multiple documents by ID.

    index

    The optional name of the index.

    type

    The optional type of the document.

    query

    The query to execute.

44. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

45. final def notify(): Unit

    

    Definition Classes

    AnyRef

46. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

47. def putMapping(indices: Seq[String], type: String, body: String, ignoreConflicts: Boolean = false): Future[Response]

    

    Put a mapping for a list of indices.

    Put a mapping for a list of indices.

    indices

    A sequence of index names for which mappings will be added.

    type

    The type name to which the mappings will be applied.

    body

    The mapping.

    ignoreConflicts

    When merge has conflicts overwrite mapping anyway, default false.

48. def putSettings(indices: Seq[String], body: String): Future[Response]

    

    Put settings for a list of indices.

    Put settings for a list of indices.

    indices

    A sequence of index names for which settings will be updated.

    body

    The settings.

49. def putWarmer(index: String, name: String, body: String): Future[Response]

    

    Add a warmer.

    Add a warmer.

    index

    The index to add the warmer.

    name

    The name of the warmer.

    body

    The warmer content.

50. def refresh(index: String): Future[Response]

    

    Refresh an index.

    Refresh an index.

    Makes all operations performed since the last refresh available for search.

    index

    Name of the index to refresh

51. def scroll(scroll: String, scrollId: String): Future[Response]

    

    Scrolls for more documents.

    Scrolls for more documents.

    scroll

    The scroll parameter which tells Elasticsearch how long it should keep the “search context” alive

    scrollId

    The _scroll_id value returned in the response to the previous search or scroll request

52. def search(index: String, query: String, type: Option[String] = None, uriParameters: SearchUriParameters = SearchUriParameters.withDefaults): Future[Response]

    

    Search for documents.

    Search for documents.

    index

    The index to search

    query

    The query to execute.

    type

    The optional type of document to search

    uriParameters

    The query uri parameters.

53. def stats(indices: Seq[String] = Seq(), clear: Boolean = false, refresh: Boolean = false, flush: Boolean = false, merge: Boolean = false, warmer: Boolean = false): Future[Response]

    

    Query ElasticSearch Stats.

    Query ElasticSearch Stats. Parameters to enable non-default stats as desired.

    indices

    Optional list of index names. Defaults to empty.

    clear

    Clears all the flags (first).

    refresh

    refresh stats.

    flush

    flush stats.

    merge

    merge stats.

    warmer

    Warmer statistics.

54. def suggest(index: String, query: String): Future[Response]

    

    Suggest completions based on analyzed documents.

    Suggest completions based on analyzed documents.

    index

    The index to search

    query

    The query to execute.

55. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

56. def toString(): String

    

    Definition Classes

    AnyRef → Any

57. def trace(msg: ⇒ Any, t: ⇒ Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

58. def trace(msg: ⇒ Any): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

59. def validate(index: String, type: Option[String] = None, query: String, explain: Boolean = false): Future[Response]

    

    Validate a query.

    Validate a query.

    index

    The name of the index.

    type

    The optional type of document to validate against.

    query

    The query.

    explain

    If true, then the response will contain more detailed information about the query.

60. def verifyIndex(name: String): Future[Response]

    

    Verify that an index exists.

    Verify that an index exists.

    name

    The name of the index to verify.

61. def verifyType(index: String, type: String): Future[Response]

    

    Verify that a type exists.

    Verify that a type exists.

    index

    The name of the index to verify.

    type

    The name of the document type to verify.

62. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

63. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

64. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

65. def warn(msg: ⇒ Any, t: ⇒ Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

66. def warn(msg: ⇒ Any): Unit

    

    Attributes

    protected

    Definition Classes

    Logging