Module: Elasticsearch::API::Fleet::Actions

Included in:
FleetClient
Defined in:
lib/elasticsearch/api/namespace/fleet.rb,
lib/elasticsearch/api/actions/fleet/global_checkpoints.rb

Instance Method Summary collapse

Instance Method Details

#global_checkpoints(arguments = {}) ⇒ Object

Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :index (String) —

    The name of the index.

  • :wait_for_advance (Boolean) —

    Whether to wait for the global checkpoint to advance past the specified current checkpoints

  • :wait_for_index (Boolean) —

    Whether to wait for the target index to exist and all primary shards be active

  • :checkpoints (List) —

    Comma separated list of checkpoints

  • :timeout (Time) —

    Timeout to wait for global checkpoint to advance

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/elasticsearch/api/actions/fleet/global_checkpoints.rb', line 33

def global_checkpoints(arguments = {})
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

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

  body   = nil

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_GET
  path   = "#{Utils.__listify(_index)}/_fleet/global_checkpoints"
  params = Utils.process_params(arguments)

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