module Elasticsearch::XPack::API::Fleet::Actions

Public Instance Methods

global_checkpoints(arguments = {}) click to toggle source

Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

@option arguments [String] :index The name of the index. @option arguments [Boolean] :wait_for_advance Whether to wait for the global checkpoint to advance past the specified current checkpoints @option arguments [Boolean] :wait_for_index Whether to wait for the target index to exist and all primary shards be active @option arguments [List] :checkpoints Comma separated list of checkpoints @option arguments [Time] :timeout Timeout to wait for global checkpoint to advance @option arguments [Hash] :headers Custom HTTP headers

@see [TODO]

# File lib/elasticsearch/xpack/api/actions/fleet/global_checkpoints.rb, line 38
def global_checkpoints(arguments = {})
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

  arguments = arguments.clone

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = "#{Elasticsearch::API::Utils.__listify(_index)}/_fleet/global_checkpoints"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end