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 @@ -35,21 +35,21 @@ module Actions
# Ongoing async searches and any saved search results are deleted after this period. Server default: 5d.
# @option arguments [Boolean] :keep_on_completion If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
# @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 [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
# @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout Server default: true.
# @option arguments [String] :analyzer The analyzer to use for the query string
# @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
# @option arguments [Integer] :batched_reduce_size Affects how often partial results become available, which happens whenever shard results are reduced.
# A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). Server default: 5.
# @option arguments [Boolean] :ccs_minimize_roundtrips The default value is the only supported value.
# @option arguments [String] :default_operator The default operator for query string query (AND or OR)
# @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 [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)
# @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
# @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
# @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests Server default: 5.
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
# @option arguments [String] :project_routing Specifies a subset of projects to target for the search using project
# metadata tags in a subset of Lucene query syntax.
Expand All @@ -65,7 +65,7 @@ module Actions
# @option arguments [Array<String>] :stats Specific 'tag' of the request for logging and statistical purposes
# @option arguments [String, Array<String>] :stored_fields A comma-separated list of stored fields to return as part of a hit
# @option arguments [String] :suggest_field Specifies which field to use for suggestions.
# @option arguments [String] :suggest_mode Specify suggest mode
# @option arguments [String] :suggest_mode Specify suggest mode Server default: missing.
# @option arguments [Integer] :suggest_size How many suggestions to return in response
# @option arguments [String] :suggest_text The source text for which the suggestions should be returned.
# @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ module Actions
# application consumption, use the get data frame analytics jobs statistics API.
#
# @option arguments [String] :id The ID of the data frame analytics to fetch
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified)
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs.
# (This includes `_all` string or when no configs have been specified.)
# @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: create_time,id,state,type.
# @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the
# response.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ module Actions
# If `false`, the API returns a 404 status code when there are no matches or only partial matches. Server default: true.
# @option arguments [String, Array<String>] :h A comma-separated list of column names to display.
# @option arguments [String, Array<String>] :s A comma-separated list of column names or aliases used to sort the response.
# @option arguments [Integer] :from Skips the specified number of transforms.
# @option arguments [Integer] :size The maximum number of transforms to display.
# @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0.
# @option arguments [Integer] :size The maximum number of transforms to display. Server default: 100.
# @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 @@ -33,7 +33,7 @@ module Actions
# SLA of official GA features.
#
# @option arguments [String] :connector_id The unique identifier of the connector to be deleted (*Required*)
# @option arguments [Boolean] :delete_sync_jobs A flag indicating if associated sync jobs should be also removed. Defaults to false.
# @option arguments [Boolean] :delete_sync_jobs A flag indicating if associated sync jobs should be also removed.
# @option arguments [Boolean] :hard A flag indicating if the connector should be hard deleted.
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
# when they occur.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ module Actions
# as-is with no warranties. Beta features are not subject to the support
# SLA of official GA features.
#
# @option arguments [Integer] :from Starting offset (default: 0)
# @option arguments [Integer] :size Specifies a max number of results to get
# @option arguments [Integer] :from Starting offset Server default: 0.
# @option arguments [Integer] :size Specifies a max number of results to get Server default: 100.
# @option arguments [String, Array] :index_name A comma-separated list of connector index names to fetch connector documents for
# @option arguments [String, Array<String>] :connector_name A comma-separated list of connector names to fetch connector documents for
# @option arguments [String, Array<String>] :service_type A comma-separated list of connector service types to fetch connector documents for
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ module Actions
# as-is with no warranties. Beta features are not subject to the support
# SLA of official GA features.
#
# @option arguments [Integer] :from Starting offset (default: 0)
# @option arguments [Integer] :size Specifies a max number of results to get
# @option arguments [Integer] :from Starting offset Server default: 0.
# @option arguments [Integer] :size Specifies a max number of results to get Server default: 100.
# @option arguments [String] :status A sync job status to fetch connector sync jobs for
# @option arguments [String] :connector_id A connector id to fetch connector sync jobs for
# @option arguments [String, Array<String>] :job_type A comma-separated list of job types to fetch the sync jobs for
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ module Actions
# @option arguments [Integer, String] :wait_for_active_shards Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be
# active.
# A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the
# remote Lucene segment files to the follower index.
# remote Lucene segment files to the follower index. Server default: 0.
# @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 @@ -28,7 +28,7 @@ module Actions
#
# @option arguments [String] :index_uuid The UUID of the index to delete. Use the get dangling indices API to find the UUID. (*Required*)
# @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. (*Required*)
# @option arguments [Time] :master_timeout Specify timeout for connection to master
# @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
# when they occur.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module Actions
# @option arguments [String] :index_uuid The UUID of the index to import. Use the get dangling indices API to locate the UUID. (*Required*)
# @option arguments [Boolean] :accept_data_loss This parameter must be set to true to import a dangling index.
# Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. (*Required*)
# @option arguments [Time] :master_timeout Specify timeout for connection to master
# @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
# when they occur.
Expand Down
2 changes: 1 addition & 1 deletion elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
#
# @option arguments [String] :id Identifier for the search. (*Required*)
# @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster.
# Defaults to the keep_alive value set by the search’s EQL search API request.
# Defaults to the keep_alive value set by the search’s EQL search API request. Server default: 5d.
# @option arguments [Time] :wait_for_completion_timeout Timeout duration to wait for the request to finish.
# Defaults to no timeout, meaning the request waits for complete search results.
# @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 @@ -29,7 +29,7 @@ module Actions
# @option arguments [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
# If `false`, the query will fail if there are any failures.To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. Server default: true.
# @option arguments [String] :delimiter The character to use between values within a CSV row.
# It is valid only for the CSV format.
# It is valid only for the CSV format. Server default: ,.
# @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
# If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.
# @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.For async requests, nothing will be returned if the async query doesn't finish within the timeout.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module Actions
# library is upgraded.
#
# @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.
# @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format.
# @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format. Server default: ,.
# @option arguments [Boolean] :drop_null_columns Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
# Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.
# @option arguments [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
# @option arguments [String] :id The identifier for the stored script or search template. (*Required*)
# @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: .
# 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
#
# @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 [Time] :master_timeout Specify timeout for connection to master
# @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
# when they occur.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
#
# @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 [Time] :master_timeout Specify timeout for connection to master
# @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
# when they occur.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
#
# @option arguments [String, Array] :index The name of the index to explain (*Required*)
# @option arguments [Boolean] :include_defaults indicates if the API should return the default values the system uses for the index's lifecycle
# @option arguments [Time] :master_timeout Specify timeout for connection to master
# @option arguments [Time] :master_timeout Specify timeout for connection to master 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 @@ -70,7 +70,7 @@ module Actions
# @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)
# @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents
# @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed.
# @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed. Server default: true.
# @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 @@ -48,7 +48,7 @@ module Actions
# @option arguments [Boolean] :create If `true`, this request cannot replace or update existing index templates.
# @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 [String] :cause User defined reason for creating/updating the index template
# @option arguments [String] :cause User defined reason for creating/updating the index template Server default: api.
# @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