ElasticSearchService

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. lazy val AWSACCESSKEYID: String

   

   Definition Classes

   ElasticSearchService → ElasticSearch

5. lazy val AWSSECRETKEY: String

   

   Definition Classes

   ElasticSearchService → ElasticSearch

6. lazy val REGION: String

   

   Definition Classes

   ElasticSearchService → ElasticSearch

7. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

8. def awsSigning(method: String, uri: String, queryString: Option[String] = None, data: Option[String] = None)(implicit ws: WSClient): Future[WSResponse]

   

   Definition Classes

   ElasticSearch

9. def bulk(index: Option[String] = None, type: Option[String] = None, data: String)(implicit ws: WSClient): Future[WSResponse]

   

   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.

   Definition Classes

   ElasticSearch

10. lazy val clientUrl: String

    

    Definition Classes

    ElasticSearchService → ElasticSearch

11. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

12. def close(index: String)(implicit ws: WSClient): Future[WSResponse]

    

    Close the index (necessary to set certain settings on index)

    Close the index (necessary to set certain settings on index)

    Definition Classes

    ElasticSearch

13. def count(indices: Seq[String], types: Seq[String], query: Option[String] = None)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

14. def createAlias(actions: String)(implicit ws: WSClient): Future[WSResponse]

    

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

    Definition Classes

    ElasticSearch

15. def createIndex(name: String, settings: Option[String] = None)(implicit ws: WSClient): Future[WSResponse]

    

    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

    Definition Classes

    ElasticSearch

16. def delete(index: String, type: String, id: String)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

17. def deleteAlias(index: String, alias: String)(implicit ws: WSClient): Future[WSResponse]

    

    Delete an index alias.

    Delete an index alias.

    index

    The name of the index.

    alias

    The name of the alias.

    Definition Classes

    ElasticSearch

18. def deleteByQuery(index: String, type: String, query: String)(implicit ws: WSClient): Future[WSResponse]

    

    Delete documents that match a query.

    Delete documents that match a query. Not supported in > 2 anymore

    index

    An index names for which mappings will be fetched.

    type

    A type for which mappings will be fetched.

    query

    The query to count documents from.

    Definition Classes

    ElasticSearch

19. def deleteIndex(name: String)(implicit ws: WSClient): Future[WSResponse]

    

    Delete an index

    Delete an index

    name

    The name of the index to delete.

    Definition Classes

    ElasticSearch

20. def deleteWarmer(index: String, name: String)(implicit ws: WSClient): Future[WSResponse]

    

    Delete a warmer.

    Delete a warmer.

    index

    The index of the warmer.

    name

    The name of the warmer.

    Definition Classes

    ElasticSearch

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

    

    Definition Classes

    AnyRef

22. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

23. def explain(index: String, type: String, id: String, query: String)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

24. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

25. def get(index: String, type: String, id: String)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

26. def getAliases(index: Option[String], query: String = "*")(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

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

    

    Definition Classes

    AnyRef → Any

28. def getMapping(indices: Seq[String], types: Seq[String])(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

29. def getSettings(indices: Seq[String])(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

30. def getWarmers(index: String, name: String)(implicit ws: WSClient): Future[WSResponse]

    

    Get matching warmers.

    Get matching warmers.

    index

    Name of index to check.

    name

    Expression to match warmer.

    Definition Classes

    ElasticSearch

31. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

32. def headers(method: String, uri: String, queryString: String, data: String): Seq[(String, String)]

    

    Definition Classes

    ElasticSearch

33. 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)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

34. def index(index: String, type: String, id: Option[String] = None, data: String, refresh: Boolean = false)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

35. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

36. def mget(index: Option[String], type: Option[String], query: String, uriParameters: MGetUriParameters = MGetUriParameters.withDefaults)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

37. def msearch(index: Option[String] = None, type: Option[String] = None, query: String)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

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

    

    Definition Classes

    AnyRef

39. final def notify(): Unit

    

    Definition Classes

    AnyRef

40. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

41. def open(index: String)(implicit ws: WSClient): Future[WSResponse]

    

    Open the index

    Open the index

    index

    index to open

    Definition Classes

    ElasticSearch

42. def putMapping(indices: Seq[String], type: String, body: String, updateAllTypes: Boolean = false, ignoreConflicts: Boolean = false)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    updateAllTypes

    When merge has conflicts overwrite mapping anyway, default false.

    Definition Classes

    ElasticSearch

43. def putSettings(indices: Seq[String], body: String)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

44. def putWarmer(index: String, name: String, body: String)(implicit ws: WSClient): Future[WSResponse]

    

    Add a warmer.

    Add a warmer.

    index

    The index to add the warmer.

    name

    The name of the warmer.

    body

    The warmer content.

    Definition Classes

    ElasticSearch

45. def refresh(index: String)(implicit ws: WSClient): Future[WSResponse]

    

    Refresh an index.

    Refresh an index.

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

    index

    Name of the index to refresh

    Definition Classes

    ElasticSearch

46. def scroll(scroll: String, scrollId: String)(implicit ws: WSClient): Future[WSResponse]

    

    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

    Definition Classes

    ElasticSearch

47. def search(index: String, query: String = ..., type: Option[String] = None, uriParameters: SearchUriParameters = SearchUriParameters.withDefaults)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

48. lazy val signer: AmazonSignerScala

    

    Definition Classes

    ElasticSearch

49. def stats(indices: Seq[String] = Seq(), clear: Boolean = false, refresh: Boolean = false, flush: Boolean = false, merge: Boolean = false, warmer: Boolean = false)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

50. def suggest(index: String, query: String)(implicit ws: WSClient): Future[WSResponse]

    

    Suggest completions based on analyzed documents.

    Suggest completions based on analyzed documents.

    index

    The index to search

    query

    The query to execute.

    Definition Classes

    ElasticSearch

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

    

    Definition Classes

    AnyRef

52. def toString(): String

    

    Definition Classes

    AnyRef → Any

53. def validate(index: String, type: Option[String] = None, query: String, explain: Boolean = false)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

54. def verifyIndex(name: String)(implicit ws: WSClient): Future[WSResponse]

    

    Verify that an index exists.

    Verify that an index exists.

    name

    The name of the index to verify.

    Definition Classes

    ElasticSearch

55. def verifyType(index: String, type: String)(implicit ws: WSClient): Future[WSResponse]

    

    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.

    Definition Classes

    ElasticSearch

56. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )