# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you 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.
#
# This code was automatically generated from the Elasticsearch Specification
# See https://github.com/elastic/elasticsearch-specification
# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
module Elasticsearch
  module API
    module Indices
      module Actions
        # Resolve the cluster.
        # Resolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included.
        # If no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster.
        # This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.
        # You use the same index expression with this endpoint as you would for cross-cluster search.
        # Index and cluster exclusions are also supported with this endpoint.
        # For each cluster in the index expression, information is returned about:
        # * Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the `remote/info` endpoint.
        # * Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`.
        # * Whether there are any indices, aliases, or data streams on that cluster that match the index expression.
        # * Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index).
        # * Cluster version information, including the Elasticsearch server version.
        # For example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`.
        # Each cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`.The ability to query without an index expression was added in version 8.18, so when
        # querying remote clusters older than that, the local cluster will send the index
        # expression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference
        # to that index expression even though you didn't request it. If it causes a problem, you can
        # instead include an index expression like `*:*` to bypass the issue.You may want to exclude a cluster or index from a search when:
        # * A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail.
        # * A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search.
        # * The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.)
        # * A remote cluster is an older version that does not support the feature you want to use in your search.The `remote/info` endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not.
        # The remote cluster may be available, while the local cluster is not currently connected to it.
        # You can use the `_resolve/cluster` API to attempt to reconnect to remote clusters.
        # For example with `GET _resolve/cluster` or `GET _resolve/cluster/*:*`.
        # The `connected` field in the response will indicate whether it was successful.
        # If a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status.
        #
        # @option arguments [String, Array<String>] :name A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve.
        #  Resources on remote clusters can be specified using the `<cluster>`:`<name>` syntax.
        #  Index and cluster exclusions (e.g., `-cluster1:*`) are also supported.
        #  If no index expression is specified, information about all remote clusters configured on the local cluster
        #  is returned without doing any index matching
        # @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing
        #  or closed indices. This behavior applies even if the request targets other open indices. For example, a request
        #  targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
        #  NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
        #  options to the `_resolve/cluster` API endpoint that takes no index expression. Server default: true.
        # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match.
        #  If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
        #  Supports comma-separated values, such as `open,hidden`.
        #  NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
        #  options to the `_resolve/cluster` API endpoint that takes no index expression. Server default: open.
        # @option arguments [Boolean] :ignore_throttled If true, concrete, expanded, or aliased indices are ignored when frozen.
        #  NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
        #  options to the `_resolve/cluster` API endpoint that takes no index expression.
        # @option arguments [Boolean] :ignore_unavailable If false, the request returns an error if it targets a missing or closed index.
        #  NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
        #  options to the `_resolve/cluster` API endpoint that takes no index expression.
        # @option arguments [Time] :timeout The maximum time to wait for remote clusters to respond.
        #  If a remote cluster does not respond within this timeout period, the API response
        #  will show the cluster as not connected and include an error message that the
        #  request timed out.The default timeout is unset and the query can take
        #  as long as the networking layer is configured to wait for remote clusters that are
        #  not responding (typically 30 seconds).
        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
        #  when they occur.
        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
        #  returned by Elasticsearch.
        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
        #  For example `"exists_time": "1h"` for humans and
        #  `"exists_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.
        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
        #  this option for debugging only.
        # @option arguments [Hash] :headers Custom HTTP headers
        #
        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster
        #
        def resolve_cluster(arguments = {})
          request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_cluster' }

          defined_params = [:name].each_with_object({}) do |variable, set_variables|
            set_variables[variable] = arguments[variable] if arguments.key?(variable)
          end
          request_opts[:defined_params] = defined_params unless defined_params.empty?

          arguments = arguments.clone
          headers = arguments.delete(:headers) || {}

          body = nil

          _name = arguments.delete(:name)

          method = Elasticsearch::API::HTTP_GET
          path   = if _name
                     "_resolve/cluster/#{Utils.listify(_name)}"
                   else
                     '_resolve/cluster'
                   end
          params = Utils.process_params(arguments)

          Elasticsearch::API::Response.new(
            perform_request(method, path, params, body, headers, request_opts)
          )
        end
      end
    end
  end
end
