Module: ElasticsearchServerless::API

Includes:

Actions

Included in:

Client

Defined in:

lib/elasticsearch-serverless/api.rb,
lib/elasticsearch-serverless/api/get.rb,
lib/elasticsearch-serverless/api/bulk.rb,
lib/elasticsearch-serverless/api/info.rb,
lib/elasticsearch-serverless/api/mget.rb,
lib/elasticsearch-serverless/api/ping.rb,
lib/elasticsearch-serverless/api/count.rb,
lib/elasticsearch-serverless/api/index.rb,
lib/elasticsearch-serverless/api/utils.rb,
lib/elasticsearch-serverless/api/create.rb,
lib/elasticsearch-serverless/api/delete.rb,
lib/elasticsearch-serverless/api/exists.rb,
lib/elasticsearch-serverless/api/scroll.rb,
lib/elasticsearch-serverless/api/search.rb,
lib/elasticsearch-serverless/api/update.rb,
lib/elasticsearch-serverless/api/eql/get.rb,
lib/elasticsearch-serverless/api/explain.rb,
lib/elasticsearch-serverless/api/msearch.rb,
lib/elasticsearch-serverless/api/reindex.rb,
lib/elasticsearch-serverless/api/cat/help.rb,
lib/elasticsearch-serverless/api/response.rb,
lib/elasticsearch-serverless/api/cat/count.rb,
lib/elasticsearch-serverless/api/rank_eval.rb,
lib/elasticsearch-serverless/api/sql/query.rb,
lib/elasticsearch-serverless/api/tasks/get.rb,
lib/elasticsearch-serverless/api/eql/delete.rb,
lib/elasticsearch-serverless/api/eql/search.rb,
lib/elasticsearch-serverless/api/field_caps.rb,
lib/elasticsearch-serverless/api/get_script.rb,
lib/elasticsearch-serverless/api/get_source.rb,
lib/elasticsearch-serverless/api/put_script.rb,
lib/elasticsearch-serverless/api/search_mvt.rb,
lib/elasticsearch-serverless/api/terms_enum.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/indices/get.rb,
lib/elasticsearch-serverless/api/license/get.rb,
lib/elasticsearch-serverless/api/termvectors.rb,
lib/elasticsearch-serverless/api/clear_scroll.rb,
lib/elasticsearch-serverless/api/cluster/info.rb,
lib/elasticsearch-serverless/api/mtermvectors.rb,
lib/elasticsearch-serverless/api/connector/get.rb,
lib/elasticsearch-serverless/api/connector/put.rb,
lib/elasticsearch-serverless/api/delete_script.rb,
lib/elasticsearch-serverless/api/exists_source.rb,
lib/elasticsearch-serverless/api/graph/explore.rb,
lib/elasticsearch-serverless/api/inference/get.rb,
lib/elasticsearch-serverless/api/inference/put.rb,
lib/elasticsearch-serverless/api/sql/get_async.rb,
lib/elasticsearch-serverless/api/sql/translate.rb,
lib/elasticsearch-serverless/api/cat/transforms.rb,
lib/elasticsearch-serverless/api/connector/list.rb,
lib/elasticsearch-serverless/api/connector/post.rb,
lib/elasticsearch-serverless/api/eql/get_status.rb,
lib/elasticsearch-serverless/api/indices/create.rb,
lib/elasticsearch-serverless/api/indices/delete.rb,
lib/elasticsearch-serverless/api/indices/exists.rb,
lib/elasticsearch-serverless/api/delete_by_query.rb,
lib/elasticsearch-serverless/api/indices/analyze.rb,
lib/elasticsearch-serverless/api/indices/refresh.rb,
lib/elasticsearch-serverless/api/ingest/simulate.rb,
lib/elasticsearch-serverless/api/search_template.rb,
lib/elasticsearch-serverless/api/update_by_query.rb,
lib/elasticsearch-serverless/api/async_search/get.rb,
lib/elasticsearch-serverless/api/cat/ml_datafeeds.rb,
lib/elasticsearch-serverless/api/connector/delete.rb,
lib/elasticsearch-serverless/api/indices/rollover.rb,
lib/elasticsearch-serverless/api/inference/delete.rb,
lib/elasticsearch-serverless/api/msearch_template.rb,
lib/elasticsearch-serverless/api/query_rules/test.rb,
lib/elasticsearch-serverless/api/sql/clear_cursor.rb,
lib/elasticsearch-serverless/api/sql/delete_async.rb,
lib/elasticsearch-serverless/api/enrich/get_policy.rb,
lib/elasticsearch-serverless/api/enrich/put_policy.rb,
lib/elasticsearch-serverless/api/indices/add_block.rb,
lib/elasticsearch-serverless/api/indices/get_alias.rb,
lib/elasticsearch-serverless/api/indices/put_alias.rb,
lib/elasticsearch-serverless/api/security/get_role.rb,
lib/elasticsearch-serverless/api/security/put_role.rb,
lib/elasticsearch-serverless/api/connector/check_in.rb,
lib/elasticsearch-serverless/api/open_point_in_time.rb,
lib/elasticsearch-serverless/api/async_search/delete.rb,
lib/elasticsearch-serverless/api/async_search/status.rb,
lib/elasticsearch-serverless/api/async_search/submit.rb,
lib/elasticsearch-serverless/api/close_point_in_time.rb,
lib/elasticsearch-serverless/api/indices/get_mapping.rb,
lib/elasticsearch-serverless/api/indices/put_mapping.rb,
lib/elasticsearch-serverless/api/inference/inference.rb,
lib/elasticsearch-serverless/api/ingest/get_pipeline.rb,
lib/elasticsearch-serverless/api/ingest/put_pipeline.rb,
lib/elasticsearch-serverless/api/enrich/delete_policy.rb,
lib/elasticsearch-serverless/api/indices/delete_alias.rb,
lib/elasticsearch-serverless/api/indices/exists_alias.rb,
lib/elasticsearch-serverless/api/indices/get_settings.rb,
lib/elasticsearch-serverless/api/indices/put_settings.rb,
lib/elasticsearch-serverless/api/query_rules/get_rule.rb,
lib/elasticsearch-serverless/api/query_rules/put_rule.rb,
lib/elasticsearch-serverless/api/security/delete_role.rb,
lib/elasticsearch-serverless/api/security/get_api_key.rb,
lib/elasticsearch-serverless/api/sql/get_async_status.rb,
lib/elasticsearch-serverless/api/synonyms/get_synonym.rb,
lib/elasticsearch-serverless/api/synonyms/put_synonym.rb,
lib/elasticsearch-serverless/api/cat/ml_trained_models.rb,
lib/elasticsearch-serverless/api/connector/update_name.rb,
lib/elasticsearch-serverless/api/enrich/execute_policy.rb,
lib/elasticsearch-serverless/api/indices/resolve_index.rb,
lib/elasticsearch-serverless/api/ingest/processor_grok.rb,
lib/elasticsearch-serverless/api/logstash/get_pipeline.rb,
lib/elasticsearch-serverless/api/logstash/put_pipeline.rb,
lib/elasticsearch-serverless/api/security/authenticate.rb,
lib/elasticsearch-serverless/api/connector/sync_job_get.rb,
lib/elasticsearch-serverless/api/connector/update_error.rb,
lib/elasticsearch-serverless/api/indices/update_aliases.rb,
lib/elasticsearch-serverless/api/indices/validate_query.rb,
lib/elasticsearch-serverless/api/ingest/delete_pipeline.rb,
lib/elasticsearch-serverless/api/render_search_template.rb,
lib/elasticsearch-serverless/api/search_application/get.rb,
lib/elasticsearch-serverless/api/search_application/put.rb,
lib/elasticsearch-serverless/api/cat/component_templates.rb,
lib/elasticsearch-serverless/api/connector/sync_job_list.rb,
lib/elasticsearch-serverless/api/connector/sync_job_post.rb,
lib/elasticsearch-serverless/api/connector/update_native.rb,
lib/elasticsearch-serverless/api/connector/update_status.rb,
lib/elasticsearch-serverless/api/indices/get_data_stream.rb,
lib/elasticsearch-serverless/api/query_rules/delete_rule.rb,
lib/elasticsearch-serverless/api/query_rules/get_ruleset.rb,
lib/elasticsearch-serverless/api/query_rules/put_ruleset.rb,
lib/elasticsearch-serverless/api/search_application/list.rb,
lib/elasticsearch-serverless/api/security/create_api_key.rb,
lib/elasticsearch-serverless/api/security/has_privileges.rb,
lib/elasticsearch-serverless/api/security/query_api_keys.rb,
lib/elasticsearch-serverless/api/synonyms/delete_synonym.rb,
lib/elasticsearch-serverless/api/transform/get_transform.rb,
lib/elasticsearch-serverless/api/transform/put_transform.rb,
lib/elasticsearch-serverless/api/logstash/delete_pipeline.rb,
lib/elasticsearch-serverless/api/machine_learning/put_job.rb,
lib/elasticsearch-serverless/api/scripts_painless_execute.rb,
lib/elasticsearch-serverless/api/transform/stop_transform.rb,
lib/elasticsearch-serverless/api/connector/sync_job_cancel.rb,
lib/elasticsearch-serverless/api/connector/sync_job_delete.rb,
lib/elasticsearch-serverless/api/connector/update_pipeline.rb,
lib/elasticsearch-serverless/api/indices/simulate_template.rb,
lib/elasticsearch-serverless/api/machine_learning/get_jobs.rb,
lib/elasticsearch-serverless/api/machine_learning/open_job.rb,
lib/elasticsearch-serverless/api/query_rules/list_rulesets.rb,
lib/elasticsearch-serverless/api/search_application/delete.rb,
lib/elasticsearch-serverless/api/search_application/search.rb,
lib/elasticsearch-serverless/api/synonyms/get_synonym_rule.rb,
lib/elasticsearch-serverless/api/synonyms/put_synonym_rule.rb,
lib/elasticsearch-serverless/api/transform/reset_transform.rb,
lib/elasticsearch-serverless/api/transform/start_transform.rb,
lib/elasticsearch-serverless/api/connector/update_filtering.rb,
lib/elasticsearch-serverless/api/indices/create_data_stream.rb,
lib/elasticsearch-serverless/api/indices/delete_data_stream.rb,
lib/elasticsearch-serverless/api/indices/get_data_lifecycle.rb,
lib/elasticsearch-serverless/api/indices/get_index_template.rb,
lib/elasticsearch-serverless/api/indices/modify_data_stream.rb,
lib/elasticsearch-serverless/api/indices/put_data_lifecycle.rb,
lib/elasticsearch-serverless/api/indices/put_index_template.rb,
lib/elasticsearch-serverless/api/machine_learning/close_job.rb,
lib/elasticsearch-serverless/api/machine_learning/flush_job.rb,
lib/elasticsearch-serverless/api/machine_learning/reset_job.rb,
lib/elasticsearch-serverless/api/query_rules/delete_ruleset.rb,
lib/elasticsearch-serverless/api/synonyms/get_synonyms_sets.rb,
lib/elasticsearch-serverless/api/transform/delete_transform.rb,
lib/elasticsearch-serverless/api/transform/update_transform.rb,
lib/elasticsearch-serverless/api/cat/ml_data_frame_analytics.rb,
lib/elasticsearch-serverless/api/connector/update_api_key_id.rb,
lib/elasticsearch-serverless/api/connector/update_index_name.rb,
lib/elasticsearch-serverless/api/connector/update_scheduling.rb,
lib/elasticsearch-serverless/api/machine_learning/delete_job.rb,
lib/elasticsearch-serverless/api/machine_learning/put_filter.rb,
lib/elasticsearch-serverless/api/machine_learning/update_job.rb,
lib/elasticsearch-serverless/api/security/invalidate_api_key.rb,
lib/elasticsearch-serverless/api/transform/preview_transform.rb,
lib/elasticsearch-serverless/api/machine_learning/get_filters.rb,
lib/elasticsearch-serverless/api/synonyms/delete_synonym_rule.rb,
lib/elasticsearch-serverless/api/connector/update_service_type.rb,
lib/elasticsearch-serverless/api/indices/delete_index_template.rb,
lib/elasticsearch-serverless/api/indices/exists_index_template.rb,
lib/elasticsearch-serverless/api/machine_learning/put_calendar.rb,
lib/elasticsearch-serverless/api/machine_learning/put_datafeed.rb,
lib/elasticsearch-serverless/api/transform/get_transform_stats.rb,
lib/elasticsearch-serverless/api/cluster/get_component_template.rb,
lib/elasticsearch-serverless/api/cluster/put_component_template.rb,
lib/elasticsearch-serverless/api/connector/update_configuration.rb,
lib/elasticsearch-serverless/api/indices/explain_data_lifecycle.rb,
lib/elasticsearch-serverless/api/indices/migrate_to_data_stream.rb,
lib/elasticsearch-serverless/api/machine_learning/delete_filter.rb,
lib/elasticsearch-serverless/api/machine_learning/get_calendars.rb,
lib/elasticsearch-serverless/api/machine_learning/get_datafeeds.rb,
lib/elasticsearch-serverless/api/machine_learning/get_job_stats.rb,
lib/elasticsearch-serverless/api/machine_learning/stop_datafeed.rb,
lib/elasticsearch-serverless/api/machine_learning/update_filter.rb,
lib/elasticsearch-serverless/api/indices/simulate_index_template.rb,
lib/elasticsearch-serverless/api/machine_learning/start_datafeed.rb,
lib/elasticsearch-serverless/api/security/get_builtin_privileges.rb,
lib/elasticsearch-serverless/api/machine_learning/delete_calendar.rb,
lib/elasticsearch-serverless/api/machine_learning/delete_datafeed.rb,
lib/elasticsearch-serverless/api/machine_learning/update_datafeed.rb,
lib/elasticsearch-serverless/api/transform/schedule_now_transform.rb,
lib/elasticsearch-serverless/api/cluster/delete_component_template.rb,
lib/elasticsearch-serverless/api/cluster/exists_component_template.rb,
lib/elasticsearch-serverless/api/connector/update_active_filtering.rb,
lib/elasticsearch-serverless/api/machine_learning/preview_datafeed.rb,
lib/elasticsearch-serverless/api/machine_learning/put_calendar_job.rb,
lib/elasticsearch-serverless/api/machine_learning/put_trained_model.rb,
lib/elasticsearch-serverless/api/machine_learning/get_datafeed_stats.rb,
lib/elasticsearch-serverless/api/machine_learning/get_trained_models.rb,
lib/elasticsearch-serverless/api/machine_learning/delete_calendar_job.rb,
lib/elasticsearch-serverless/api/machine_learning/evaluate_data_frame.rb,
lib/elasticsearch-serverless/api/machine_learning/get_calendar_events.rb,
lib/elasticsearch-serverless/api/machine_learning/get_overall_buckets.rb,
lib/elasticsearch-serverless/api/machine_learning/infer_trained_model.rb,
lib/elasticsearch-serverless/api/connector/update_filtering_validation.rb,
lib/elasticsearch-serverless/api/machine_learning/delete_trained_model.rb,
lib/elasticsearch-serverless/api/machine_learning/post_calendar_events.rb,
lib/elasticsearch-serverless/api/machine_learning/delete_calendar_event.rb,
lib/elasticsearch-serverless/api/machine_learning/estimate_model_memory.rb,
lib/elasticsearch-serverless/api/machine_learning/put_trained_model_alias.rb,
lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics.rb,
lib/elasticsearch-serverless/api/machine_learning/get_trained_models_stats.rb,
lib/elasticsearch-serverless/api/machine_learning/put_data_frame_analytics.rb,
lib/elasticsearch-serverless/api/machine_learning/stop_data_frame_analytics.rb,
lib/elasticsearch-serverless/api/machine_learning/delete_trained_model_alias.rb,
lib/elasticsearch-serverless/api/machine_learning/start_data_frame_analytics.rb,
lib/elasticsearch-serverless/api/search_application/get_behavioral_analytics.rb,
lib/elasticsearch-serverless/api/search_application/put_behavioral_analytics.rb,
lib/elasticsearch-serverless/api/machine_learning/delete_data_frame_analytics.rb,
lib/elasticsearch-serverless/api/machine_learning/update_data_frame_analytics.rb,
lib/elasticsearch-serverless/api/machine_learning/preview_data_frame_analytics.rb,
lib/elasticsearch-serverless/api/machine_learning/put_trained_model_vocabulary.rb,
lib/elasticsearch-serverless/api/machine_learning/stop_trained_model_deployment.rb,
lib/elasticsearch-serverless/api/search_application/delete_behavioral_analytics.rb,
lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics_stats.rb,
lib/elasticsearch-serverless/api/machine_learning/start_trained_model_deployment.rb,
lib/elasticsearch-serverless/api/machine_learning/update_trained_model_deployment.rb,
lib/elasticsearch-serverless/api/machine_learning/put_trained_model_definition_part.rb

Defined Under Namespace

Modules: Actions, AsyncSearch, Cat, Cluster, CommonClient, Connector, Enrich, Eql, Graph, Indices, Inference, Ingest, License, Logstash, MachineLearning, QueryRules, SQL, SearchApplication, Security, Synonyms, Tasks, Transform, Utils Classes: Response

Constant Summary

HTTP_GET =

'GET'.freeze

HTTP_HEAD =

'HEAD'.freeze

HTTP_POST =

'POST'.freeze

HTTP_PUT =

'PUT'.freeze

HTTP_DELETE =

'DELETE'.freeze

API_NAMESPACES =

Add new namespaces to this constant

[
  :async_search,
  :cat,
  :cluster,
  :connector,
  :enrich,
  :eql,
  :graph,
  :indices,
  :inference,
  :ingest,
  :license,
  :logstash,
  :machine_learning,
  :query_rules,
  :search_application,
  :security,
  :sql,
  :synonyms,
  :tasks,
  :transform
].freeze

UPPERCASE_APIS =

['sql'].freeze

Class Method Summary

• .serializer ⇒ Object

  The serializer class.

Methods included from Actions

#bulk, #clear_scroll, #close_point_in_time, #count, #create, #delete, #delete_by_query, #delete_script, #exists, #exists_source, #explain, #field_caps, #get, #get_script, #get_source, #index, #info, #mget, #msearch, #msearch_template, #mtermvectors, #open_point_in_time, #ping, #put_script, #rank_eval, #reindex, #render_search_template, #scripts_painless_execute, #scroll, #search, #search_mvt, #search_template, #terms_enum, #termvector, #termvectors, #update, #update_by_query

Class Method Details

.serializer ⇒ Object

The serializer class

# File 'lib/elasticsearch-serverless/api.rb', line 35

def self.serializer
  JSON
end