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 @@ -44,7 +44,7 @@ module Actions
# @option arguments [String] :default_operator The default operator for query string query (AND or OR) Server default: or.
# @option arguments [String] :df The field to use as default where no field prefix is given in the query string
# @option arguments [String, Array<String>] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
# @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] :explain Specify whether to return detailed information about score computation as part of a hit
# @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module Actions
# or `:desc` as a suffix to the column name.
# @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`.
# It supports comma-separated values, such as `open,hidden`. Server default: all.
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
# If the master node is not available before the timeout expires, the request fails and returns an error.
# To indicated that the request should never timeout, you can set it to `-1`. Server default: 30s.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ module Actions
#
# @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
# Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
# @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
# @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match. Server default: all.
# @option arguments [String] :health The health status used to limit returned indices. By default, the response includes indices of any health status.
# @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
# @option arguments [Boolean] :pri If true, the response only includes information from primary shards.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module Actions
# The cluster status is controlled by the worst index status.
#
# @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or `*`.
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: all.
# @option arguments [String] :level Can be one of cluster, indices or shards. Controls the details level of the health information returned. Server default: cluster.
# @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
# @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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ module Actions
# @option arguments [String, Array<String>] :metric Limit the information returned to the specified metrics
# @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
# @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 [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
# @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] :flat_settings Return settings in flat format (default: false)
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module Actions
# Wildcard expressions (`*`) are supported.
# To target all data streams in a cluster, omit this parameter or use `*`.
# @option arguments [String, Array<String>] :expand_wildcards Type of data stream that wildcard patterns can match.
# Supports comma-separated values, such as `open,hidden`. Server default: open.
# Supports comma-separated values, such as `open,hidden`. Server default: open,closed.
# @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 @@ -37,7 +37,7 @@ module Actions
# This behavior applies even if the request targets other open indices. Server default: true.
# @option arguments [String, Array<String>] :expand_wildcards 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.
# Supports comma-separated values, such as `open,hidden`. Server default: open.
# Supports comma-separated values, such as `open,hidden`. Server default: open,closed.
# @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 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ module Actions
# Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.
#
# @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams (*Required*)
# @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
# @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) Server default: open.
# @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
# @option arguments [Time] :timeout Explicit timestamp for the document
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ module Actions
# Removes the data stream options from a data stream.
#
# @option arguments [String, Array<String>] :name A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams (*Required*)
# @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open)
# @option arguments [String, Array<String>] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) Server default: open.
# @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
# @option arguments [Time] :timeout Explicit timestamp for the document
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module Actions
# This behavior applies even if the request targets other open indices. Server default: true.
# @option arguments [String, Array<String>] :expand_wildcards 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.
# Supports comma-separated values, such as `open,hidden`. Server default: open.
# Supports comma-separated values, such as `open,hidden`. Server default: all.
# @option arguments [Boolean] :ignore_unavailable If `false`, requests that include a missing data stream or index in the target indices or data streams return an error.
# @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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ module Actions
# For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
# @option arguments [String, Array<String>] :expand_wildcards 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.
# Supports comma-separated values, such as `open,hidden`.
# Supports comma-separated values, such as `open,hidden`. Server default: open.
# @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response.
# @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ module Actions
#
# @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
# @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)
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
# @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] :flush Specify whether the index should be flushed after performing the operation (default: true)
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
# @option arguments [Integer] :max_num_segments The number of segments the index should be merged into (default: dynamic)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ module Actions
# This behavior applies even if the request targets other open indices. Server default: true.
# @option arguments [String, Array<String>] :expand_wildcards 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.
# Supports comma-separated values, such as `open,hidden`. Server default: open.
# Supports comma-separated values, such as `open,hidden`. Server default: all.
# @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 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ module Actions
# This behavior applies even if the request targets other open indices. Server default: true.
# @option arguments [String, Array<String>] :expand_wildcards 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.
# Supports comma-separated values, such as `open,hidden`. Server default: open.
# Supports comma-separated values, such as `open,hidden`. Server default: closed.
# @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 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ module Actions
#
# @option arguments [String, Array] :index A comma-separated list of index names to reload analyzers for (*Required*)
# @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)
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
# @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] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
# @option arguments [String] :resource Changed resource to reload analyzers from if applicable
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ module Actions
# @option arguments [String, Array<String>] :completion_fields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
# @option arguments [String, Array<String>] :expand_wildcards 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. Supports comma-separated values,
# such as `open,hidden`.
# such as `open,hidden`. Server default: open.
# @option arguments [String, Array<String>] :fielddata_fields Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
# @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
# @option arguments [Boolean] :forbid_closed_indices If true, statistics are not collected from closed indices. Server default: true.
Expand Down
2 changes: 1 addition & 1 deletion elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ module Actions
# @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases to search.
# @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.
# @option arguments [Boolean] :ccs_minimize_roundtrips If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. Server default: true.
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
# @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Server default: open.
# @option arguments [Boolean] :ignore_throttled If true, concrete, expanded or aliased indices are ignored when frozen.
# @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response.
# @option arguments [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ module Project
module Actions
# Get tags.
# Get the tags that are defined for the project.
# This API is only available in Serverless.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module Actions
# Wildcard (`*`) expressions are supported.
# To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`.
# @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 Whether to expand wildcard expression to concrete indices that are open, closed or both.
# @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] :ignore_unavailable If `true`, missing or closed indices are not included in the response.
# @option arguments [String] :search_type Search operation type
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Loading