Module: ElasticsearchServerless::API::Cat::Actions
- Defined in:
- lib/elasticsearch-serverless/api/cat/help.rb,
lib/elasticsearch-serverless/api/cat/count.rb,
lib/elasticsearch-serverless/api/cat/aliases.rb,
lib/elasticsearch-serverless/api/cat/indices.rb,
lib/elasticsearch-serverless/api/cat/ml_jobs.rb,
lib/elasticsearch-serverless/api/cat/transforms.rb,
lib/elasticsearch-serverless/api/cat/ml_datafeeds.rb,
lib/elasticsearch-serverless/api/cat/ml_trained_models.rb,
lib/elasticsearch-serverless/api/cat/component_templates.rb,
lib/elasticsearch-serverless/api/cat/ml_data_frame_analytics.rb
Instance Method Summary collapse
-
#aliases(arguments = {}) ⇒ Object
Retrieves the cluster’s index aliases, including filter and routing information.
-
#component_templates(arguments = {}) ⇒ Object
Returns information about component templates in a cluster.
-
#count(arguments = {}) ⇒ Object
Provides quick access to a document count for a data stream, an index, or an entire cluster.
-
#help(arguments = {}) ⇒ Object
Returns help for the Cat APIs.
-
#indices(arguments = {}) ⇒ Object
Returns high-level information about indices in a cluster, including backing indices for data streams.
-
#ml_data_frame_analytics(arguments = {}) ⇒ Object
Returns configuration and usage information about data frame analytics jobs.
-
#ml_datafeeds(arguments = {}) ⇒ Object
Returns configuration and usage information about datafeeds.
-
#ml_jobs(arguments = {}) ⇒ Object
Returns configuration and usage information for anomaly detection jobs.
-
#ml_trained_models(arguments = {}) ⇒ Object
Returns configuration and usage information about inference trained models.
-
#transforms(arguments = {}) ⇒ Object
Returns configuration and usage information about transforms.
Instance Method Details
#aliases(arguments = {}) ⇒ Object
Retrieves the cluster’s index aliases, including filter and routing information. The 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.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/elasticsearch-serverless/api/cat/aliases.rb', line 42 def aliases(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _name = arguments.delete(:name) method = ElasticsearchServerless::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] ElasticsearchServerless::API::Response.new( perform_request(method, path, params, body, headers) ) end |
#component_templates(arguments = {}) ⇒ Object
Returns 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.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/elasticsearch-serverless/api/cat/component_templates.rb', line 42 def component_templates(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _name = arguments.delete(:name) method = ElasticsearchServerless::API::HTTP_GET path = if _name "_cat/component_templates/#{Utils.listify(_name)}" else "_cat/component_templates" end params = Utils.process_params(arguments) ElasticsearchServerless::API::Response.new( perform_request(method, path, params, body, headers) ) end |
#count(arguments = {}) ⇒ Object
Provides quick access to a document count for a data stream, an index, or an entire cluster. NOTE: 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.
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/elasticsearch-serverless/api/cat/count.rb', line 42 def count(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _index = arguments.delete(:index) method = ElasticsearchServerless::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] ElasticsearchServerless::API::Response.new( perform_request(method, path, params, body, headers) ) end |
#help(arguments = {}) ⇒ Object
Returns help for the Cat APIs.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/elasticsearch-serverless/api/cat/help.rb', line 38 def help(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil method = ElasticsearchServerless::API::HTTP_GET path = "_cat" params = Utils.process_params(arguments) ElasticsearchServerless::API::Response.new( perform_request(method, path, params, body, headers) ) end |
#indices(arguments = {}) ⇒ Object
Returns high-level information about indices in a cluster, including backing indices for data streams. 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 API. Use the cat indices API 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.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/elasticsearch-serverless/api/cat/indices.rb', line 50 def indices(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _index = arguments.delete(:index) method = ElasticsearchServerless::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] ElasticsearchServerless::API::Response.new( perform_request(method, path, params, body, headers) ) end |
#ml_data_frame_analytics(arguments = {}) ⇒ Object
Returns 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.
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/elasticsearch-serverless/api/cat/ml_data_frame_analytics.rb', line 48 def ml_data_frame_analytics(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _id = arguments.delete(:id) method = ElasticsearchServerless::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) ElasticsearchServerless::API::Response.new( perform_request(method, path, params, body, headers) ) end |
#ml_datafeeds(arguments = {}) ⇒ Object
Returns 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.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/elasticsearch-serverless/api/cat/ml_datafeeds.rb', line 50 def ml_datafeeds(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _datafeed_id = arguments.delete(:datafeed_id) method = ElasticsearchServerless::API::HTTP_GET path = if _datafeed_id "_cat/ml/datafeeds/#{Utils.listify(_datafeed_id)}" else "_cat/ml/datafeeds" end params = Utils.process_params(arguments) ElasticsearchServerless::API::Response.new( perform_request(method, path, params, body, headers) ) end |
#ml_jobs(arguments = {}) ⇒ Object
Returns 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.
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/elasticsearch-serverless/api/cat/ml_jobs.rb', line 51 def ml_jobs(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _job_id = arguments.delete(:job_id) method = ElasticsearchServerless::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) ElasticsearchServerless::API::Response.new( perform_request(method, path, params, body, headers) ) end |
#ml_trained_models(arguments = {}) ⇒ Object
Returns 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.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/elasticsearch-serverless/api/cat/ml_trained_models.rb', line 49 def ml_trained_models(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _model_id = arguments.delete(:model_id) method = ElasticsearchServerless::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) ElasticsearchServerless::API::Response.new( perform_request(method, path, params, body, headers) ) end |
#transforms(arguments = {}) ⇒ Object
Returns configuration and usage information about transforms.
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 transform statistics API.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/elasticsearch-serverless/api/cat/transforms.rb', line 49 def transforms(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} body = nil _transform_id = arguments.delete(:transform_id) method = ElasticsearchServerless::API::HTTP_GET path = if _transform_id "_cat/transforms/#{Utils.listify(_transform_id)}" else "_cat/transforms" end params = Utils.process_params(arguments) ElasticsearchServerless::API::Response.new( perform_request(method, path, params, body, headers) ) end |