Module: ElasticsearchServerless::API::Transform::Actions

Defined in:: lib/elasticsearch-serverless/api/transform/get_transform.rb,
lib/elasticsearch-serverless/api/transform/put_transform.rb,
lib/elasticsearch-serverless/api/transform/stop_transform.rb,
lib/elasticsearch-serverless/api/transform/reset_transform.rb,
lib/elasticsearch-serverless/api/transform/start_transform.rb,
lib/elasticsearch-serverless/api/transform/delete_transform.rb,
lib/elasticsearch-serverless/api/transform/update_transform.rb,
lib/elasticsearch-serverless/api/transform/preview_transform.rb,
lib/elasticsearch-serverless/api/transform/get_transform_stats.rb,
lib/elasticsearch-serverless/api/transform/schedule_now_transform.rb

Instance Method Summary collapse

#delete_transform(arguments = {}) ⇒ Object

Deletes a transform.
#get_transform(arguments = {}) ⇒ Object

Retrieves configuration information for transforms.
#get_transform_stats(arguments = {}) ⇒ Object

Retrieves usage information for transforms.
#preview_transform(arguments = {}) ⇒ Object

Previews a transform.
#put_transform(arguments = {}) ⇒ Object

Creates a transform.
#reset_transform(arguments = {}) ⇒ Object

Resets a transform.
#schedule_now_transform(arguments = {}) ⇒ Object

Schedules now a transform.
#start_transform(arguments = {}) ⇒ Object

Starts a transform.
#stop_transform(arguments = {}) ⇒ Object

Stops one or more transforms.
#update_transform(arguments = {}) ⇒ Object

Updates certain properties of a transform.

Instance Method Details

#delete_transform(arguments = {}) ⇒ `Object`

Deletes a transform.

Parameters:

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

a customizable set of options

Options Hash (arguments):

:transform_id (String) —

Identifier for the transform. (Required)
:force (Boolean) —

If this value is false, the transform must be stopped before it can be deleted. If true, the transform is deleted regardless of its current state.
:delete_dest_index (Boolean) —

If this value is true, the destination index is deleted together with the transform. If false, the destination index will not be deleted
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html

# File 'lib/elasticsearch-serverless/api/transform/delete_transform.rb', line 35

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

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

  body = nil

  _transform_id = arguments.delete(:transform_id)

  method = ElasticsearchServerless::API::HTTP_DELETE
  path   = "_transform/#{Utils.listify(_transform_id)}"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
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, Array<String>) —

Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using _all, by specifying * as the <transform_id>, or by omitting the <transform_id>.
:allow_no_match (Boolean) —

Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. Server default: true.
:from (Integer) —

Skips the specified number of transforms. Server default: 0.
:size (Integer) —

Specifies the maximum number of transforms to obtain. Server default: 100.
:exclude_generated (Boolean) —

Excludes fields that were automatically added when creating the transform. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.
:headers (Hash) —

Custom HTTP headers

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html

# File 'lib/elasticsearch-serverless/api/transform/get_transform.rb', line 36

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

  body = nil

  _transform_id = arguments.delete(:transform_id)

  method = ElasticsearchServerless::API::HTTP_GET
  path   = if _transform_id
             "_transform/#{Utils.listify(_transform_id)}"
           else
             "_transform"
           end
  params = Utils.process_params(arguments)

  ElasticsearchServerless::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
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, Array<String>) —

Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using _all, by specifying * as the <transform_id>, or by omitting the <transform_id>. (Required)
:allow_no_match (Boolean) —

Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. Server default: true.
:from (Integer) —

Skips the specified number of transforms. Server default: 0.
:size (Integer) —

Specifies the maximum number of transforms to obtain. Server default: 100.
:timeout (Time) —

Controls the time to wait for the stats
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html

# File 'lib/elasticsearch-serverless/api/transform/get_transform_stats.rb', line 36

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

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

  body = nil

  _transform_id = arguments.delete(:transform_id)

  method = ElasticsearchServerless::API::HTTP_GET
  path   = "_transform/#{Utils.listify(_transform_id)}/_stats"
  params = Utils.process_params(arguments)

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

#preview_transform(arguments = {}) ⇒ `Object`

Previews a transform.

It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations.

Parameters:

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

a customizable set of options

Options Hash (arguments):

:transform_id (String) —

Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in the request body.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html

# File 'lib/elasticsearch-serverless/api/transform/preview_transform.rb', line 38

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

  body = arguments.delete(:body)

  _transform_id = arguments.delete(:transform_id)

  method = if body
             ElasticsearchServerless::API::HTTP_POST
           else
             ElasticsearchServerless::API::HTTP_GET
           end

  path   = if _transform_id
             "_transform/#{Utils.listify(_transform_id)}/_preview"
           else
             "_transform/_preview"
           end
  params = Utils.process_params(arguments)

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

#put_transform(arguments = {}) ⇒ `Object`

Creates a transform.

A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a unique row per entity.

You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If you choose to use the pivot method for your transform, the entities are defined by the set of group_by fields in the pivot object. If you choose to use the latest method, the entities are defined by the unique_key field values in the latest object.

You must have create_index, index, and read privileges on the destination index and read and view_index_metadata privileges on the source indices. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations.

NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any .transform-internal* indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users any privileges on .transform-internal* indices. If you used transforms prior to 7.5, also do not give users any privileges on .data-frame-internal* indices.

Parameters:

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

a customizable set of options

Options Hash (arguments):

:transform_id (String) —

Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. (Required)
:defer_validation (Boolean) —

When the transform is created, a series of validations occur to ensure its success. For example, there is a check for the existence of the source indices and a check that the destination index is not part of the source index pattern. You can use this parameter to skip the checks, for example when the source index does not exist until after the transform is created. The validations are always run when you start the transform, however, with the exception of privilege checks.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html

# File 'lib/elasticsearch-serverless/api/transform/put_transform.rb', line 55

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

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

  body = arguments.delete(:body)

  _transform_id = arguments.delete(:transform_id)

  method = ElasticsearchServerless::API::HTTP_PUT
  path   = "_transform/#{Utils.listify(_transform_id)}"
  params = Utils.process_params(arguments)

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

#reset_transform(arguments = {}) ⇒ `Object`

Resets a transform. Before you can reset it, you must stop it; alternatively, use the force query parameter. If the destination index was created by the transform, it is deleted.

Parameters:

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

a customizable set of options

Options Hash (arguments):

:transform_id (String) —

Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. (Required)
:force (Boolean) —

If this value is true, the transform is reset regardless of its current state. If it’s false, the transform must be stopped before it can be reset.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html

# File 'lib/elasticsearch-serverless/api/transform/reset_transform.rb', line 35

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

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

  body = nil

  _transform_id = arguments.delete(:transform_id)

  method = ElasticsearchServerless::API::HTTP_POST
  path   = "_transform/#{Utils.listify(_transform_id)}/_reset"
  params = Utils.process_params(arguments)

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

#schedule_now_transform(arguments = {}) ⇒ `Object`

Schedules now a transform.

If you _schedule_now a transform, it will process the new data instantly, without waiting for the configured frequency interval. After _schedule_now API is called, the transform will be processed again at now + frequency unless _schedule_now API is called again in the meantime.

Parameters:

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

a customizable set of options

Options Hash (arguments):

:transform_id (String) —

Identifier for the transform. (Required)
:timeout (Time) —

Controls the time to wait for the scheduling to take place Server default: 30s.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html

# File 'lib/elasticsearch-serverless/api/transform/schedule_now_transform.rb', line 38

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

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

  body = nil

  _transform_id = arguments.delete(:transform_id)

  method = ElasticsearchServerless::API::HTTP_POST
  path   = "_transform/#{Utils.listify(_transform_id)}/_schedule_now"
  params = Utils.process_params(arguments)

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

#start_transform(arguments = {}) ⇒ `Object`

Starts a transform.

When you start a transform, it creates the destination index if it does not already exist. The number_of_shards is set to 1 and the auto_expand_replicas is set to 0-1. If it is a pivot transform, it deduces the mapping definitions for the destination index from the source indices and the transform aggregations. If fields in the destination index are derived from scripts (as in the case of scripted_metric or bucket_script aggregations), the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings in a pivot transform.

When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you created the transform, they occur when you start the transform—with the exception of privilege checks. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations.

Parameters:

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

a customizable set of options

Options Hash (arguments):

:transform_id (String) —

Identifier for the transform. (Required)
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:from (String) —

Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html

# File 'lib/elasticsearch-serverless/api/transform/start_transform.rb', line 49

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

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

  body = nil

  _transform_id = arguments.delete(:transform_id)

  method = ElasticsearchServerless::API::HTTP_POST
  path   = "_transform/#{Utils.listify(_transform_id)}/_start"
  params = Utils.process_params(arguments)

  ElasticsearchServerless::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
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) —

Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. To stop all transforms, use _all or * as the identifier. (Required)
:allow_no_match (Boolean) —

Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If it is true, the API returns a successful acknowledgement message when there are no matches. When there are only partial matches, the API stops the appropriate transforms. If it is false, the request returns a 404 status code when there are no matches or only partial matches. Server default: true.
:force (Boolean) —

If it is true, the API forcefully stops the transforms.
:timeout (Time) —

Period to wait for a response when wait_for_completion is true. If no response is received before the timeout expires, the request returns a timeout exception. However, the request continues processing and eventually moves the transform to a STOPPED state. Server default: 30s.
:wait_for_checkpoint (Boolean) —

If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, the transform stops as soon as possible.
:wait_for_completion (Boolean) —

If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns immediately and the indexer is stopped asynchronously in the background.
:headers (Hash) —

Custom HTTP headers

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html

# File 'lib/elasticsearch-serverless/api/transform/stop_transform.rb', line 37

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

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

  body = nil

  _transform_id = arguments.delete(:transform_id)

  method = ElasticsearchServerless::API::HTTP_POST
  path   = "_transform/#{Utils.listify(_transform_id)}/_stop"
  params = Utils.process_params(arguments)

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

#update_transform(arguments = {}) ⇒ `Object`

Updates certain properties of a transform.

All updated properties except description do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata privileges for the source indices. You must also have index and read privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges.

Parameters:

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

a customizable set of options

Options Hash (arguments):

:transform_id (String) —

Identifier for the transform. (Required)
:defer_validation (Boolean) —

When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created.
:timeout (Time) —

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
:headers (Hash) —

Custom HTTP headers
:body (Hash) —

request body

Raises:

(ArgumentError)

See Also:

https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html

# File 'lib/elasticsearch-serverless/api/transform/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]

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

  body = arguments.delete(:body)

  _transform_id = arguments.delete(:transform_id)

  method = ElasticsearchServerless::API::HTTP_POST
  path   = "_transform/#{Utils.listify(_transform_id)}/_update"
  params = Utils.process_params(arguments)

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

Module: ElasticsearchServerless::API::Transform::Actions

Instance Method Summary collapse

Instance Method Details

#delete_transform(arguments = {}) ⇒ Object

#get_transform(arguments = {}) ⇒ Object

#get_transform_stats(arguments = {}) ⇒ Object

#preview_transform(arguments = {}) ⇒ Object

#put_transform(arguments = {}) ⇒ Object

#reset_transform(arguments = {}) ⇒ Object

#schedule_now_transform(arguments = {}) ⇒ Object

#start_transform(arguments = {}) ⇒ Object

#stop_transform(arguments = {}) ⇒ Object

#update_transform(arguments = {}) ⇒ Object

#delete_transform(arguments = {}) ⇒ `Object`

#get_transform(arguments = {}) ⇒ `Object`

#get_transform_stats(arguments = {}) ⇒ `Object`

#preview_transform(arguments = {}) ⇒ `Object`

#put_transform(arguments = {}) ⇒ `Object`

#reset_transform(arguments = {}) ⇒ `Object`

#schedule_now_transform(arguments = {}) ⇒ `Object`

#start_transform(arguments = {}) ⇒ `Object`

#stop_transform(arguments = {}) ⇒ `Object`

#update_transform(arguments = {}) ⇒ `Object`