Skip to content

Commit 332b738

Browse files
committed
[API] Updates cluster component template, open PIT and search_mvt
cluster.get_component_template: * Adds [Boolean] :flat_settings Return settings in flat format (default: false) * Adds [String] :settings_filter Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys cluster.put_component_template: * Adds [String] :cause User defined reason for create the component template. open_point_in_time: * Adds [Number] :max_concurrent_shard_requests The number of concurrent shard requests per node executed concurrently when opening this point-in-time. search_mvt: * Adds [String] :grid_agg Aggregation used to create a grid for `field`.
1 parent 8dc9081 commit 332b738

File tree

4 files changed

+5
-1
lines changed

4 files changed

+5
-1
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ module Actions
2828
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
2929
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
3030
# @option arguments [Boolean] :include_defaults Return all default configurations for the component template (default: false)
31+
# @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
32+
# @option arguments [String] :settings_filter Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys
3133
# @option arguments [Hash] :headers Custom HTTP headers
3234
#
3335
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.18/indices-component-template.html

elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ module Actions
2626
#
2727
# @option arguments [String] :name The name of the template
2828
# @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one
29-
# @option arguments [Time] :timeout Explicit operation timeout
29+
# @option arguments [String] :cause User defined reason for create the component template
3030
# @option arguments [Time] :master_timeout Specify timeout for connection to master
3131
# @option arguments [Hash] :headers Custom HTTP headers
3232
# @option arguments [Hash] :body The template definition (*Required*)

elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ module Actions
3030
# @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)
3131
# @option arguments [String] :keep_alive Specific the time to live for the point in time (*Required*)
3232
# @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)
33+
# @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests per node executed concurrently when opening this point-in-time. This value should be used to limit the impact of opening the point-in-time on the cluster
3334
# @option arguments [Hash] :headers Custom HTTP headers
3435
# @option arguments [Hash] :body An index_filter specified with the Query DSL
3536
#

elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ module Actions
3636
# @option arguments [Integer] :extent Size, in pixels, of a side of the vector tile.
3737
# @option arguments [Integer] :grid_precision Additional zoom levels available through the aggs layer. Accepts 0-8.
3838
# @option arguments [String] :grid_type Determines the geometry type for features in the aggs layer. (options: grid, point, centroid)
39+
# @option arguments [String] :grid_agg Aggregation used to create a grid for `field`. (options: geotile, geohex)
3940
# @option arguments [Integer] :size Maximum number of features to return in the hits layer. Accepts 0-10000.
4041
# @option arguments [Boolean|long] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
4142
# @option arguments [Boolean] :with_labels If true, the hits and aggs layers will contain additional point features with suggested label positions for the original features.

0 commit comments

Comments
 (0)