Module: Elasticsearch::XPack::API::Transform::Actions

Included in:
TransformClient
Defined in:
lib/elasticsearch/xpack/api/namespace/transform.rb,
lib/elasticsearch/xpack/api/actions/transform/get_transform.rb,
lib/elasticsearch/xpack/api/actions/transform/put_transform.rb,
lib/elasticsearch/xpack/api/actions/transform/stop_transform.rb,
lib/elasticsearch/xpack/api/actions/transform/params_registry.rb,
lib/elasticsearch/xpack/api/actions/transform/start_transform.rb,
lib/elasticsearch/xpack/api/actions/transform/delete_transform.rb,
lib/elasticsearch/xpack/api/actions/transform/update_transform.rb,
lib/elasticsearch/xpack/api/actions/transform/preview_transform.rb,
lib/elasticsearch/xpack/api/actions/transform/upgrade_transforms.rb,
lib/elasticsearch/xpack/api/actions/transform/get_transform_stats.rb

Defined Under Namespace

Modules: ParamsRegistry

Instance Method Summary collapse

Instance Method Details

#delete_transform(arguments = {}) ⇒ Object

Deletes an existing transform.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    The id of the transform to delete

  • :force (Boolean) —

    When ‘true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted.

  • :timeout (Time) —

    Controls the time to wait for the transform deletion

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



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

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

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

  arguments = arguments.clone

  _transform_id = arguments.delete(:transform_id)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

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

#get_transform(arguments = {}) ⇒ Object

Retrieves configuration information for transforms.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    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

  • :allow_no_match (Boolean) —

    Whether to ignore if a wildcard expression matches no transforms. (This includes ‘_all` string or when no transforms have been specified)

  • :exclude_generated (Boolean) —

    Omits fields that are illegal to set on transform PUT

  • :headers (Hash) —

    Custom HTTP headers

See Also:



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

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

  arguments = arguments.clone

  _transform_id = arguments.delete(:transform_id)

  method = Elasticsearch::API::HTTP_GET
  path   = if _transform_id
             "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
           else
             "_transform"
           end
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

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

#get_transform_stats(arguments = {}) ⇒ Object

Retrieves usage information for transforms.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    The id of the transform for which to get stats. ‘_all’ or ‘*’ implies all transforms

  • :from (Number) —

    skips a number of transform stats, defaults to 0

  • :size (Number) —

    specifies a max number of transform stats to get, defaults to 100

  • :allow_no_match (Boolean) —

    Whether to ignore if a wildcard expression matches no transforms. (This includes ‘_all` string or when no transforms have been specified)

  • :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
 
# File 'lib/elasticsearch/xpack/api/actions/transform/get_transform_stats.rb', line 33

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

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

  arguments = arguments.clone

  _transform_id = arguments.delete(:transform_id)

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

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

#preview_transform(arguments = {}) ⇒ Object

Previews a transform.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    The id of the transform to preview.

  • :timeout (Time) —

    Controls the time to wait for the preview

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The definition for the transform to preview

See Also:



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/elasticsearch/xpack/api/actions/transform/preview_transform.rb', line 32

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

  arguments = arguments.clone

  _transform_id = arguments.delete(:transform_id)

  method = if arguments[:body]
             Elasticsearch::API::HTTP_POST
           else
             Elasticsearch::API::HTTP_GET
           end

  path   = if _transform_id
             "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}/_preview"
           else
             "_transform/_preview"
           end
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = arguments[:body]
  perform_request(method, path, params, body, headers).body
end

#put_transform(arguments = {}) ⇒ Object

Instantiates a transform.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    The id of the new transform.

  • :defer_validation (Boolean) —

    If validations should be deferred until transform starts, defaults to false.

  • :timeout (Time) —

    Controls the time to wait for the transform to start

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The transform definition (Required)

Raises:

  • (ArgumentError)

See Also:



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

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

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

  arguments = arguments.clone

  _transform_id = arguments.delete(:transform_id)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = arguments[:body]
  perform_request(method, path, params, body, headers).body
end

#start_transform(arguments = {}) ⇒ Object

Starts one or more transforms.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    The id of the transform to start

  • :timeout (Time) —

    Controls the time to wait for the transform to start

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



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

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

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

  arguments = arguments.clone

  _transform_id = arguments.delete(:transform_id)

  method = Elasticsearch::API::HTTP_POST
  path   = "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}/_start"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

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

#stop_transform(arguments = {}) ⇒ Object

Stops one or more transforms.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    The id of the transform to stop

  • :force (Boolean) —

    Whether to force stop a failed transform or not. Default to false

  • :wait_for_completion (Boolean) —

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

  • :timeout (Time) —

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

  • :allow_no_match (Boolean) —

    Whether to ignore if a wildcard expression matches no transforms. (This includes ‘_all` string or when no transforms have been specified)

  • :wait_for_checkpoint (Boolean) —

    Whether to wait for the transform to reach a checkpoint before stopping. Default to false

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



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

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

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

  arguments = arguments.clone

  _transform_id = arguments.delete(:transform_id)

  method = Elasticsearch::API::HTTP_POST
  path   = "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}/_stop"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

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

#update_transform(arguments = {}) ⇒ Object

Updates certain properties of a transform.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    The id of the transform. (Required)

  • :defer_validation (Boolean) —

    If validations should be deferred until transform starts, defaults to false.

  • :timeout (Time) —

    Controls the time to wait for the update

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The update transform definition (Required)

Raises:

  • (ArgumentError)

See Also:



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

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

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

  arguments = arguments.clone

  _transform_id = arguments.delete(:transform_id)

  method = Elasticsearch::API::HTTP_POST
  path   = "_transform/#{Elasticsearch::API::Utils.__listify(_transform_id)}/_update"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = arguments[:body]
  perform_request(method, path, params, body, headers).body
end

#upgrade_transforms(arguments = {}) ⇒ Object

Upgrades all transforms.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :dry_run (Boolean) —

    Whether to only check for updates but don’t execute

  • :timeout (Time) —

    Controls the time to wait for the upgrade

  • :headers (Hash) —

    Custom HTTP headers

See Also:



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

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

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_POST
  path   = "_transform/_upgrade"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

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