Method: Elasticsearch::API::SQL::Actions#get_async

Defined in:
lib/elasticsearch/api/actions/sql/get_async.rb

#get_async(arguments = {}) ⇒ Object

Returns the current status and available results for an async SQL search or stored synchronous SQL search

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :id (String) —

    The async search ID

  • :delimiter (String) —

    Separator for CSV results

  • :format (String) —

    Short version of the Accept header, e.g. json, yaml

  • :keep_alive (Time) —

    Retention period for the search and its results

  • :wait_for_completion_timeout (Time) —

    Duration to wait for complete results

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/elasticsearch/api/actions/sql/get_async.rb', line 36

def get_async(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'sql.get_async' }

  defined_params = [:id].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?

  raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]

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

  body = nil

  _id = arguments.delete(:id)

  method = Elasticsearch::API::HTTP_GET
  path   = "_sql/async/#{Utils.__listify(_id)}"
  params = Utils.process_params(arguments)

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