Module: Elasticsearch::XPack::API::DataFrame::Actions

Included in:
Graph::DataFrameClient
Defined in:
lib/elasticsearch/xpack/api/actions/data_frame/get_data_frame_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame/put_data_frame_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame/stop_data_frame_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame/start_data_frame_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame/delete_data_frame_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame/preview_data_frame_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame/get_data_frame_transform_stats.rb

Instance Method Summary collapse

Instance Method Details

#delete_data_frame_transform(arguments = {}) ⇒ Object

Deletes an existing data frame transform.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    The id of the transform to delete. Required

Raises:

  • (ArgumentError)

See Also:

Since:

  • 7.2.0



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame/delete_data_frame_transform.rb', line 31

def delete_data_frame_transform(arguments={})
  raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
  transform_id = URI.escape(arguments[:transform_id])

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_data_frame/transforms/#{transform_id}"
  params = {}
  body   = nil

  perform_request(method, path, params, body).body
end

#get_data_frame_transform(arguments = {}) ⇒ Object

Retrieves configuration information for data frame transforms.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (Integer) —

    The id or comma delimited list of id expressions of the transforms to get, ‘_all’ or ‘*’ implies get all transforms.

  • :from (Integer) —

    Skips a number of transform configs, defaults to 0

  • :size (Integer) —

    Specifies a max number of transforms to get, defaults to 100

See Also:

Since:

  • 7.2.0



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame/get_data_frame_transform.rb', line 34

def get_data_frame_transform(arguments={})
  arguments = arguments.clone
  transform_id = URI.escape(arguments.delete(:transform_id))

  valid_params = [
      :from,
      :size]

  method = Elasticsearch::API::HTTP_GET
  path   = Elasticsearch::API::Utils.__pathify('_data_frame/transforms', Elasticsearch::API::Utils.__listify(transform_id))
  params = Elasticsearch::API::Utils.__validate_and_extract_params(arguments, valid_params)
  body   = nil

  perform_request(method, path, params, body).body
end

#get_data_frame_transform_stats(arguments = {}) ⇒ Object

Retrieves usage information for data frame transforms.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (Integer) —

    The id or comma delimited list of id expressions of the transforms to get, ‘_all’ or ‘*’ implies get all transforms.

  • :from (Integer) —

    Skips a number of transform configs, defaults to 0

  • :type (Integer) —

    Specifies a max number of transform stats to get, defaults to 10

See Also:

Since:

  • 7.2.0



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame/get_data_frame_transform_stats.rb', line 34

def get_data_frame_transform_stats(arguments={})
  arguments = arguments.clone
  transform_id = URI.escape(arguments.delete(:transform_id))

  valid_params = [
      :from,
      :size]

  method = Elasticsearch::API::HTTP_GET
  path   = Elasticsearch::API::Utils.__pathify('_data_frame/transforms', Elasticsearch::API::Utils.__listify(transform_id), '_stats')
  params = Elasticsearch::API::Utils.__validate_and_extract_params(arguments, valid_params)
  body   = nil

  perform_request(method, path, params, body).body
end

#preview_data_frame_transform(arguments = {}) ⇒ Object

Previews a data frame transform.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :body (Hash) —

    The definition for the data_frame transform to preview. Required

Raises:

  • (ArgumentError)

See Also:



31
32
33
34
35
36
37
38
39
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame/preview_data_frame_transform.rb', line 31

def preview_data_frame_transform(arguments={})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  method = Elasticsearch::API::HTTP_POST
  path   = '_data_frame/transforms/_preview'
  params = {}
  body   = arguments[:body]

  perform_request(method, path, params, body).body
end

#put_data_frame_transform(arguments = {}) ⇒ Object

Instantiates a data frame transform.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (Hash) —

    The id of the new transform. Required

  • :body (Hash) —

    The data frame transform definition. Required

Raises:

  • (ArgumentError)

See Also:

Since:

  • 7.2.0



32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame/put_data_frame_transform.rb', line 32

def put_data_frame_transform(arguments={})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]

  transform_id = URI.escape(arguments[:transform_id])
  body = arguments[:body]

  method = Elasticsearch::API::HTTP_PUT
  path   = "_data_frame/transforms/#{transform_id}"
  params = {}

  perform_request(method, path, params, body).body
end

#start_data_frame_transform(arguments = {}) ⇒ Object

Start a data frame analytics job.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    The id of the transform to start. Required

  • :timeout (String) —

    Controls the time to wait for the transform to start.

Raises:

  • (ArgumentError)

See Also:

Since:

  • 7.2.0



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame/start_data_frame_transform.rb', line 32

def start_data_frame_transform(arguments={})
  raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
  arguments = arguments.clone
  transform_id = URI.escape(arguments.delete(:transform_id))

  valid_params = [
      :timeout]

  method = Elasticsearch::API::HTTP_POST
  path   = "_data_frame/transforms/#{transform_id}/_start"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
  body   = nil

  perform_request(method, path, params, body).body
end

#stop_data_frame_transform(arguments = {}) ⇒ Object

Stops one or more data frame transforms.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    The id of the transform(s) to stop.

  • :timeout (String) —

    Controls the time to wait until the transform has stopped. Default to 30 seconds.

  • :wait_for_completion (String) —

    Whether to wait for the transform to fully stop before returning or not. Default to false.

Raises:

  • (ArgumentError)

See Also:

Since:

  • 7.2.0



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

def stop_data_frame_transform(arguments={})
  raise ArgumentError, "Required argument 'transform_id' missing" unless arguments[:transform_id]
  arguments = arguments.clone
  transform_id = URI.escape(arguments.delete(:transform_id))

  valid_params = [
      :timeout,
      :wait_for_completion ]

  method = Elasticsearch::API::HTTP_POST
  path   = "_data_frame/transforms/#{Elasticsearch::API::Utils.__listify(transform_id)}/_stop"
  params = Elasticsearch::API::Utils.__validate_and_extract_params(arguments, valid_params)
  body   = nil

  perform_request(method, path, params, body).body
end