Skip to content

Commit

Permalink
Adds timeout, master_timeout parameters to several APIs:
Browse files Browse the repository at this point in the history
* index_lifecycle_management.delete_lifecycle - both
* index_lifecycle_management.explain_lifecycle - `master_timeout` only.
* index_lifecycle_management.get_lifecycle - both
* index_lifecycle_management.put_lifecycle - both
* index_lifecycle_management.start - both
* index_lifecycle_management.stop - both
* ingest.delete_geoip_database - both
* ingest.delete_ip_location_database - both
* ingest.put_geoip_database - both
* ingest.put_ip_location_database - both
* snapshot_lifecycle_management.delete_lifecycle - both
* snapshot_lifecycle_management.execute_lifecycle - both
* snapshot_lifecycle_management.execute_retention - both
* snapshot_lifecycle_management.get_lifecycle - both
* snapshot_lifecycle_management.get_stats - both
* snapshot_lifecycle_management.get_status - both
* snapshot_lifecycle_management.put_lifecycle - both

[Time] :master_timeout Explicit operation timeout for connection to master node.
[Time] :timeout Explicit operation timeout.

* open_point_in_time - adds allow_partial_search_results
  • Loading branch information
picandocodigo committed Dec 30, 2024
1 parent 5d53876 commit 3035747
Show file tree
Hide file tree
Showing 18 changed files with 50 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ module Actions
# Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted.
#
# @option arguments [String] :policy The name of the index lifecycle policy
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-delete-lifecycle.html
Expand All @@ -48,7 +50,7 @@ def delete_lifecycle(arguments = {})

method = Elasticsearch::API::HTTP_DELETE
path = "_ilm/policy/#{Utils.__listify(_policy)}"
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ module Actions
# @option arguments [String] :index The name of the index to explain
# @option arguments [Boolean] :only_managed filters the indices included in the response to ones managed by ILM
# @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-explain-lifecycle.html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ module Actions
# Returns the specified policy definition. Includes the policy version and last modified date.
#
# @option arguments [String] :policy The name of the index lifecycle policy
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-get-lifecycle.html
Expand All @@ -50,7 +52,7 @@ def get_lifecycle(arguments = {})
else
'_ilm/policy'
end
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ module Actions
# Creates a lifecycle policy
#
# @option arguments [String] :policy The name of the index lifecycle policy
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The lifecycle policy definition to register
#
Expand All @@ -49,7 +51,7 @@ def put_lifecycle(arguments = {})

method = Elasticsearch::API::HTTP_PUT
path = "_ilm/policy/#{Utils.__listify(_policy)}"
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ module IndexLifecycleManagement
module Actions
# Start the index lifecycle management (ILM) plugin.
#
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-start.html
Expand All @@ -38,7 +40,7 @@ def start(arguments = {})

method = Elasticsearch::API::HTTP_POST
path = '_ilm/start'
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ module IndexLifecycleManagement
module Actions
# Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
#
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ilm-stop.html
Expand All @@ -38,7 +40,7 @@ def stop(arguments = {})

method = Elasticsearch::API::HTTP_POST
path = '_ilm/stop'
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ module Actions
# Deletes a geoip database configuration
#
# @option arguments [List] :id A comma-separated list of geoip database configurations to delete
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-geoip-database-api.html
Expand All @@ -48,7 +50,7 @@ def delete_geoip_database(arguments = {})

method = Elasticsearch::API::HTTP_DELETE
path = "_ingest/geoip/database/#{Utils.__listify(_id)}"
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ module Actions
# Deletes an ip location database configuration
#
# @option arguments [List] :id A comma-separated list of ip location database configurations to delete
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-ip-location-database-api.html
Expand All @@ -48,7 +50,7 @@ def delete_ip_location_database(arguments = {})

method = Elasticsearch::API::HTTP_DELETE
path = "_ingest/ip_location/database/#{Utils.__listify(_id)}"
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ module Actions
# Puts the configuration for a geoip database to be downloaded
#
# @option arguments [String] :id The id of the database configuration
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The database configuration definition (*Required*)
#
Expand All @@ -50,7 +52,7 @@ def put_geoip_database(arguments = {})

method = Elasticsearch::API::HTTP_PUT
path = "_ingest/geoip/database/#{Utils.__listify(_id)}"
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ module Actions
# Puts the configuration for a ip location database to be downloaded
#
# @option arguments [String] :id The id of the database configuration
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The database configuration definition (*Required*)
#
Expand All @@ -50,7 +52,7 @@ def put_ip_location_database(arguments = {})

method = Elasticsearch::API::HTTP_PUT
path = "_ingest/ip_location/database/#{Utils.__listify(_id)}"
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ module Actions
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
# @option arguments [String] :keep_alive Specific the time to live for the point in time (*Required*)
# @option arguments [Boolean] :allow_partial_search_results Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false)
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body An index_filter specified with the Query DSL
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ module Actions
# Deletes an existing snapshot lifecycle policy.
#
# @option arguments [String] :policy_id The id of the snapshot lifecycle policy to remove
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-delete-policy.html
Expand All @@ -48,7 +50,7 @@ def delete_lifecycle(arguments = {})

method = Elasticsearch::API::HTTP_DELETE
path = "_slm/policy/#{Utils.__listify(_policy_id)}"
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ module Actions
# Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
#
# @option arguments [String] :policy_id The id of the snapshot lifecycle policy to be executed
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-execute-lifecycle.html
Expand All @@ -48,7 +50,7 @@ def execute_lifecycle(arguments = {})

method = Elasticsearch::API::HTTP_PUT
path = "_slm/policy/#{Utils.__listify(_policy_id)}/_execute"
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ module SnapshotLifecycleManagement
module Actions
# Deletes any snapshots that are expired according to the policy's retention rules.
#
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-execute-retention.html
Expand All @@ -38,7 +40,7 @@ def execute_retention(arguments = {})

method = Elasticsearch::API::HTTP_POST
path = '_slm/_execute_retention'
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ module Actions
# Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
#
# @option arguments [List] :policy_id Comma-separated list of snapshot lifecycle policies to retrieve
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-get-policy.html
Expand All @@ -50,7 +52,7 @@ def get_lifecycle(arguments = {})
else
'_slm/policy'
end
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ module SnapshotLifecycleManagement
module Actions
# Returns global and policy-level statistics about actions taken by snapshot lifecycle management.
#
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-get-stats.html
Expand All @@ -38,7 +40,7 @@ def get_stats(arguments = {})

method = Elasticsearch::API::HTTP_GET
path = '_slm/stats'
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ module SnapshotLifecycleManagement
module Actions
# Retrieves the status of snapshot lifecycle management (SLM).
#
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.16/slm-api-get-status.html
Expand All @@ -38,7 +40,7 @@ def get_status(arguments = {})

method = Elasticsearch::API::HTTP_GET
path = '_slm/status'
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ module Actions
# Creates or updates a snapshot lifecycle policy.
#
# @option arguments [String] :policy_id The id of the snapshot lifecycle policy
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The snapshot lifecycle policy definition to register
#
Expand All @@ -49,7 +51,7 @@ def put_lifecycle(arguments = {})

method = Elasticsearch::API::HTTP_PUT
path = "_slm/policy/#{Utils.__listify(_policy_id)}"
params = {}
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
Expand Down

0 comments on commit 3035747

Please sign in to comment.