zio.elasticsearch.cluster.health.HealthRequest.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zio-elasticsearch-cluster_sjs1_2.12 Show documentation
Zio Elasticsearch-cluster
The newest version!
/*
 * Copyright 2019-2023 Alberto Paro
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package zio.elasticsearch.cluster.health
import scala.collection.mutable

import zio._
import zio.elasticsearch.common._
import zio.json.ast._
/*
 * Returns basic information about the health of the cluster.
 * For more info refers to https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html
 *
 * @param errorTrace When set to `true` Elasticsearch will include the full stack trace of errors
 * when they occur.
 * @server_default false

 * @param filterPath Comma-separated list of filters in dot notation which reduce the response
 * returned by Elasticsearch.

 * @param human When set to `true` will return statistics in a format suitable for humans.
 * For example `"exists_time": "1h"` for humans and
 * `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
 * readable values will be omitted. This makes sense for responses being consumed
 * only by machines.
 * @server_default false

 * @param pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
 * this option for debugging only.
 * @server_default false

 * @param expandWildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
 * @param index Limit the information returned to a specific index
 * @param level Specify the level of detail for returned information
 * @param local Return local information, do not retrieve the state from master node (default: false)
 * @param masterTimeout Explicit operation timeout for connection to master node
 * @param timeout Explicit operation timeout
 * @param waitForActiveShards Wait until the specified number of shards is active
 * @param waitForEvents Wait until all currently queued events with the given priority are processed
 * @param waitForNoInitializingShards Whether to wait until there are no initializing shards in the cluster
 * @param waitForNoRelocatingShards Whether to wait until there are no relocating shards in the cluster
 * @param waitForNodes Wait until the specified number of nodes is available
 * @param waitForStatus Wait until cluster is in a specific state
 */

final case class HealthRequest(
  errorTrace: Boolean = false,
  filterPath: Chunk[String] = Chunk.empty[String],
  human: Boolean = false,
  pretty: Boolean = false,
  expandWildcards: Seq[ExpandWildcards] = Nil,
  index: Option[String] = None,
  level: Level = Level.cluster,
  local: Option[Boolean] = None,
  masterTimeout: Option[String] = None,
  timeout: Option[String] = None,
  waitForActiveShards: Option[String] = None,
  waitForEvents: Seq[WaitForEvents] = Nil,
  waitForNoInitializingShards: Option[Boolean] = None,
  waitForNoRelocatingShards: Option[Boolean] = None,
  waitForNodes: Option[String] = None,
  waitForStatus: Option[WaitForStatus] = None
) extends ActionRequest[Json]
    with RequestBase {
  def method: Method = Method.GET

  def urlPath: String = this.makeUrl("_cluster", "health", index)

  def queryArgs: Map[String, String] = {
    // managing parameters
    val queryArgs = new mutable.HashMap[String, String]()
    if (expandWildcards.nonEmpty) {
      if (expandWildcards.toSet != Set(ExpandWildcards.all)) {
        queryArgs += ("expand_wildcards" -> expandWildcards.mkString(","))
      }

    }
    if (level != Level.cluster)
      queryArgs += ("level" -> level.toString)
    local.foreach { v =>
      queryArgs += ("local" -> v.toString)
    }
    masterTimeout.foreach { v =>
      queryArgs += ("master_timeout" -> v.toString)
    }
    timeout.foreach { v =>
      queryArgs += ("timeout" -> v.toString)
    }
    waitForActiveShards.foreach { v =>
      queryArgs += ("wait_for_active_shards" -> v)
    }
    if (waitForEvents.nonEmpty) {
      queryArgs += ("wait_for_events" -> waitForEvents.mkString(","))

    }
    waitForNoInitializingShards.foreach { v =>
      queryArgs += ("wait_for_no_initializing_shards" -> v.toString)
    }
    waitForNoRelocatingShards.foreach { v =>
      queryArgs += ("wait_for_no_relocating_shards" -> v.toString)
    }
    waitForNodes.foreach { v =>
      queryArgs += ("wait_for_nodes" -> v)
    }
    waitForStatus.foreach { v =>
      queryArgs += ("wait_for_status" -> v.toString)
    }
    // Custom Code On
    // Custom Code Off
    queryArgs.toMap
  }

  def body: Json = Json.Null

  // Custom Code On
  // Custom Code Off

}