com.workday.esclient

EsClusterOps

trait EsClusterOps extends JestUtils

Trait wrapping Elasticsearch Cluster-level APIs

Linear Supertypes
JestUtils, AnyRef, Any
Known Subclasses
EsClient
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. EsClusterOps
  2. JestUtils
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def jest: JestClient

    Definition Classes
    JestUtils

Concrete 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. 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.

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. 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.

  9. def buildCatIndices(): Cat

    Returns a Cat action for indices.

    Returns a Cat action for indices.

    returns

    Cat action.

    Annotations
    @VisibleForTesting()

  10. 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.

    Annotations
    @VisibleForTesting()

  11. 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

    Annotations
    @throws( ... )
    Exceptions thrown
    com.google.gson.stream.MalformedJsonException

  12. 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

  13. 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

  14. 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.

  15. 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

  16. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  17. 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.

  18. 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

  19. 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

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

    Definition Classes
    AnyRef

  21. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  22. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Definition Classes
    AnyRef → Any

  24. 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

  25. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  28. final def notify(): Unit

    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  31. 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()

  32. def toString(): String

    Definition Classes
    AnyRef → Any

  33. 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

  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. 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.

Inherited from JestUtils

Inherited from AnyRef

Inherited from Any

Ungrouped