Module: Elasticsearch::XPack::API::DataFrameTransformDeprecated::Actions

Included in:
Graph::DataFrameClient
Defined in:
lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/put_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/stop_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/params_registry.rb,
lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/start_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/delete_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/update_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/preview_transform.rb,
lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform_stats.rb

Defined Under Namespace

Modules: ParamsRegistry

Instance Method Summary collapse

Instance Method Details

#delete_transform(arguments = {}) ⇒ Object

Deletes an existing transform. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

*Deprecation notice*:

_data_frame/transforms/

is deprecated, use [_transform/] in the future.

Deprecated since version 7.5.0

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.

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/delete_transform.rb', line 40

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   = "_data_frame/transforms/#{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. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

*Deprecation notice*:

_data_frame/transforms/

is deprecated, use [_transform/] in the future.

Deprecated since version 7.5.0

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 generated fields. Allows transform configurations to be easily copied between clusters and within the same cluster

  • :headers (Hash) —

    Custom HTTP headers

See Also:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform.rb', line 43

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
             "_data_frame/transforms/#{Elasticsearch::API::Utils.__listify(_transform_id)}"
           else
             "_data_frame/transforms"
           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. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

*Deprecation notice*:

_data_frame/transforms/

is deprecated, use [_transform/] in the future.

Deprecated since version 7.5.0

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:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform_stats.rb', line 42

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   = "_data_frame/transforms/#{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. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

*Deprecation notice*:

_data_frame/transforms/

is deprecated, use [_transform/] in the future.

Deprecated since version 7.5.0

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The definition for the transform to preview (Required)

Raises:

  • (ArgumentError)

See Also:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/preview_transform.rb', line 39

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

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

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_POST
  path   = "_data_frame/transforms/_preview"
  params = {}

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

#put_transform(arguments = {}) ⇒ Object

Instantiates a transform. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

*Deprecation notice*:

_data_frame/transforms/

is deprecated, use [_transform/] in the future.

Deprecated since version 7.5.0

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.

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The transform definition (Required)

Raises:

  • (ArgumentError)

See Also:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/put_transform.rb', line 41

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   = "_data_frame/transforms/#{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. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

*Deprecation notice*:

_data_frame/transforms/

is deprecated, use [_transform/] in the future.

Deprecated since version 7.5.0

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:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/start_transform.rb', line 40

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   = "_data_frame/transforms/#{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. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

*Deprecation notice*:

_data_frame/transforms/

is deprecated, use [_transform/] in the future.

Deprecated since version 7.5.0

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :transform_id (String) —

    The id of the transform to stop

  • :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)

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/stop_transform.rb', line 42

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   = "_data_frame/transforms/#{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. This functionality is in Beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

*Deprecation notice*:

_data_frame/transforms/

is deprecated, use [_transform/] in the future.

Deprecated since version 7.5.0

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.

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The update transform definition (Required)

Raises:

  • (ArgumentError)

See Also:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/update_transform.rb', line 41

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   = "_data_frame/transforms/#{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