Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,12 @@ module Actions
# @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries.
# @option arguments [String] :bytes The unit used to display byte values.
# @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
# It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
# Sorting defaults to ascending and can be changed by setting `:asc`
# or `:desc` as a suffix to the column name.
# @option arguments [String] :time Unit used to display time values.
# @option arguments [String] :time The unit used to display time values.
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ module Actions
# Supports wildcards (`*`).
# To target all data streams and indices, omit this parameter or use `*` or `_all`.
# @option arguments [String] :bytes The unit used to display byte values.
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
# It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
# Sorting defaults to ascending and can be changed by setting `:asc`
# or `:desc` as a suffix to the column name.
# @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
Expand Down
6 changes: 3 additions & 3 deletions elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ module Actions
# To target all data streams and indices, omit this parameter or use `*` or `_all`.
# @option arguments [String] :bytes The unit used to display byte values.
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
# Sorting defaults to ascending and can be changed by setting `:asc`
# or `:desc` as a suffix to the column name.
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
# @option arguments [String] :time Unit used to display time values.
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
# @option arguments [String] :time The unit used to display time values.
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ module Actions
# `_all` returns all repositories.
# If any repository fails during the request, Elasticsearch returns an error.
# @option arguments [Boolean] :ignore_unavailable If `true`, the response does not include information from unavailable snapshots.
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
# @option arguments [String, Array<String>] :h A comma-separated list of columns names to display.
# It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l.
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
# Sorting defaults to ascending and can be changed by setting `:asc`
# or `:desc` as a suffix to the column name.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ module Actions
# @option arguments [String, Array<String>] :thread_pool_patterns A comma-separated list of thread pool names used to limit the request.
# Accepts wildcard expressions.
# @option arguments [String, Array<String>] :h List of columns to appear in the response. Supports simple wildcards.
# @option arguments [String, Array<String>] :s List of columns that determine how the table should be sorted.
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases that determines the sort order.
# Sorting defaults to ascending and can be changed by setting `:asc`
# or `:desc` as a suffix to the column name.
# @option arguments [String] :time The unit used to display time values.
# @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the
# local cluster state. If `false` the list of selected nodes are computed
# from the cluster state of the master node. In both cases the coordinating
# node will send requests for further information to each selected node.
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s.
# @option arguments [String] :format Specifies the format to return the columnar data in, can be set to
# `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text.
# @option arguments [Boolean] :help When set to `true` will output available columns. This option
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ module Actions
# @option arguments [String] :name Comma-separated list of component template names used to limit the request.
# Wildcard (`*`) expressions are supported.
# @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format.
# @option arguments [String, Array<String>] :settings_filter Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys
# @option arguments [Boolean] :include_defaults Return all default configurations for the component template (default: false)
# @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only.
# If `false`, information is retrieved from the master node.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ module Actions
# If you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.
# If you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. (*Required*)
# @option arguments [Boolean] :create If `true`, this request cannot replace or update existing component templates.
# @option arguments [String] :cause User defined reason for create the component template. Server default: api.
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
5 changes: 3 additions & 2 deletions elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,12 @@ module Actions
# EQL assumes each document in a data stream or index corresponds to an event.
#
# @option arguments [String, Array] :index The name of the index to scope the operation (*Required*)
# @option arguments [Boolean] :allow_no_indices [TODO] Server default: true.
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) Server default: true.
# @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard failures. If false, returns an error with no partial results. Server default: true.
# @option arguments [Boolean] :allow_partial_sequence_results If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all.
# This flag has effect only if allow_partial_search_results is true.
# @option arguments [String, Array<String>] :expand_wildcards [TODO] Server default: open.
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open.
# @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution Server default: true.
# @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true.
# @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d.
# @option arguments [Boolean] :keep_on_completion If true, the search and its results are stored on the cluster.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ module Actions
# @option arguments [Boolean, String, Array<String>] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
# @option arguments [String, Array<String>] :_source_excludes A comma-separated list of source fields to exclude in the response.
# @option arguments [String, Array<String>] :_source_includes A comma-separated list of source fields to include in the response.
# @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit.
# @option arguments [Integer] :version The version number for concurrency control.
# It must match the current version of the document for the request to succeed.
# @option arguments [String] :version_type The version type.
Expand Down
1 change: 1 addition & 0 deletions elasticsearch-api/lib/elasticsearch/api/actions/index.rb
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ module Actions
# You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
# The default value of `1` means it waits for each primary shard to be active. Server default: 1.
# @option arguments [Boolean] :require_alias If `true`, the destination must be an index alias.
# @option arguments [Boolean] :require_data_stream If `true`, the request's actions must target a data stream (existing or to be created).
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
# when they occur.
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
# This code was automatically generated from the Elasticsearch Specification
# See https://github.com/elastic/elasticsearch-specification
# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
module Elasticsearch
module API
module Indices
module Actions
# Remove an index block.
# Remove an index block from an index.
# Index blocks limit the operations allowed on an index by blocking specific operation types.
#
# @option arguments [String] :index A comma-separated list or wildcard expression of index names used to limit the request.
# By default, you must explicitly name the indices you are removing blocks from.
# To allow the removal of blocks from indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.
# You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API. (*Required*)
# @option arguments [String] :block The block type to remove from the index. (*Required*)
# @option arguments [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
# This behavior applies even if the request targets other open indices.
# For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. Server default: true.
# @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
# If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
# It supports comma-separated values, such as `open,hidden`. Server default: open.
# @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
# @option arguments [Time] :master_timeout The period to wait for the master node.
# If the master node is not available before the timeout expires, the request fails and returns an error.
# It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
# @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
# If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.
# It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s.
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
# when they occur.
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
# returned by Elasticsearch.
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
# For example `"exists_time": "1h"` for humans and
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
# readable values will be omitted. This makes sense for responses being consumed
# only by machines.
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
# this option for debugging only.
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-remove-block
#
def remove_block(arguments = {})
request_opts = { endpoint: arguments[:endpoint] || 'indices.remove_block' }

defined_params = [:index, :block].each_with_object({}) do |variable, set_variables|
set_variables[variable] = arguments[variable] if arguments.key?(variable)
end
request_opts[:defined_params] = defined_params unless defined_params.empty?

raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
raise ArgumentError, "Required argument 'block' missing" unless arguments[:block]

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

body = nil

_index = arguments.delete(:index)

_block = arguments.delete(:block)

method = Elasticsearch::API::HTTP_DELETE
path = "#{Utils.listify(_index)}/_block/#{Utils.listify(_block)}"
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
)
end
end
end
end
end
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ module Actions
# * Azure AI Studio (`completion`, `text_embedding`)
# * Azure OpenAI (`completion`, `text_embedding`)
# * Cohere (`completion`, `rerank`, `text_embedding`)
# * DeepSeek (`completion`, `chat_completion`)
# * Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)
# * ELSER (`sparse_embedding`)
# * Google AI Studio (`completion`, `text_embedding`)
Expand All @@ -46,6 +47,7 @@ module Actions
#
# @option arguments [String] :task_type The task type. Refer to the integration list in the API description for the available task types.
# @option arguments [String] :inference_id The inference Id (*Required*)
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
# when they occur.
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ module Actions
#
# @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
# @option arguments [String] :alibabacloud_inference_id The unique identifier of the inference endpoint. (*Required*)
# @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
# when they occur.
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
Expand Down
Loading