module Elasticsearch::XPack::API::DataFrameTransformDeprecated::Actions

Public Instance Methods

delete_transform(arguments = {}) click to toggle source

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.

@option arguments [String] :transform_id The id of the transform to delete @option arguments [Boolean] :force 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. @option arguments [Hash] :headers Custom HTTP headers

*Deprecation notice*:

_data_frame/transforms/

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

Deprecated since version 7.5.0

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/delete-transform.html

# 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 = {}) click to toggle source

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.

@option arguments [String] :transform_id The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms @option arguments [Int] :from skips a number of transform configs, defaults to 0 @option arguments [Int] :size specifies a max number of transforms to get, defaults to 100 @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) @option arguments [Boolean] :exclude_generated Omits generated fields. Allows transform configurations to be easily copied between clusters and within the same cluster @option arguments [Hash] :headers Custom HTTP headers

*Deprecation notice*:

_data_frame/transforms/

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

Deprecated since version 7.5.0

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/get-transform.html

# 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 = {}) click to toggle source

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.

@option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms @option arguments [Number] :from skips a number of transform stats, defaults to 0 @option arguments [Number] :size specifies a max number of transform stats to get, defaults to 100 @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) @option arguments [Hash] :headers Custom HTTP headers

*Deprecation notice*:

_data_frame/transforms/

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

Deprecated since version 7.5.0

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/get-transform-stats.html

# 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 = {}) click to toggle source

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.

@option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The definition for the transform to preview (Required)

*Deprecation notice*:

_data_frame/transforms/

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

Deprecated since version 7.5.0

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/preview-transform.html

# 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 = {}) click to toggle source

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.

@option arguments [String] :transform_id The id of the new transform. @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The transform definition (Required)

*Deprecation notice*:

_data_frame/transforms/

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

Deprecated since version 7.5.0

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/put-transform.html

# 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 = {}) click to toggle source

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.

@option arguments [String] :transform_id The id of the transform to start @option arguments [Time] :timeout Controls the time to wait for the transform to start @option arguments [Hash] :headers Custom HTTP headers

*Deprecation notice*:

_data_frame/transforms/

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

Deprecated since version 7.5.0

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/start-transform.html

# 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 = {}) click to toggle source

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.

@option arguments [String] :transform_id The id of the transform to stop @option arguments [Boolean] :wait_for_completion Whether to wait for the transform to fully stop before returning or not. Default to false @option arguments [Time] :timeout Controls the time to wait until the transform has stopped. Default to 30 seconds @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) @option arguments [Hash] :headers Custom HTTP headers

*Deprecation notice*:

_data_frame/transforms/

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

Deprecated since version 7.5.0

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/stop-transform.html

# 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 = {}) click to toggle source

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.

@option arguments [String] :transform_id The id of the transform. (Required) @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false. @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The update transform definition (Required)

*Deprecation notice*:

_data_frame/transforms/

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

Deprecated since version 7.5.0

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/update-transform.html

# 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