module Elasticsearch::API::Cat::Actions
Public Instance Methods
Source
# File lib/elasticsearch/api/actions/cat/aliases.rb, line 50 def aliases(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.aliases' } defined_params = [:name].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_GET path = if _name "_cat/aliases/#{Utils.listify(_name)}" else '_cat/aliases' end params = Utils.process_params(arguments) params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get aliases. Get the cluster’s index aliases, including filter and routing information. This API
does not return data stream aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API
.
@option arguments [String, Array<String>] :name A comma-separated list of aliases to retrieve. Supports wildcards (+*+). To retrieve all aliases, omit this parameter or use +*+ or _all
. @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.
Sorting defaults to ascending and can be changed by setting +:asc+ 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+.
@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.
@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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-aliases
Source
# File lib/elasticsearch/api/actions/cat/allocation.rb, line 49 def allocation(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.allocation' } defined_params = [:node_id].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _node_id = arguments.delete(:node_id) method = Elasticsearch::API::HTTP_GET path = if _node_id "_cat/allocation/#{Utils.listify(_node_id)}" else '_cat/allocation' end params = Utils.process_params(arguments) params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get shard allocation information. Get a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
@option arguments [String, Array] :node_id A comma-separated list of node identifiers or names used to limit the returned information. @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.
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
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 [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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-allocation
Source
# File lib/elasticsearch/api/actions/cat/component_templates.rb, line 52 def component_templates(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.component_templates' } defined_params = [:name].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_GET path = if _name "_cat/component_templates/#{Utils.listify(_name)}" else '_cat/component_templates' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get component templates. Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API
.
@option arguments [String] :name The name of the component template.
It accepts wildcard expressions. If it is omitted, all component templates are returned.
@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.
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
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 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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-component-templates
Source
# File lib/elasticsearch/api/actions/cat/count.rb, line 47 def count(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.count' } defined_params = [:index].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index "_cat/count/#{Utils.listify(_index)}" else '_cat/count' end params = Utils.process_params(arguments) params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get a document count. Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API
.
@option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request.
It supports wildcards (+*+). To target all data streams and indices, omit this parameter or use +*+ or +_all+.
@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.
Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
@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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count
Source
# File lib/elasticsearch/api/actions/cat/fielddata.rb, line 46 def fielddata(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.fielddata' } defined_params = [:fields].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _fields = arguments.delete(:fields) method = Elasticsearch::API::HTTP_GET path = if _fields "_cat/fielddata/#{Utils.listify(_fields)}" else '_cat/fielddata' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get field data cache information. Get the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API
.
@option arguments [String, Array<String>] :fields Comma-separated list of fields used to limit returned information.
To retrieve all fields, omit this parameter.
@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.
Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
@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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-fielddata
Source
# File lib/elasticsearch/api/actions/cat/health.rb, line 51 def health(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.health' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/health' params = Utils.process_params(arguments) params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get the cluster health status. IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API
. This API
is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API
returns timestamps in two formats: HH:MM:SS
, which is human-readable but includes no date information; +Unix epoch time+, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API
to verify cluster health across multiple nodes. You also can use the API
to track the recovery of a large cluster over a longer period of time.
@option arguments [String] :time The unit used to display time values. @option arguments [Boolean] :ts If true, returns HH:MM:SS
and Unix epoch timestamps. Server default: true. @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.
Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
@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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-health
Source
# File lib/elasticsearch/api/actions/cat/help.rb, line 32 def help(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.help' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_cat' params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get CAT help. Get help for the CAT APIs.
@option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cat
Source
# File lib/elasticsearch/api/actions/cat/indices.rb, line 60 def indices(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.indices' } defined_params = [:index].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index "_cat/indices/#{Utils.listify(_index)}" else '_cat/indices' end params = Utils.process_params(arguments) params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get index information. Get high-level information about indices in a cluster, including backing indices for data streams. Use this request to get the following information for each index in a cluster:
-
shard count
-
document count
-
deleted document count
-
primary store size
-
total store size of all shards, including shard replicas
These metrics are retrieved directly from Lucene, which Elasticsearch
uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch
documents, use the cat count or count APIs. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint.
@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] :bytes The unit used to display byte values. @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match. @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. @option arguments [String] :time The unit used to display time values. @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. @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.
Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
@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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-indices
Source
# File lib/elasticsearch/api/actions/cat/master.rb, line 47 def master(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.master' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/master' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get master node information. Get information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API
.
@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.
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
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 [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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-master
Source
# File lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb, line 47 def ml_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_data_frame_analytics' } defined_params = [:id].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET path = if _id "_cat/ml/data_frame/analytics/#{Utils.listify(_id)}" else '_cat/ml/data_frame/analytics' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get data frame analytics jobs. Get configuration and usage information about data frame analytics jobs. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For 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 [String] :bytes The unit in which to display byte values @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.
@option arguments [String] :time 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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-data-frame-analytics
Source
# File lib/elasticsearch/api/actions/cat/ml_datafeeds.rb, line 54 def ml_datafeeds(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_datafeeds' } defined_params = [:datafeed_id].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _datafeed_id = arguments.delete(:datafeed_id) method = Elasticsearch::API::HTTP_GET path = if _datafeed_id "_cat/ml/datafeeds/#{Utils.listify(_datafeed_id)}" else '_cat/ml/datafeeds' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get datafeeds. Get configuration and usage information about datafeeds. This API
returns a maximum of 10,000 datafeeds. If the Elasticsearch
security features are enabled, you must have monitor_ml
, monitor
, manage_ml
, or manage
cluster privileges to use this API
. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API
.
@option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed. @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
- Contains wildcard expressions and there are no datafeeds that match. - Contains the +_all+ string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches. If +true+, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. 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 Comma-separated list of column names to display. Server default: [‘bc’, ‘id’, ‘sc’, ‘s’]. @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response. @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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-datafeeds
Source
# File lib/elasticsearch/api/actions/cat/ml_jobs.rb, line 55 def ml_jobs(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_jobs' } defined_params = [:job_id].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _job_id = arguments.delete(:job_id) method = Elasticsearch::API::HTTP_GET path = if _job_id "_cat/ml/anomaly_detectors/#{Utils.listify(_job_id)}" else '_cat/ml/anomaly_detectors' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get anomaly detection jobs. Get configuration and usage information for anomaly detection jobs. This API
returns a maximum of 10,000 jobs. If the Elasticsearch
security features are enabled, you must have monitor_ml
, monitor
, manage_ml
, or manage
cluster privileges to use this API
. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API
.
@option arguments [String] :job_id Identifier for the anomaly detection job. @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
- Contains wildcard expressions and there are no jobs that match. - Contains the +_all+ string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches. If +true+, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If +false+, the API returns a 404 status code when there are no matches or only partial matches. Server default: true.
@option arguments [String] :bytes The unit used to display byte values. @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state. @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response. @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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-jobs
Source
# File lib/elasticsearch/api/actions/cat/ml_trained_models.rb, line 50 def ml_trained_models(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_trained_models' } defined_params = [:model_id].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _model_id = arguments.delete(:model_id) method = Elasticsearch::API::HTTP_GET path = if _model_id "_cat/ml/trained_models/#{Utils.listify(_model_id)}" else '_cat/ml/trained_models' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get trained models. Get configuration and usage information about inference trained models. IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API
.
@option arguments [String] :model_id A unique identifier for the trained model. @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the _all
string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.
If +true+, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If +false+, the API returns a 404 status code when there are no matches or only partial matches. Server default: true.
@option arguments [String] :bytes The unit used to display byte values. @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 [String] :time 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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-trained-models
Source
# File lib/elasticsearch/api/actions/cat/nodeattrs.rb, line 47 def nodeattrs(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.nodeattrs' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/nodeattrs' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get node attribute information. Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API
.
@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.
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
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 [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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-nodeattrs
Source
# File lib/elasticsearch/api/actions/cat/nodes.rb, line 47 def nodes(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.nodes' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/nodes' params = Utils.process_params(arguments) params[:h] = Utils.listify(params[:h], escape: false) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get node information. Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API
.
@option arguments [String] :bytes The unit used to display byte values. @option arguments [Boolean, String] :full_id If true
, return the full node ID. If false
, return the shortened node ID. Server default: false. @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory. @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.
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 [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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-nodes
Source
# File lib/elasticsearch/api/actions/cat/pending_tasks.rb, line 48 def pending_tasks(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.pending_tasks' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/pending_tasks' params = Utils.process_params(arguments) params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get pending task information. Get information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API
.
@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.
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
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 [String] :time 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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-pending-tasks
Source
# File lib/elasticsearch/api/actions/cat/plugins.rb, line 48 def plugins(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.plugins' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/plugins' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get plugin information. Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API
.
@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.
Sorting defaults to ascending and can be changed by setting +:asc+ or +:desc+ as a suffix to the column name.
@option arguments [Boolean] :include_bootstrap Include bootstrap plugins in the response @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 [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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-plugins
Source
# File lib/elasticsearch/api/actions/cat/recovery.rb, line 50 def recovery(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.recovery' } defined_params = [:index].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index "_cat/recovery/#{Utils.listify(_index)}" else '_cat/recovery' end params = Utils.process_params(arguments) params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get shard recovery information. Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API
returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API
.
@option arguments [String, Array] :index A 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 [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.
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] :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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-recovery
Source
# File lib/elasticsearch/api/actions/cat/repositories.rb, line 47 def repositories(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.repositories' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/repositories' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get snapshot repository information. Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API
.
@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.
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
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 [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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-repositories
Source
# File lib/elasticsearch/api/actions/cat/segments.rb, line 52 def segments(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.segments' } defined_params = [:index].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index "_cat/segments/#{Utils.listify(_index)}" else '_cat/segments' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get segment information. Get low-level information about the Lucene segments in index shards. For data streams, the API
returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API
.
@option arguments [String, Array] :index A 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] :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.
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
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 [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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-segments
Source
# File lib/elasticsearch/api/actions/cat/shards.rb, line 49 def shards(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.shards' } defined_params = [:index].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index "_cat/shards/#{Utils.listify(_index)}" else '_cat/shards' end params = Utils.process_params(arguments) params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get shard information. Get information about the shards in a cluster. For data streams, the API
returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
@option arguments [String, Array] :index A 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] :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.
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 [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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-shards
Source
# File lib/elasticsearch/api/actions/cat/snapshots.rb, line 50 def snapshots(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.snapshots' } defined_params = [:repository].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _repository = arguments.delete(:repository) method = Elasticsearch::API::HTTP_GET path = if _repository "_cat/snapshots/#{Utils.listify(_repository)}" else '_cat/snapshots' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get snapshot information. Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch
cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API
.
@option arguments [String, Array<String>] :repository A comma-separated list of snapshot repositories used to limit the request.
Accepts wildcard expressions. +_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>] :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.
@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 [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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-snapshots
Source
# File lib/elasticsearch/api/actions/cat/tasks.rb, line 54 def tasks(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.tasks' } arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/tasks' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get task information. Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API
. This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.
@option arguments [Array<String>] :actions The task action names, which are used to limit the response. @option arguments [Boolean] :detailed If true
, the response includes detailed information about shard recoveries. @option arguments [Array<String>] :nodes Unique node identifiers, which are used to limit the response. @option arguments [String] :parent_task_id The parent task identifier, which is used to limit the response. @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.
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 [Time] :timeout Period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
@option arguments [Boolean] :wait_for_completion If true
, the request blocks until the task has completed. @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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-tasks
Source
# File lib/elasticsearch/api/actions/cat/templates.rb, line 50 def templates(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.templates' } defined_params = [:name].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_GET path = if _name "_cat/templates/#{Utils.listify(_name)}" else '_cat/templates' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get index template information. Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API
.
@option arguments [String] :name The name of the template to return.
Accepts wildcard expressions. If omitted, all templates are returned.
@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.
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
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 [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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-templates
Source
# File lib/elasticsearch/api/actions/cat/thread_pool.rb, line 51 def thread_pool(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.thread_pool' } defined_params = [:thread_pool_patterns].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _thread_pool_patterns = arguments.delete(:thread_pool_patterns) method = Elasticsearch::API::HTTP_GET path = if _thread_pool_patterns "_cat/thread_pool/#{Utils.listify(_thread_pool_patterns)}" else '_cat/thread_pool' end params = Utils.process_params(arguments) params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get thread pool statistics. Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API
.
@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.
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 [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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-thread-pool
Source
# File lib/elasticsearch/api/actions/cat/transforms.rb, line 50 def transforms(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.transforms' } defined_params = [:transform_id].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? arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _transform_id = arguments.delete(:transform_id) method = Elasticsearch::API::HTTP_GET path = if _transform_id "_cat/transforms/#{Utils.listify(_transform_id)}" else '_cat/transforms' end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) end
Get transform information. Get configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API
.
@option arguments [String] :transform_id A transform identifier or a wildcard expression.
If you do not specify one of these options, the API returns information for all transforms.
@option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the _all
string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.
If +true+, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If +false+, the request returns a 404 status code when there are no matches or only partial matches. Server default: true.
@option arguments [Integer] :from Skips the specified number of transforms. Server default: 0. @option arguments [String, Array<String>] :h Comma-separated list of column names to display. Server default: changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state. @option arguments [String, Array<String>] :s Comma-separated list of column names or column aliases used to sort the response. @option arguments [String] :time The unit used to display time values. @option arguments [Integer] :size The maximum number of transforms to obtain. 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
can't be combined with any other query string option.
@option arguments [Boolean] :v When set to true
will enable verbose output. @option arguments [Hash] :headers Custom HTTP headers
@see www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-transforms