com.workday.esclient

EsClient

class EsClient extends JestUtils with EsClusterOps with EsIndexingMeta with EsIndexingDocs with EsScanAndScroll with EsSnapshots with EsAliases

Elasticsearch Scala Client

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. EsClient
  2. EsAliases
  3. EsSnapshots
  4. EsScanAndScroll
  5. EsQuery
  6. EsIndexingDocs
  7. EsIndexingMeta
  8. EsClusterOps
  9. JestUtils
  10. AnyRef
  11. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EsClient(jest: JestClient)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. val ESBackPressureErrorCode: Int

    Definition Classes
    EsIndexingDocs
  7. val RetriesLimit: Int

    Definition Classes
    EsIndexingDocs
  8. val SleepTimeToHandleBackPressureMs: Int

    Definition Classes
    EsIndexingDocs
  9. def allocateShards(shardAllocation: Seq[RerouteOp]): EsResult[RerouteAcknowledgment]

    Reallocates a list of shards to specified destination nodes and returns an acknowledgment from Elasticsearch.

    Reallocates a list of shards to specified destination nodes and returns an acknowledgment from Elasticsearch. Maps to /_cluster/reroute.

    shardAllocation

    Sequence of RerouteOps containing shard name and destination node.

    returns

    EsResult of acknowledgment from ES.

    Definition Classes
    EsClusterOps
  10. def analyze(source: String): EsResult[AnalyzeResponse]

    Submits the given source for analysis using an Elasticsearch Analyzer and returns the response.

    Submits the given source for analysis using an Elasticsearch Analyzer and returns the response.

    source

    String source to analyze.

    returns

    EsResult of com.workday.esclient.AnalyzeResponse

    Definition Classes
    EsIndexingDocs
  11. def analyzeWithIndexAnalyzer(source: String, index: String, analyzer: String = EsNames.standardAnalyzerName): EsResult[AnalyzeResponse]

    Submits the given source for analysis using an Elasticsearch Analyzer, defautlting to the standard analyzer.

    Submits the given source for analysis using an Elasticsearch Analyzer, defautlting to the standard analyzer.

    source

    String source to analyze.

    index

    String ES index name.

    analyzer

    String name of ES Analyzer to use.

    returns

    EsResult of com.workday.esclient.AnalyzeResponse

    Definition Classes
    EsIndexingDocs
  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  13. def availableNodes: EsResult[Seq[NodeInfo]]

    Returns all currently available nodes in the Elasticsearch cluster.

    Returns all currently available nodes in the Elasticsearch cluster. Does not include downed nodes. Maps to /_cat/nodes

    returns

    EsResult of sequence of com.workday.esclient.actions.NodeInfo.

    Definition Classes
    EsClusterOps
  14. def buildCatIndices(): Cat

    Returns a Cat action for indices.

    Returns a Cat action for indices.

    returns

    Cat action.

    Definition Classes
    EsClusterOps
    Annotations
    @VisibleForTesting()
  15. def buildCatShards(indexName: String = ""): CatAction

    Builds a Cat action for shards.

    Builds a Cat action for shards.

    indexName

    If specified, only shards in that index are returned. If not specified, all shards are returned.

    returns

    com.workday.esclient.actions.CatAction.

    Definition Classes
    EsClusterOps
    Annotations
    @VisibleForTesting()
  16. def bulk(actions: Seq[Action]): EsResult[BulkResponse]

    Parses a given Elasticsearch action sequence and executes the actions.

    Parses a given Elasticsearch action sequence and executes the actions.

    actions

    Sequence of ES update, index, and delete actions to perform.

    returns

    EsResult of com.workday.esclient.BulkResponse

    Definition Classes
    EsIndexingDocs
  17. def bulkWithRetry(actions: Seq[Action], depth: Int = 1): EsResult[BulkResponse]

    Attempts a bulk sequence of Elasticsearch actions and retries on failure up to a given depth of retries.

    Attempts a bulk sequence of Elasticsearch actions and retries on failure up to a given depth of retries.

    actions

    Sequence of action to attempt.

    depth

    Int recursion depth limit. Defaults to 1. com.workday.esclient.EsIndexingDocs.RetriesLimit is set to 5.

    returns

    EsResult of com.workday.esclient.BulkResponse

    Definition Classes
    EsIndexingDocs
  18. def catAliasIndexMap: EsResult[Map[String, Seq[AliasInfo]]]

    Returns a map of Elasticsearch alias info.

    Returns a map of Elasticsearch alias info.

    returns

    EsResult wrapping a map of AliasInfo.

    Definition Classes
    EsAliases
  19. def catAliases: EsResult[Seq[AliasInfo]]

    Cats all Elasticsearch alias info and returns an EsResult wrapping alias information.

    Cats all Elasticsearch alias info and returns an EsResult wrapping alias information.

    returns

    EsResult wrapping a sequence of AliasInfo objects.

    Definition Classes
    EsAliases
  20. def catAllIndices: EsResult[Seq[IndexInfo]]

    Gets the index status for all Elasticsearch indices.

    Gets the index status for all Elasticsearch indices. Maps to /_cat/indices

    returns

    EsResult of sequence of com.workday.esclient.actions.IndexInfo

    Definition Classes
    EsClusterOps
    Annotations
    @throws( ... )
    Exceptions thrown
    com.google.gson.stream.MalformedJsonException
  21. def catIndex(indexName: String): EsResult[Seq[IndexInfo]]

    Gets the status for the given Elasticsearch index.

    Gets the status for the given Elasticsearch index.

    indexName

    String ES index name.

    returns

    EsResult of sequence of com.workday.esclient.actions.IndexInfo

    Definition Classes
    EsClusterOps
  22. def catNodesStats: EsResult[AllNodesStat]

    Gets the basic memory and disk stats for all Elasticsearch nodes.

    Gets the basic memory and disk stats for all Elasticsearch nodes. Memory stats -> used heap percentage; Disk stats -> total and available byte counts.

    returns

    EsResult of com.workday.esclient.AllNodesStat

    Definition Classes
    EsClusterOps
  23. def catShards(indexName: String = ""): EsResult[Seq[ShardInfo]]

    Cats shard information from Elasticsearch.

    Cats shard information from Elasticsearch. Includes unassigned shards. Maps to /_cat/shards

    indexName

    String ES index name. Defaults to empty string.

    returns

    EsResult of sequence of com.workday.esclient.actions.ShardInfo.

    Definition Classes
    EsClusterOps
  24. def clearCacheKeys(keys: Seq[String]): EsResult[ClearCacheResponse]

    Clears Elasticsearch cache keys.

    Clears Elasticsearch cache keys. https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices-clearcache.html https://www.elastic.co/guide/en/elasticsearch/reference/1.7/query-dsl-terms-filter.html

    keys

    Sequence of cache keys to clear.

    returns

    EsResult of com.workday.esclient.ClearCacheResponse

    Definition Classes
    EsClusterOps
  25. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def closeIndex(index: String): EsResult[Acknowledgement]

    Closes an Elasticsearch index and returns an EsResult acknowledgment.

    Closes an Elasticsearch index and returns an EsResult acknowledgment. Closed indices have very little overhead on the cluster and are blocked from read/write operations.

    index

    String index to close in ES.

    returns

    EsResult wrapping an ES acknowledgment.

    Definition Classes
    EsIndexingMeta
  27. def clusterHealth: EsResult[HealthResponse]

    Returns an Elasticsearch cluster health response.

    Returns an Elasticsearch cluster health response.

    returns

    EsResult wrapping the cluster health response from ES.

    Definition Classes
    EsClusterOps
  28. def clusterSettings: EsResult[ClusterSettingsResponse]

    Gets all current Elasticsearch cluster settings.

    Gets all current Elasticsearch cluster settings. Maps to /_cluster/settings.

    returns

    EsResult of com.workday.esclient.ClusterSettingsResponse

    Definition Classes
    EsClusterOps
  29. def clusterState(indices: Seq[String] = Nil, withRoutingTable: Boolean = false): EsResult[ClusterStateResponse]

    Gets the current state of the Elasticsearch cluster.

    Gets the current state of the Elasticsearch cluster. Maps to /_cluster/state.

    indices

    Sequence of indices to filter cluster state response with. Defaults to Nil.

    withRoutingTable

    Boolean whether to include routing table in the cluster state response. Defaults to false.

    returns

    EsResult of com.workday.esclient.ClusterStateResponse

    Definition Classes
    EsClusterOps
  30. def count(index: String, typeName: Option[String] = None): EsResult[Int]

    Gets the count of documents in a given index (or alias) with optional filtering by type.

    Gets the count of documents in a given index (or alias) with optional filtering by type.

    index

    String index/alias name to get from.

    typeName

    String optional ES type name (aka sid).

    returns

    EsResult wrapping an integer count from ES.

    Definition Classes
    EsQuery
  31. def createAliases(aliases: Seq[AliasInfo]): EsResult[Acknowledgement]

    Creates aliases for given indices in Elasticsearch.

    Creates aliases for given indices in Elasticsearch.

    aliases

    Sequence of aliases including alias names and indices to map to.

    returns

    EsResult wrapping an ES acknowledgment.

    Definition Classes
    EsAliases
  32. def createIndex(index: String, settings: Option[Map[String, Any]] = None): EsResult[Acknowledgement]

    Creates an Elasticsearch index and returns an EsResult acknowledgment.

    Creates an Elasticsearch index and returns an EsResult acknowledgment.

    index

    String index to create in ES.

    settings

    Optional map of settings for the index.

    returns

    EsResult wrapping an ES acknowledgment.

    Definition Classes
    EsIndexingMeta
  33. def createScrolledSearch(index: String, typeName: String = "", query: String, params: Map[String, Any] = Map()): EsResult[ScanAndScrollResponse]

    Creates a scrolled search and returns the Jest response.

    Creates a scrolled search and returns the Jest response.

    index

    String index to search on

    typeName

    String type name to search

    query

    String query to search on

    params

    String params for search query

    returns

    EsResult of Elasticsearch scan and scroll response

    Definition Classes
    EsScanAndScroll
  34. def createScrolledSearchIterator(index: String, typeName: String, query: String, params: Map[String, Any] = Map()): Iterator[EsResult[SearchHits]]

    Does a scan and scroll search and returns an iterator over the results.

    Does a scan and scroll search and returns an iterator over the results. (https://www.elastic.co/guide/en/elasticsearch/guide/current/scan-scroll.html)

    index

    String index to search

    typeName

    String index type

    query

    String query to perform

    params

    Map[String,Any] query parameters to include; defaults to empty Map

    returns

    Iterator over EsResults of SearchHits

    Definition Classes
    EsScanAndScroll
  35. def createSearchAction(index: String, typeName: String = "", query: String, params: Map[String, Any] = Map()): Builder

    Returns a buildable search action for us with a Jest client.

    Returns a buildable search action for us with a Jest client.

    index

    String index to search from.

    typeName

    String optional ES type name.

    query

    String query content.

    params

    Optional map of additional search parameters.

    returns

    buildable search action object.

    Attributes
    protected
    Definition Classes
    EsQuery
    Annotations
    @VisibleForTesting()
  36. def deleteAliases(aliases: Seq[AliasInfo]): EsResult[Acknowledgement]

    Deletes aliases from Elasticsearch.

    Deletes aliases from Elasticsearch.

    aliases

    Sequence of aliases including alias names and indices to map to.

    returns

    EsResult wrapping an ES acknowledgment.

    Definition Classes
    EsAliases
  37. def deleteDocsByQuery(index: String, query: Option[String] = None): EsResult[DeleteByQueryResponse]

    Deletes Elasticsearch documents that match a given query string.

    Deletes Elasticsearch documents that match a given query string.

    index

    String ES index name.

    query

    Optional string to query ES. Defaults to None.

    returns

    EsResult of com.workday.esclient.DeleteByQueryResponse

    Definition Classes
    EsIndexingDocs
  38. def deleteIndex(index: String): EsResult[Acknowledgement]

    Deletes an Elasticsearch index and returns an EsResult acknowledgment.

    Deletes an Elasticsearch index and returns an EsResult acknowledgment.

    index

    String index to delete from ES.

    returns

    EsResult wrapping an ES acknowledgment.

    Definition Classes
    EsIndexingMeta
  39. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  40. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  41. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  42. def forceFlush(index: String): Unit

    Flushes an Elasticsearch index.

    Flushes an Elasticsearch index.

    index

    String ES index name.

    Definition Classes
    EsIndexingDocs
  43. def get(index: String, id: String): EsResult[GetResponse]

    Makes a get request to Elasticsearch for the given id and index.

    Makes a get request to Elasticsearch for the given id and index.

    index

    String index to get from.

    id

    String id of document to get.

    returns

    EsResult wrapping the response from ES.

    Definition Classes
    EsQuery
  44. def getAliasesByIndex(index: String): EsResult[Seq[AliasInfo]]

    Gets Elasticsearch aliases by index and return a sequence of AliasInfo.

    Gets Elasticsearch aliases by index and return a sequence of AliasInfo.

    index

    String index to get aliases for.

    returns

    EsResult wrapping the aliases.

    Definition Classes
    EsAliases
  45. def getAliasesByName(aliasNames: Seq[String]): EsResult[Seq[AliasInfo]]

    Gets Elasticsearch alias info from a sequence of alias names.

    Gets Elasticsearch alias info from a sequence of alias names.

    aliasNames

    Sequence of ES alias names.

    returns

    EsResult wrapping the aliases.

    Definition Classes
    EsAliases
  46. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  47. def getMappingsForIndex(index: String, typeName: String): EsResult[IndexTypeMappings]

    Gets all of the mappings for an Elasticsearch index.

    Gets all of the mappings for an Elasticsearch index.

    index

    String index to get mappings from.

    typeName

    String ES type name.

    returns

    EsResult wrapping the index mappings.

    Definition Classes
    EsIndexingMeta
  48. def getMappingsForIndex(index: String): EsResult[IndexMappings]

    Gets all of the mappings for an Elasticsearch index.

    Gets all of the mappings for an Elasticsearch index. TODO: create variants for specific fields.

    index

    String index to get mappings from.

    returns

    EsResult wrapping the index mappings.

    Definition Classes
    EsIndexingMeta
  49. def getMappingsForIndices(indices: Seq[String], typeNames: Seq[String]): EsResult[Map[String, IndexMappings]]

    Gets all of the mapping for a sequence of indices in Elasticsearch.

    Gets all of the mapping for a sequence of indices in Elasticsearch.

    indices

    Sequence of ES indices.

    typeNames

    Sequence of ES type names.

    returns

    EsResult wrapping a map of indices and their mappings.

    Definition Classes
    EsIndexingMeta
  50. def getScrolledSearchResults(scrollID: String): EsResult[ScanAndScrollResponse]

    Gets the scrolled search result using a scroll ID

    Gets the scrolled search result using a scroll ID

    scrollID

    String provided scroll ID

    returns

    EsResult of Elasticsearch scan and scroll response

    Definition Classes
    EsScanAndScroll
  51. def getSearchHitsCount(index: String, query: String): Int

    Gets the count of search hits for a given query and index.

    Gets the count of search hits for a given query and index.

    index

    String index to get from.

    query

    String query content.

    returns

    Int count of hits for given query.

    Definition Classes
    EsQuery
  52. def getSleepTimeForBackpressure: Int

    Gets com.workday.esclient.EsIndexingDocs.SleepTimeToHandleBackPressureMs

  53. def handleJestResult[J <: JestResult, T](jestResult: J, allowError: Boolean = false)(responseHandler: (J) ⇒ T): EsResult[T]

    Returns successful EsResult[T] or error response on JSON parsing/mapping failure.

    Returns successful EsResult[T] or error response on JSON parsing/mapping failure.

    J

    we need J here to allow things like jest's CountResult

    allowError

    - multiGet returns a GetResponse with an error field instead of a source, so we should report that normally

    returns

    EsResult[T] either EsResponse[T] or an error message type

    Attributes
    protected[this]
    Definition Classes
    JestUtils
  54. def handleSearchResult(searchResult: SearchResult): EsResult[EsSearchResponse]

    Handles the Jest result from an ES request and returns a JSON object.

    Handles the Jest result from an ES request and returns a JSON object.

    searchResult

    Jest SearchResult from ES.

    returns

    EsResult wrapping the handled response from ES.

    Attributes
    protected
    Definition Classes
    EsQuery
  55. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  56. def index(index: String, typeName: String, id: String, doc: String): EsResult[UpdateResponse]

    Indexes a given doc to an Elasticsearch index under the given id.

    Indexes a given doc to an Elasticsearch index under the given id.

    index

    String ES index name.

    typeName

    String ES type name.

    id

    String id to index document under.

    doc

    String doc to index.

    returns

    EsResult of com.workday.esclient.UpdateResponse

    Definition Classes
    EsIndexingDocs
  57. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  58. val jest: JestClient

    Definition Classes
    EsClientJestUtils
  59. val logger: Logger

    Definition Classes
    EsIndexingDocs
  60. def modifyAliases(toAdd: Seq[AliasInfo], toRemove: Seq[AliasInfo]): EsResult[Acknowledgement]

    Modifies aliases in Elasticsearch and returns an acknowledgment.

    Modifies aliases in Elasticsearch and returns an acknowledgment.

    toAdd

    Sequences of aliases to add to ES.

    toRemove

    Sequences of aliases to remove from ES>

    returns

    EsResult wrapping an ES acknowledgment.

    Definition Classes
    EsAliases
  61. def multiGet(index: String, typeName: String, ids: Seq[String], params: Map[String, Any] = Map()): EsResult[MultiGetResponse]

    Makes a multi-get request to Elasticsearch for the given index and ids.

    Makes a multi-get request to Elasticsearch for the given index and ids.

    index

    String index to get from.

    typeName

    String ES type name.

    ids

    Sequence of ids of documents to get.

    params

    Optional map of additional get parameters.

    returns

    EsResult wrapping the response from ES.

    Definition Classes
    EsQuery
  62. def multiGetSourceField(index: String, typeName: String, ids: Seq[String], field: String): EsResult[MultiGetResponse]

    Makes a Multi Get request with the "_source" field provided as a parameter.

    Makes a Multi Get request with the "_source" field provided as a parameter.

    index

    String index to get from.

    typeName

    String ES type name.

    ids

    Sequence of ids of documents to get.

    field

    String "_source" field to specify which documents to return source for.

    returns

    EsResult wrapping the response from ES.

    Definition Classes
    EsQuery
  63. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  64. final def notify(): Unit

    Definition Classes
    AnyRef
  65. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  66. def repositoryCreate(repositoryName: String, repositorySettings: String): EsResult[Acknowledgement]

    Creates a repository with the specified settings and returns an Elasticsearch acknowledgment.

    Creates a repository with the specified settings and returns an Elasticsearch acknowledgment. Settings are the payload as defined here: https://www.elastic.co/guide/en/elasticsearch/reference/1.4/modules-snapshots.html#_repositories

    repositoryName

    String name of target repository

    repositorySettings

    String of repository settings

    returns

    EsResult containing an Elasticsearch acknowledgment

    Definition Classes
    EsSnapshots
  67. def repositoryDelete(repositoryName: String): EsResult[Acknowledgement]

    Deletes a repository and returns an Elasticsearch acknowledgment.

    Deletes a repository and returns an Elasticsearch acknowledgment.

    repositoryName

    String name of target repository

    returns

    EsResult containing an Elasticsearch acknowledgment

    Definition Classes
    EsSnapshots
  68. def repositoryList(): EsResult[ListRepositoryResponse]

    Returns the list of all repositories defined in the ES cluster.

    Returns the list of all repositories defined in the ES cluster.

    returns

    EsResult containing a sequence of repository definitions

    Definition Classes
    EsSnapshots
  69. def search(index: String, typeName: String = "", query: String, params: Map[String, Any] = Map()): EsResult[EsSearchResponse]

    Makes a more sophisticated query on Elasticsearch including ES type names and parameters.

    Makes a more sophisticated query on Elasticsearch including ES type names and parameters.

    index

    String ES index to query.

    typeName

    String ES type name.

    query

    String query content.

    params

    Map of params to include in ES request.

    returns

    EsResult wrapping the response from ES.

    Definition Classes
    EsQuery
  70. def search(index: String, query: String): EsResult[EsSearchResponse]

    Makes a basic query on Elasticsearch and returns an EsResult of the response.

    Makes a basic query on Elasticsearch and returns an EsResult of the response.

    index

    String ES index to query.

    query

    String query content.

    returns

    EsResult wrapping the response from ES.

    Definition Classes
    EsQuery
  71. def shutdownClient(): Unit

  72. def snapshotCreate(repositoryName: String, snapshotName: String, indices: Seq[String], waitForCompletion: Boolean = false): EsResult[Any]

    Returns a snapshot of a set of indices.

    Returns a snapshot of a set of indices.

    repositoryName

    String name of target repository

    snapshotName

    String name of snapshot

    indices

    Sequence of String indices

    waitForCompletion

    Boolean whether to wait for snapshot response; Defaults to false

    returns

    EsResult of snapshot or accepted response

    Definition Classes
    EsSnapshots
  73. def snapshotDelete(repositoryName: String, snapshotName: String): EsResult[Acknowledgement]

    Deletes a snapshot from given repository and returns acknowledgment.

    Deletes a snapshot from given repository and returns acknowledgment.

    repositoryName

    String name of target repository

    snapshotName

    String name of snapshot

    returns

    EsResult containing an Elasticsearch acknowledgment

    Definition Classes
    EsSnapshots
  74. def snapshotList(repositoryName: String): EsResult[ListSnapshotResponse]

    Returns list of all snapshots defined for a given repository.

    Returns list of all snapshots defined for a given repository. Maps Elasticsearch response JSON objects to a sequence of JSON objects of snapshots and their indices then wraps this sequence in a case class.

    repositoryName

    String name of target repository

    returns

    EsResult containing an list of snapshots as com.fasterxml.jackson.databind.JsonNode

    Definition Classes
    EsSnapshots
  75. def snapshotRestore(repositoryName: String, snapshotName: String, waitForCompletion: Boolean = false): EsResult[AcceptResponse]

    Restores from a snapshot and returns an accepted response from Elasticsearch.

    Restores from a snapshot and returns an accepted response from Elasticsearch. Repository must be closed or this will fail.

    repositoryName

    String name of target repository

    snapshotName

    String name of snapshot

    waitForCompletion

    Boolean whether to wait for snapshot response; Defaults to false

    returns

    EsResult containing an Elasticsearch accepted response

    Definition Classes
    EsSnapshots
  76. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  77. def toEsResult[T](jestResult: JestResult, allowError: Boolean = false)(implicit arg0: Manifest[T]): EsResult[T]

    Returns com.workday.esclient.EsResult[T] from JSON Jest response.

    Returns com.workday.esclient.EsResult[T] from JSON Jest response.

    T

    implicit manifest

    jestResult

    Jest response to be handled

    allowError

    Boolean value whether to parse error responses

    returns

    EsResult[T]

    Definition Classes
    JestUtils
    Annotations
    @VisibleForTesting()
  78. def toString(): String

    Definition Classes
    AnyRef → Any
  79. def unlimitedSearch(index: String, typeName: String = "", query: String, scanAndScrollSize: Int): EsResult[EsSearchResponse]

    Performs a ScanAndScroll search, combines all paged results into an iterator and aggregates each result in the iterator into a single EsResult[EsSearchResponse].

    Performs a ScanAndScroll search, combines all paged results into an iterator and aggregates each result in the iterator into a single EsResult[EsSearchResponse].

    index

    String index to search

    typeName

    String index type

    query

    String query to perform

    scanAndScrollSize

    Int size of each scan and scroll response

    returns

    EsResult[EsSearchResponse] of aggregate result from scan-and-scrolled results

    Definition Classes
    EsScanAndScroll
  80. def updateClusterSettings(transient: Map[String, String], persistent: Map[String, String]): EsResult[ClusterSettingsResponse]

    Updates Elasticsearch cluster settings.

    Updates Elasticsearch cluster settings. Maps to /_cluster/settings. If key is not present it will keep its value.

    transient

    Map of transient settings to update. Will not survive a cluster restart.

    persistent

    Map of persistent settings to update. Persist across cluster restarts.

    returns

    EsResult of com.workday.esclient.ClusterSettingsResponse

    Definition Classes
    EsClusterOps
  81. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  82. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. def worstIndexHealth(indices: Seq[String], timeout: String = IndexHealthAction.DEFAULT_TIMEOUT): (String, Boolean)

    Returns the least healthy index in the given sequence of Elastichsearch indices.

    Returns the least healthy index in the given sequence of Elastichsearch indices. Maps to /_cluster/health/index1,index2,... .

    indices

    Sequence of ES index names.

    timeout

    String ES timeout. Defaults to com.workday.esclient.actions.IndexHealthAction.DEFAULT_TIMEOUT

    returns

    Tuple of the least healthy index status and whether the request timed out.

    Definition Classes
    EsClusterOps

Inherited from EsAliases

Inherited from EsSnapshots

Inherited from EsScanAndScroll

Inherited from EsQuery

Inherited from EsIndexingDocs

Inherited from EsIndexingMeta

Inherited from EsClusterOps

Inherited from JestUtils

Inherited from AnyRef

Inherited from Any

Ungrouped