[API] Updates timeout parameters:

picandocodigo · picandocodigo · commit b6f5171e88a6 · 2025-01-22T17:26:01.000Z
- `:master_timeout` (Time), explicit operation timeout for connection to master node.
- `:timeout` (Time), explicit operation timeout.

index_lifecycle_management.delete_lifecycle - both
index_lifecycle_management.delete_lifecycle - master_timeout
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_geoip_location_database - both
ingest.put_geoip_database - both
ingest.put_ip_location_database - both
license.post_start_trial - removes timeout
shutdown.delete_node - both
shutdown.put_node - 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
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb
@@ -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.17/ilm-delete-lifecycle.html
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb
@@ -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.17/ilm-explain-lifecycle.html
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb
@@ -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.17/ilm-get-lifecycle.html
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb
@@ -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
         #
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb
@@ -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.17/ilm-start.html
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb
@@ -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.17/ilm-stop.html
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb
@@ -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.17/delete-geoip-database-api.html
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb
@@ -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.17/delete-ip-location-database-api.html
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb
@@ -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*)
         #
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb
@@ -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*)
         #
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb
@@ -27,7 +27,6 @@ module Actions
         # @option arguments [String] :type The type of trial license to generate (default: "trial")
         # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false)
         # @option arguments [Time] :master_timeout Timeout for processing on master node
-        # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-trial.html
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb
@@ -25,6 +25,8 @@ module Actions
         # Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
         #
         # @option arguments [String] :node_id The node id of node to be removed from the shutdown state
+        # @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/current
@@ -48,7 +50,7 @@ def delete_node(arguments = {})
 
           method = Elasticsearch::API::HTTP_DELETE
           path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb
@@ -25,6 +25,8 @@ module Actions
         # Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
         #
         # @option arguments [String] :node_id The node id of node to be shut down
+        # @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 shutdown type definition to register (*Required*)
         #
@@ -50,7 +52,7 @@ def put_node(arguments = {})
 
           method = Elasticsearch::API::HTTP_PUT
           path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb
@@ -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.17/slm-api-delete-policy.html
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb
@@ -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.17/slm-api-execute-lifecycle.html
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb
@@ -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.17/slm-api-execute-retention.html
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb
@@ -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.17/slm-api-get-policy.html
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb
@@ -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.17/slm-api-get-stats.html
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb
@@ -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.17/slm-api-get-status.html
@@ -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)
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb
@@ -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
         #
@@ -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)

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ module Actions`
`27`	`27`	`# @option arguments [String] :index The name of the index to explain`
`28`	`28`	`# @option arguments [Boolean] :only_managed filters the indices included in the response to ones managed by ILM`
`29`	`29`	`# @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed`
	`30`	`+ # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node`
`30`	`31`	`# @option arguments [Hash] :headers Custom HTTP headers`
`31`	`32`	`#`
`32`	`33`	`# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ilm-explain-lifecycle.html`