typedapi

package
v8.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 14, 2024 License: Apache-2.0 Imports: 501 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type API

type API struct {
	AsyncSearch         AsyncSearch
	Autoscaling         Autoscaling
	Capabilities        Capabilities
	Cat                 Cat
	Ccr                 Ccr
	Cluster             Cluster
	Connector           Connector
	Core                Core
	DanglingIndices     DanglingIndices
	Enrich              Enrich
	Eql                 Eql
	Esql                Esql
	Features            Features
	Fleet               Fleet
	Graph               Graph
	Ilm                 Ilm
	Indices             Indices
	Inference           Inference
	Ingest              Ingest
	License             License
	Logstash            Logstash
	Migration           Migration
	Ml                  Ml
	Monitoring          Monitoring
	Nodes               Nodes
	Profiling           Profiling
	QueryRules          QueryRules
	Rollup              Rollup
	SearchApplication   SearchApplication
	SearchableSnapshots SearchableSnapshots
	Security            Security
	Shutdown            Shutdown
	Slm                 Slm
	Snapshot            Snapshot
	Sql                 Sql
	Ssl                 Ssl
	Synonyms            Synonyms
	Tasks               Tasks
	TextStructure       TextStructure
	Transform           Transform
	Watcher             Watcher
	Xpack               Xpack

	// Bulk index or delete documents.
	// Performs multiple indexing or delete operations in a single API call.
	// This reduces overhead and can greatly increase indexing speed.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
	Bulk core_bulk.NewBulk
	// Clear a scrolling search.
	//
	// Clear the search context and results for a scrolling search.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html
	ClearScroll core_clear_scroll.NewClearScroll
	// Close a point in time.
	//
	// A point in time must be opened explicitly before being used in search
	// requests.
	// The `keep_alive` parameter tells Elasticsearch how long it should persist.
	// A point in time is automatically closed when the `keep_alive` period has
	// elapsed.
	// However, keeping points in time has a cost; close them as soon as they are no
	// longer required for search requests.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html
	ClosePointInTime core_close_point_in_time.NewClosePointInTime
	// Returns number of documents matching a query.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
	Count core_count.NewCount
	// Index a document.
	// Adds a JSON document to the specified data stream or index and makes it
	// searchable.
	// If the target is an index and the document already exists, the request
	// updates the document and increments its version.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
	Create core_create.NewCreate
	// Delete a document.
	// Removes a JSON document from the specified index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html
	Delete core_delete.NewDelete
	// Delete documents.
	// Deletes documents that match the specified query.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
	DeleteByQuery core_delete_by_query.NewDeleteByQuery
	// Throttle a delete by query operation.
	//
	// Change the number of requests per second for a particular delete by query
	// operation.
	// Rethrottling that speeds up the query takes effect immediately but
	// rethrotting that slows down the query takes effect after completing the
	// current batch to prevent scroll timeouts.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
	DeleteByQueryRethrottle core_delete_by_query_rethrottle.NewDeleteByQueryRethrottle
	// Delete a script or search template.
	// Deletes a stored script or search template.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
	DeleteScript core_delete_script.NewDeleteScript
	// Check a document.
	// Checks if a specified document exists.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
	Exists core_exists.NewExists
	// Check for a document source.
	// Checks if a document's `_source` is stored.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
	ExistsSource core_exists_source.NewExistsSource
	// Explain a document match result.
	// Returns information about why a specific document matches, or doesn’t match,
	// a query.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html
	Explain core_explain.NewExplain
	// Get the field capabilities.
	//
	// Get information about the capabilities of fields among multiple indices.
	//
	// For data streams, the API returns field capabilities among the stream’s
	// backing indices.
	// It returns runtime fields like any other field.
	// For example, a runtime field with a type of keyword is returned the same as
	// any other field that belongs to the `keyword` family.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html
	FieldCaps core_field_caps.NewFieldCaps
	// Get a document by its ID.
	// Retrieves the document with the specified ID from an index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
	Get core_get.NewGet
	// Get a script or search template.
	// Retrieves a stored script or search template.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
	GetScript core_get_script.NewGetScript
	// Get script contexts.
	//
	// Get a list of supported script contexts and their methods.
	// https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-contexts.html
	GetScriptContext core_get_script_context.NewGetScriptContext
	// Get script languages.
	//
	// Get a list of available script types, languages, and contexts.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
	GetScriptLanguages core_get_script_languages.NewGetScriptLanguages
	// Get a document's source.
	// Returns the source of a document.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
	GetSource core_get_source.NewGetSource
	// Returns the health of the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html
	HealthReport core_health_report.NewHealthReport
	// Index a document.
	// Adds a JSON document to the specified data stream or index and makes it
	// searchable.
	// If the target is an index and the document already exists, the request
	// updates the document and increments its version.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
	Index core_index.NewIndex
	// Get cluster info.
	// Returns basic information about the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
	Info core_info.NewInfo
	// Run a knn search.
	//
	// NOTE: The kNN search API has been replaced by the `knn` option in the search
	// API.
	//
	// Perform a k-nearest neighbor (kNN) search on a dense_vector field and return
	// the matching documents.
	// Given a query vector, the API finds the k closest vectors and returns those
	// documents as search hits.
	//
	// Elasticsearch uses the HNSW algorithm to support efficient kNN search.
	// Like most kNN algorithms, HNSW is an approximate method that sacrifices
	// result accuracy for improved search speed.
	// This means the results returned are not always the true k closest neighbors.
	//
	// The kNN search API supports restricting the search using a filter.
	// The search will return the top k documents that also match the filter query.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html
	KnnSearch core_knn_search.NewKnnSearch
	// Get multiple documents.
	//
	// Get multiple JSON documents by ID from one or more indices.
	// If you specify an index in the request URI, you only need to specify the
	// document IDs in the request body.
	// To ensure fast responses, this multi get (mget) API responds with partial
	// results if one or more shards fail.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html
	Mget core_mget.NewMget
	// Run multiple searches.
	//
	// The format of the request is similar to the bulk API format and makes use of
	// the newline delimited JSON (NDJSON) format.
	// The structure is as follows:
	//
	// “`
	// header\n
	// body\n
	// header\n
	// body\n
	// “`
	//
	// This structure is specifically optimized to reduce parsing if a specific
	// search ends up redirected to another node.
	//
	// IMPORTANT: The final line of data must end with a newline character `\n`.
	// Each newline character may be preceded by a carriage return `\r`.
	// When sending requests to this endpoint the `Content-Type` header should be
	// set to `application/x-ndjson`.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html
	Msearch core_msearch.NewMsearch
	// Run multiple templated searches.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html
	MsearchTemplate core_msearch_template.NewMsearchTemplate
	// Get multiple term vectors.
	//
	// You can specify existing documents by index and ID or provide artificial
	// documents in the body of the request.
	// You can specify the index in the request body or request URI.
	// The response contains a `docs` array with all the fetched termvectors.
	// Each element has the structure provided by the termvectors API.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html
	Mtermvectors core_mtermvectors.NewMtermvectors
	// Open a point in time.
	//
	// A search request by default runs against the most recent visible data of the
	// target indices,
	// which is called point in time. Elasticsearch pit (point in time) is a
	// lightweight view into the
	// state of the data as it existed when initiated. In some cases, it’s preferred
	// to perform multiple
	// search requests using the same point in time. For example, if refreshes
	// happen between
	// `search_after` requests, then the results of those requests might not be
	// consistent as changes happening
	// between searches are only visible to the more recent point in time.
	//
	// A point in time must be opened explicitly before being used in search
	// requests.
	// The `keep_alive` parameter tells Elasticsearch how long it should persist.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html
	OpenPointInTime core_open_point_in_time.NewOpenPointInTime
	// Ping the cluster.
	// Returns whether the cluster is running.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
	Ping core_ping.NewPing
	// Create or update a script or search template.
	// Creates or updates a stored script or search template.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
	PutScript core_put_script.NewPutScript
	// Evaluate ranked search results.
	//
	// Evaluate the quality of ranked search results over a set of typical search
	// queries.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html
	RankEval core_rank_eval.NewRankEval
	// Reindex documents.
	// Copies documents from a source to a destination. The source can be any
	// existing index, alias, or data stream. The destination must differ from the
	// source. For example, you cannot reindex a data stream into itself.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
	Reindex core_reindex.NewReindex
	// Throttle a reindex operation.
	//
	// Change the number of requests per second for a particular reindex operation.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
	ReindexRethrottle core_reindex_rethrottle.NewReindexRethrottle
	// Render a search template.
	//
	// Render a search template as a search request body.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html
	RenderSearchTemplate core_render_search_template.NewRenderSearchTemplate
	// Run a script.
	// Runs a script and returns a result.
	// https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html
	ScriptsPainlessExecute core_scripts_painless_execute.NewScriptsPainlessExecute
	// Run a scrolling search.
	//
	// IMPORTANT: The scroll API is no longer recommend for deep pagination. If you
	// need to preserve the index state while paging through more than 10,000 hits,
	// use the `search_after` parameter with a point in time (PIT).
	//
	// The scroll API gets large sets of results from a single scrolling search
	// request.
	// To get the necessary scroll ID, submit a search API request that includes an
	// argument for the `scroll` query parameter.
	// The `scroll` parameter indicates how long Elasticsearch should retain the
	// search context for the request.
	// The search response returns a scroll ID in the `_scroll_id` response body
	// parameter.
	// You can then use the scroll ID with the scroll API to retrieve the next batch
	// of results for the request.
	// If the Elasticsearch security features are enabled, the access to the results
	// of a specific scroll ID is restricted to the user or API key that submitted
	// the search.
	//
	// You can also use the scroll API to specify a new scroll parameter that
	// extends or shortens the retention period for the search context.
	//
	// IMPORTANT: Results from a scrolling search reflect the state of the index at
	// the time of the initial search request. Subsequent indexing or document
	// changes only affect later search and scroll requests.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-scroll
	Scroll core_scroll.NewScroll
	// Run a search.
	//
	// Get search hits that match the query defined in the request.
	// You can provide search queries using the `q` query string parameter or the
	// request body.
	// If both are specified, only the query parameter is used.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html
	Search core_search.NewSearch
	// Search a vector tile.
	//
	// Search a vector tile for geospatial values.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-vector-tile-api.html
	SearchMvt core_search_mvt.NewSearchMvt
	// Get the search shards.
	//
	// Get the indices and shards that a search request would be run against.
	// This information can be useful for working out issues or planning
	// optimizations with routing and shard preferences.
	// When filtered aliases are used, the filter is returned as part of the indices
	// section.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html
	SearchShards core_search_shards.NewSearchShards
	// Run a search with a search template.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html
	SearchTemplate core_search_template.NewSearchTemplate
	// Get terms in an index.
	//
	// Discover terms that match a partial string in an index.
	// This "terms enum" API is designed for low-latency look-ups used in
	// auto-complete scenarios.
	//
	// If the `complete` property in the response is false, the returned terms set
	// may be incomplete and should be treated as approximate.
	// This can occur due to a few reasons, such as a request timeout or a node
	// error.
	//
	// NOTE: The terms enum API may return terms from deleted documents. Deleted
	// documents are initially only marked as deleted. It is not until their
	// segments are merged that documents are actually deleted. Until that happens,
	// the terms enum API will return terms from these documents.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html
	TermsEnum core_terms_enum.NewTermsEnum
	// Get term vector information.
	//
	// Get information and statistics about terms in the fields of a particular
	// document.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-termvectors.html
	Termvectors core_termvectors.NewTermvectors
	// Update a document.
	// Updates a document by running a script or passing a partial document.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html
	Update core_update.NewUpdate
	// Update documents.
	// Updates documents that match the specified query.
	// If no query is specified, performs an update on every document in the data
	// stream or index without modifying the source, which is useful for picking up
	// mapping changes.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html
	UpdateByQuery core_update_by_query.NewUpdateByQuery
	// Throttle an update by query operation.
	//
	// Change the number of requests per second for a particular update by query
	// operation.
	// Rethrottling that speeds up the query takes effect immediately but
	// rethrotting that slows down the query takes effect after completing the
	// current batch to prevent scroll timeouts.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html
	UpdateByQueryRethrottle core_update_by_query_rethrottle.NewUpdateByQueryRethrottle
}

func New

type AsyncSearch added in v8.7.1

type AsyncSearch struct {
	// Delete an async search.
	//
	// If the asynchronous search is still running, it is cancelled.
	// Otherwise, the saved search results are deleted.
	// If the Elasticsearch security features are enabled, the deletion of a
	// specific async search is restricted to: the authenticated user that submitted
	// the original search request; users that have the `cancel_task` cluster
	// privilege.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
	Delete async_search_delete.NewDelete
	// Get async search results.
	//
	// Retrieve the results of a previously submitted asynchronous search request.
	// If the Elasticsearch security features are enabled, access to the results of
	// a specific async search is restricted to the user or API key that submitted
	// it.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
	Get async_search_get.NewGet
	// Get the async search status.
	//
	// Get the status of a previously submitted async search request given its
	// identifier, without retrieving search results.
	// If the Elasticsearch security features are enabled, use of this API is
	// restricted to the `monitoring_user` role.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
	Status async_search_status.NewStatus
	// Run an async search.
	//
	// When the primary sort of the results is an indexed field, shards get sorted
	// based on minimum and maximum value that they hold for that field. Partial
	// results become available following the sort criteria that was requested.
	//
	// Warning: Asynchronous search does not support scroll or search requests that
	// include only the suggest section.
	//
	// By default, Elasticsearch does not allow you to store an async search
	// response larger than 10Mb and an attempt to do this results in an error.
	// The maximum allowed size for a stored async search response can be set by
	// changing the `search.max_async_search_response_size` cluster level setting.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
	Submit async_search_submit.NewSubmit
}

type Autoscaling

type Autoscaling struct {
	// Delete an autoscaling policy.
	//
	// NOTE: This feature is designed for indirect use by Elasticsearch Service,
	// Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not
	// supported.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html
	DeleteAutoscalingPolicy autoscaling_delete_autoscaling_policy.NewDeleteAutoscalingPolicy
	// Get the autoscaling capacity.
	//
	// NOTE: This feature is designed for indirect use by Elasticsearch Service,
	// Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not
	// supported.
	//
	// This API gets the current autoscaling capacity based on the configured
	// autoscaling policy.
	// It will return information to size the cluster appropriately to the current
	// workload.
	//
	// The `required_capacity` is calculated as the maximum of the
	// `required_capacity` result of all individual deciders that are enabled for
	// the policy.
	//
	// The operator should verify that the `current_nodes` match the operator’s
	// knowledge of the cluster to avoid making autoscaling decisions based on stale
	// or incomplete information.
	//
	// The response contains decider-specific information you can use to diagnose
	// how and why autoscaling determined a certain capacity was required.
	// This information is provided for diagnosis only.
	// Do not use this information to make autoscaling decisions.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html
	GetAutoscalingCapacity autoscaling_get_autoscaling_capacity.NewGetAutoscalingCapacity
	// Get an autoscaling policy.
	//
	// NOTE: This feature is designed for indirect use by Elasticsearch Service,
	// Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not
	// supported.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html
	GetAutoscalingPolicy autoscaling_get_autoscaling_policy.NewGetAutoscalingPolicy
	// Create or update an autoscaling policy.
	//
	// NOTE: This feature is designed for indirect use by Elasticsearch Service,
	// Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not
	// supported.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html
	PutAutoscalingPolicy autoscaling_put_autoscaling_policy.NewPutAutoscalingPolicy
}

type Capabilities added in v8.15.0

type Capabilities struct {
	// Checks if the specified combination of method, API, parameters, and arbitrary
	// capabilities are supported
	// https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/README.asciidoc#require-or-skip-api-capabilities
	Capabilities capabilities.NewCapabilities
}

type Cat

type Cat struct {
	// Get aliases.
	// Retrieves the cluster’s index aliases, including filter and routing
	// information.
	// The API does not return data stream aliases.
	//
	// 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html
	Aliases cat_aliases.NewAliases
	// Provides 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-allocation.html
	Allocation cat_allocation.NewAllocation
	// Get component templates.
	// Returns information about component templates in a cluster.
	// Component templates are building blocks for constructing index templates that
	// specify index mappings, settings, and aliases.
	//
	// 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-component-templates.html
	ComponentTemplates cat_component_templates.NewComponentTemplates
	// Get a document count.
	// Provides 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.
	//
	// 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html
	Count cat_count.NewCount
	// Returns 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html
	Fielddata cat_fielddata.NewFielddata
	// Returns the health status of a cluster, similar to the cluster health API.
	// 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html
	Health cat_health.NewHealth
	// Get CAT help.
	// Returns help for the CAT APIs.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html
	Help cat_help.NewHelp
	// Get index information.
	// Returns 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html
	Indices cat_indices.NewIndices
	// Returns 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-master.html
	Master cat_master.NewMaster
	// Get data frame analytics jobs.
	// Returns configuration and usage information about data frame analytics jobs.
	//
	// 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html
	MlDataFrameAnalytics cat_ml_data_frame_analytics.NewMlDataFrameAnalytics
	// Get datafeeds.
	// 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.
	//
	// 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html
	MlDatafeeds cat_ml_datafeeds.NewMlDatafeeds
	// Get anomaly detection jobs.
	// 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.
	//
	// 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html
	MlJobs cat_ml_jobs.NewMlJobs
	// Get trained models.
	// Returns configuration and usage information about inference trained models.
	//
	// 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html
	MlTrainedModels cat_ml_trained_models.NewMlTrainedModels
	// Returns 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodeattrs.html
	Nodeattrs cat_nodeattrs.NewNodeattrs
	// Returns 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html
	Nodes cat_nodes.NewNodes
	// Returns cluster-level changes that have not yet been executed.
	// 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-pending-tasks.html
	PendingTasks cat_pending_tasks.NewPendingTasks
	// Returns 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html
	Plugins cat_plugins.NewPlugins
	// Returns 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html
	Recovery cat_recovery.NewRecovery
	// Returns the 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html
	Repositories cat_repositories.NewRepositories
	// Returns 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html
	Segments cat_segments.NewSegments
	// Returns 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html
	Shards cat_shards.NewShards
	// Returns 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html
	Snapshots cat_snapshots.NewSnapshots
	// Returns information about tasks currently executing 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
	Tasks cat_tasks.NewTasks
	// Returns information about 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-templates.html
	Templates cat_templates.NewTemplates
	// Returns 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html
	ThreadPool cat_thread_pool.NewThreadPool
	// Get transforms.
	// Returns 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.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html
	Transforms cat_transforms.NewTransforms
}

type Ccr

type Ccr struct {
	// Deletes auto-follow patterns.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html
	DeleteAutoFollowPattern ccr_delete_auto_follow_pattern.NewDeleteAutoFollowPattern
	// Creates a new follower index configured to follow the referenced leader
	// index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html
	Follow ccr_follow.NewFollow
	// Retrieves information about all follower indices, including parameters and
	// status for each follower index
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html
	FollowInfo ccr_follow_info.NewFollowInfo
	// Retrieves follower stats. return shard-level stats about the following tasks
	// associated with each shard for the specified indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html
	FollowStats ccr_follow_stats.NewFollowStats
	// Removes the follower retention leases from the leader.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html
	ForgetFollower ccr_forget_follower.NewForgetFollower
	// Gets configured auto-follow patterns. Returns the specified auto-follow
	// pattern collection.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html
	GetAutoFollowPattern ccr_get_auto_follow_pattern.NewGetAutoFollowPattern
	// Pauses an auto-follow pattern
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html
	PauseAutoFollowPattern ccr_pause_auto_follow_pattern.NewPauseAutoFollowPattern
	// Pauses a follower index. The follower index will not fetch any additional
	// operations from the leader index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html
	PauseFollow ccr_pause_follow.NewPauseFollow
	// Creates a new named collection of auto-follow patterns against a specified
	// remote cluster. Newly created indices on the remote cluster matching any of
	// the specified patterns will be automatically configured as follower indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html
	PutAutoFollowPattern ccr_put_auto_follow_pattern.NewPutAutoFollowPattern
	// Resumes an auto-follow pattern that has been paused
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html
	ResumeAutoFollowPattern ccr_resume_auto_follow_pattern.NewResumeAutoFollowPattern
	// Resumes a follower index that has been paused
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html
	ResumeFollow ccr_resume_follow.NewResumeFollow
	// Gets all stats related to cross-cluster replication.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html
	Stats ccr_stats.NewStats
	// Stops the following task associated with a follower index and removes index
	// metadata and settings associated with cross-cluster replication.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html
	Unfollow ccr_unfollow.NewUnfollow
}

type Cluster

type Cluster struct {
	// Provides explanations for shard allocations in the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-allocation-explain.html
	AllocationExplain cluster_allocation_explain.NewAllocationExplain
	// Delete component templates.
	// Deletes component templates.
	// Component templates are building blocks for constructing index templates that
	// specify index mappings, settings, and aliases.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
	DeleteComponentTemplate cluster_delete_component_template.NewDeleteComponentTemplate
	// Clears cluster voting config exclusions.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/voting-config-exclusions.html
	DeleteVotingConfigExclusions cluster_delete_voting_config_exclusions.NewDeleteVotingConfigExclusions
	// Check component templates.
	// Returns information about whether a particular component template exists.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
	ExistsComponentTemplate cluster_exists_component_template.NewExistsComponentTemplate
	// Get component templates.
	// Retrieves information about component templates.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
	GetComponentTemplate cluster_get_component_template.NewGetComponentTemplate
	// Returns cluster-wide settings.
	// By default, it returns only settings that have been explicitly defined.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-get-settings.html
	GetSettings cluster_get_settings.NewGetSettings
	// The cluster health API returns a simple status on the health of the cluster.
	// You can also use the API to get the health status of only specified data
	// streams and indices. For data streams, the API retrieves the health status of
	// the stream’s backing indices.
	// The cluster health status is: green, yellow or red. On the shard level, a red
	// status indicates that the specific shard is not allocated in the cluster,
	// yellow means that the primary shard is allocated but replicas are not, and
	// green means that all shards are allocated. The index level status is
	// controlled by the worst shard status. The cluster status is controlled by the
	// worst index status.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html
	Health cluster_health.NewHealth
	// Get cluster info.
	// Returns basic information about the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-info.html
	Info cluster_info.NewInfo
	// Returns cluster-level changes (such as create index, update mapping, allocate
	// or fail shard) that have not yet been executed.
	// NOTE: This API returns a list of any pending updates to the cluster state.
	// These are distinct from the tasks reported by the Task Management API which
	// include periodic tasks and tasks initiated by the user, such as node stats,
	// search queries, or create index requests.
	// However, if a user-initiated task such as a create index command causes a
	// cluster state update, the activity of this task might be reported by both
	// task api and pending cluster tasks API.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html
	PendingTasks cluster_pending_tasks.NewPendingTasks
	// Updates the cluster voting config exclusions by node ids or node names.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/voting-config-exclusions.html
	PostVotingConfigExclusions cluster_post_voting_config_exclusions.NewPostVotingConfigExclusions
	// Create or update a component template.
	// Creates or updates a component template.
	// Component templates are building blocks for constructing index templates that
	// specify index mappings, settings, and aliases.
	//
	// An index template can be composed of multiple component templates.
	// To use a component template, specify it in an index template’s `composed_of`
	// list.
	// Component templates are only applied to new data streams and indices as part
	// of a matching index template.
	//
	// Settings and mappings specified directly in the index template or the create
	// index request override any settings or mappings specified in a component
	// template.
	//
	// Component templates are only used during index creation.
	// For data streams, this includes data stream creation and the creation of a
	// stream’s backing indices.
	// Changes to component templates do not affect existing indices, including a
	// stream’s backing indices.
	//
	// You can use C-style `/* *\/` block comments in component templates.
	// You can include comments anywhere in the request body except before the
	// opening curly bracket.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
	PutComponentTemplate cluster_put_component_template.NewPutComponentTemplate
	// Updates the cluster settings.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html
	PutSettings cluster_put_settings.NewPutSettings
	// The cluster remote info API allows you to retrieve all of the configured
	// remote cluster information. It returns connection and endpoint information
	// keyed by the configured remote cluster alias.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-remote-info.html
	RemoteInfo cluster_remote_info.NewRemoteInfo
	// Allows to manually change the allocation of individual shards in the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html
	Reroute cluster_reroute.NewReroute
	// Returns a comprehensive information about the state of the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-state.html
	State cluster_state.NewState
	// Returns cluster statistics.
	// It returns basic index metrics (shard numbers, store size, memory usage) and
	// information about the current nodes that form the cluster (number, roles, os,
	// jvm versions, memory usage, cpu and installed plugins).
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html
	Stats cluster_stats.NewStats
}

type Connector added in v8.15.0

type Connector struct {
	// Check in a connector.
	//
	// Update the `last_seen` field in the connector and set it to the current
	// timestamp.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/check-in-connector-api.html
	CheckIn connector_check_in.NewCheckIn
	// Delete a connector.
	//
	// Removes a connector and associated sync jobs.
	// This is a destructive action that is not recoverable.
	// NOTE: This action doesn’t delete any API keys, ingest pipelines, or data
	// indices associated with the connector.
	// These need to be removed manually.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-connector-api.html
	Delete connector_delete.NewDelete
	// Get a connector.
	//
	// Get the details about a connector.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-api.html
	Get connector_get.NewGet
	// Update the connector last sync stats.
	//
	// Update the fields related to the last sync of a connector.
	// This action is used for analytics and monitoring.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-last-sync-api.html
	LastSync connector_last_sync.NewLastSync
	// Get all connectors.
	//
	// Get information about all connectors.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/list-connector-api.html
	List connector_list.NewList
	// Create a connector.
	//
	// Connectors are Elasticsearch integrations that bring content from third-party
	// data sources, which can be deployed on Elastic Cloud or hosted on your own
	// infrastructure.
	// Elastic managed connectors (Native connectors) are a managed service on
	// Elastic Cloud.
	// Self-managed connectors (Connector clients) are self-managed on your
	// infrastructure.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html
	Post connector_post.NewPost
	// Create or update a connector.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html
	Put connector_put.NewPut
	// Creates a secret for a Connector.
	//
	SecretPost connector_secret_post.NewSecretPost
	// Cancel a connector sync job.
	//
	// Cancel a connector sync job, which sets the status to cancelling and updates
	// `cancellation_requested_at` to the current time.
	// The connector service is then responsible for setting the status of connector
	// sync jobs to cancelled.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cancel-connector-sync-job-api.html
	SyncJobCancel connector_sync_job_cancel.NewSyncJobCancel
	// Delete a connector sync job.
	//
	// Remove a connector sync job and its associated data.
	// This is a destructive action that is not recoverable.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-connector-sync-job-api.html
	SyncJobDelete connector_sync_job_delete.NewSyncJobDelete
	// Get a connector sync job.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-sync-job-api.html
	SyncJobGet connector_sync_job_get.NewSyncJobGet
	// Get all connector sync jobs.
	//
	// Get information about all stored connector sync jobs listed by their creation
	// date in ascending order.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/list-connector-sync-jobs-api.html
	SyncJobList connector_sync_job_list.NewSyncJobList
	// Create a connector sync job.
	//
	// Create a connector sync job document in the internal index and initialize its
	// counters and timestamps with default values.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-sync-job-api.html
	SyncJobPost connector_sync_job_post.NewSyncJobPost
	// Activate the connector draft filter.
	//
	// Activates the valid draft filtering for a connector.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-api.html
	UpdateActiveFiltering connector_update_active_filtering.NewUpdateActiveFiltering
	// Update the connector API key ID.
	//
	// Update the `api_key_id` and `api_key_secret_id` fields of a connector.
	// You can specify the ID of the API key used for authorization and the ID of
	// the connector secret where the API key is stored.
	// The connector secret ID is required only for Elastic managed (native)
	// connectors.
	// Self-managed connectors (connector clients) do not use this field.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-api-key-id-api.html
	UpdateApiKeyId connector_update_api_key_id.NewUpdateApiKeyId
	// Update the connector configuration.
	//
	// Update the configuration field in the connector document.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-configuration-api.html
	UpdateConfiguration connector_update_configuration.NewUpdateConfiguration
	// Update the connector error field.
	//
	// Set the error field for the connector.
	// If the error provided in the request body is non-null, the connector’s status
	// is updated to error.
	// Otherwise, if the error is reset to null, the connector status is updated to
	// connected.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-error-api.html
	UpdateError connector_update_error.NewUpdateError
	// Update the connector filtering.
	//
	// Update the draft filtering configuration of a connector and marks the draft
	// validation state as edited.
	// The filtering draft is activated once validated by the running Elastic
	// connector service.
	// The filtering property is used to configure sync rules (both basic and
	// advanced) for a connector.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-api.html
	UpdateFiltering connector_update_filtering.NewUpdateFiltering
	// Update the connector draft filtering validation.
	//
	// Update the draft filtering validation info for a connector.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-validation-api.html
	UpdateFilteringValidation connector_update_filtering_validation.NewUpdateFilteringValidation
	// Update the connector index name.
	//
	// Update the `index_name` field of a connector, specifying the index where the
	// data ingested by the connector is stored.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-index-name-api.html
	UpdateIndexName connector_update_index_name.NewUpdateIndexName
	// Update the connector name and description.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-name-description-api.html
	UpdateName connector_update_name.NewUpdateName
	// Update the connector is_native flag.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-native-api.html
	UpdateNative connector_update_native.NewUpdateNative
	// Update the connector pipeline.
	//
	// When you create a new connector, the configuration of an ingest pipeline is
	// populated with default settings.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-pipeline-api.html
	UpdatePipeline connector_update_pipeline.NewUpdatePipeline
	// Update the connector scheduling.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-scheduling-api.html
	UpdateScheduling connector_update_scheduling.NewUpdateScheduling
	// Update the connector service type.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-service-type-api.html
	UpdateServiceType connector_update_service_type.NewUpdateServiceType
	// Update the connector status.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-status-api.html
	UpdateStatus connector_update_status.NewUpdateStatus
}

type Core

type Core struct {
	// Bulk index or delete documents.
	// Performs multiple indexing or delete operations in a single API call.
	// This reduces overhead and can greatly increase indexing speed.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
	Bulk core_bulk.NewBulk
	// Clear a scrolling search.
	//
	// Clear the search context and results for a scrolling search.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html
	ClearScroll core_clear_scroll.NewClearScroll
	// Close a point in time.
	//
	// A point in time must be opened explicitly before being used in search
	// requests.
	// The `keep_alive` parameter tells Elasticsearch how long it should persist.
	// A point in time is automatically closed when the `keep_alive` period has
	// elapsed.
	// However, keeping points in time has a cost; close them as soon as they are no
	// longer required for search requests.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html
	ClosePointInTime core_close_point_in_time.NewClosePointInTime
	// Returns number of documents matching a query.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
	Count core_count.NewCount
	// Index a document.
	// Adds a JSON document to the specified data stream or index and makes it
	// searchable.
	// If the target is an index and the document already exists, the request
	// updates the document and increments its version.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
	Create core_create.NewCreate
	// Delete a document.
	// Removes a JSON document from the specified index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html
	Delete core_delete.NewDelete
	// Delete documents.
	// Deletes documents that match the specified query.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
	DeleteByQuery core_delete_by_query.NewDeleteByQuery
	// Throttle a delete by query operation.
	//
	// Change the number of requests per second for a particular delete by query
	// operation.
	// Rethrottling that speeds up the query takes effect immediately but
	// rethrotting that slows down the query takes effect after completing the
	// current batch to prevent scroll timeouts.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
	DeleteByQueryRethrottle core_delete_by_query_rethrottle.NewDeleteByQueryRethrottle
	// Delete a script or search template.
	// Deletes a stored script or search template.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
	DeleteScript core_delete_script.NewDeleteScript
	// Check a document.
	// Checks if a specified document exists.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
	Exists core_exists.NewExists
	// Check for a document source.
	// Checks if a document's `_source` is stored.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
	ExistsSource core_exists_source.NewExistsSource
	// Explain a document match result.
	// Returns information about why a specific document matches, or doesn’t match,
	// a query.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html
	Explain core_explain.NewExplain
	// Get the field capabilities.
	//
	// Get information about the capabilities of fields among multiple indices.
	//
	// For data streams, the API returns field capabilities among the stream’s
	// backing indices.
	// It returns runtime fields like any other field.
	// For example, a runtime field with a type of keyword is returned the same as
	// any other field that belongs to the `keyword` family.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html
	FieldCaps core_field_caps.NewFieldCaps
	// Get a document by its ID.
	// Retrieves the document with the specified ID from an index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
	Get core_get.NewGet
	// Get a script or search template.
	// Retrieves a stored script or search template.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
	GetScript core_get_script.NewGetScript
	// Get script contexts.
	//
	// Get a list of supported script contexts and their methods.
	// https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-contexts.html
	GetScriptContext core_get_script_context.NewGetScriptContext
	// Get script languages.
	//
	// Get a list of available script types, languages, and contexts.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
	GetScriptLanguages core_get_script_languages.NewGetScriptLanguages
	// Get a document's source.
	// Returns the source of a document.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
	GetSource core_get_source.NewGetSource
	// Returns the health of the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html
	HealthReport core_health_report.NewHealthReport
	// Index a document.
	// Adds a JSON document to the specified data stream or index and makes it
	// searchable.
	// If the target is an index and the document already exists, the request
	// updates the document and increments its version.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
	Index core_index.NewIndex
	// Get cluster info.
	// Returns basic information about the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
	Info core_info.NewInfo
	// Run a knn search.
	//
	// NOTE: The kNN search API has been replaced by the `knn` option in the search
	// API.
	//
	// Perform a k-nearest neighbor (kNN) search on a dense_vector field and return
	// the matching documents.
	// Given a query vector, the API finds the k closest vectors and returns those
	// documents as search hits.
	//
	// Elasticsearch uses the HNSW algorithm to support efficient kNN search.
	// Like most kNN algorithms, HNSW is an approximate method that sacrifices
	// result accuracy for improved search speed.
	// This means the results returned are not always the true k closest neighbors.
	//
	// The kNN search API supports restricting the search using a filter.
	// The search will return the top k documents that also match the filter query.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html
	KnnSearch core_knn_search.NewKnnSearch
	// Get multiple documents.
	//
	// Get multiple JSON documents by ID from one or more indices.
	// If you specify an index in the request URI, you only need to specify the
	// document IDs in the request body.
	// To ensure fast responses, this multi get (mget) API responds with partial
	// results if one or more shards fail.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html
	Mget core_mget.NewMget
	// Run multiple searches.
	//
	// The format of the request is similar to the bulk API format and makes use of
	// the newline delimited JSON (NDJSON) format.
	// The structure is as follows:
	//
	// “`
	// header\n
	// body\n
	// header\n
	// body\n
	// “`
	//
	// This structure is specifically optimized to reduce parsing if a specific
	// search ends up redirected to another node.
	//
	// IMPORTANT: The final line of data must end with a newline character `\n`.
	// Each newline character may be preceded by a carriage return `\r`.
	// When sending requests to this endpoint the `Content-Type` header should be
	// set to `application/x-ndjson`.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html
	Msearch core_msearch.NewMsearch
	// Run multiple templated searches.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html
	MsearchTemplate core_msearch_template.NewMsearchTemplate
	// Get multiple term vectors.
	//
	// You can specify existing documents by index and ID or provide artificial
	// documents in the body of the request.
	// You can specify the index in the request body or request URI.
	// The response contains a `docs` array with all the fetched termvectors.
	// Each element has the structure provided by the termvectors API.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html
	Mtermvectors core_mtermvectors.NewMtermvectors
	// Open a point in time.
	//
	// A search request by default runs against the most recent visible data of the
	// target indices,
	// which is called point in time. Elasticsearch pit (point in time) is a
	// lightweight view into the
	// state of the data as it existed when initiated. In some cases, it’s preferred
	// to perform multiple
	// search requests using the same point in time. For example, if refreshes
	// happen between
	// `search_after` requests, then the results of those requests might not be
	// consistent as changes happening
	// between searches are only visible to the more recent point in time.
	//
	// A point in time must be opened explicitly before being used in search
	// requests.
	// The `keep_alive` parameter tells Elasticsearch how long it should persist.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html
	OpenPointInTime core_open_point_in_time.NewOpenPointInTime
	// Ping the cluster.
	// Returns whether the cluster is running.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
	Ping core_ping.NewPing
	// Create or update a script or search template.
	// Creates or updates a stored script or search template.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
	PutScript core_put_script.NewPutScript
	// Evaluate ranked search results.
	//
	// Evaluate the quality of ranked search results over a set of typical search
	// queries.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html
	RankEval core_rank_eval.NewRankEval
	// Reindex documents.
	// Copies documents from a source to a destination. The source can be any
	// existing index, alias, or data stream. The destination must differ from the
	// source. For example, you cannot reindex a data stream into itself.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
	Reindex core_reindex.NewReindex
	// Throttle a reindex operation.
	//
	// Change the number of requests per second for a particular reindex operation.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
	ReindexRethrottle core_reindex_rethrottle.NewReindexRethrottle
	// Render a search template.
	//
	// Render a search template as a search request body.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html
	RenderSearchTemplate core_render_search_template.NewRenderSearchTemplate
	// Run a script.
	// Runs a script and returns a result.
	// https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html
	ScriptsPainlessExecute core_scripts_painless_execute.NewScriptsPainlessExecute
	// Run a scrolling search.
	//
	// IMPORTANT: The scroll API is no longer recommend for deep pagination. If you
	// need to preserve the index state while paging through more than 10,000 hits,
	// use the `search_after` parameter with a point in time (PIT).
	//
	// The scroll API gets large sets of results from a single scrolling search
	// request.
	// To get the necessary scroll ID, submit a search API request that includes an
	// argument for the `scroll` query parameter.
	// The `scroll` parameter indicates how long Elasticsearch should retain the
	// search context for the request.
	// The search response returns a scroll ID in the `_scroll_id` response body
	// parameter.
	// You can then use the scroll ID with the scroll API to retrieve the next batch
	// of results for the request.
	// If the Elasticsearch security features are enabled, the access to the results
	// of a specific scroll ID is restricted to the user or API key that submitted
	// the search.
	//
	// You can also use the scroll API to specify a new scroll parameter that
	// extends or shortens the retention period for the search context.
	//
	// IMPORTANT: Results from a scrolling search reflect the state of the index at
	// the time of the initial search request. Subsequent indexing or document
	// changes only affect later search and scroll requests.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-scroll
	Scroll core_scroll.NewScroll
	// Run a search.
	//
	// Get search hits that match the query defined in the request.
	// You can provide search queries using the `q` query string parameter or the
	// request body.
	// If both are specified, only the query parameter is used.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html
	Search core_search.NewSearch
	// Search a vector tile.
	//
	// Search a vector tile for geospatial values.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-vector-tile-api.html
	SearchMvt core_search_mvt.NewSearchMvt
	// Get the search shards.
	//
	// Get the indices and shards that a search request would be run against.
	// This information can be useful for working out issues or planning
	// optimizations with routing and shard preferences.
	// When filtered aliases are used, the filter is returned as part of the indices
	// section.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html
	SearchShards core_search_shards.NewSearchShards
	// Run a search with a search template.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html
	SearchTemplate core_search_template.NewSearchTemplate
	// Get terms in an index.
	//
	// Discover terms that match a partial string in an index.
	// This "terms enum" API is designed for low-latency look-ups used in
	// auto-complete scenarios.
	//
	// If the `complete` property in the response is false, the returned terms set
	// may be incomplete and should be treated as approximate.
	// This can occur due to a few reasons, such as a request timeout or a node
	// error.
	//
	// NOTE: The terms enum API may return terms from deleted documents. Deleted
	// documents are initially only marked as deleted. It is not until their
	// segments are merged that documents are actually deleted. Until that happens,
	// the terms enum API will return terms from these documents.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html
	TermsEnum core_terms_enum.NewTermsEnum
	// Get term vector information.
	//
	// Get information and statistics about terms in the fields of a particular
	// document.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-termvectors.html
	Termvectors core_termvectors.NewTermvectors
	// Update a document.
	// Updates a document by running a script or passing a partial document.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html
	Update core_update.NewUpdate
	// Update documents.
	// Updates documents that match the specified query.
	// If no query is specified, performs an update on every document in the data
	// stream or index without modifying the source, which is useful for picking up
	// mapping changes.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html
	UpdateByQuery core_update_by_query.NewUpdateByQuery
	// Throttle an update by query operation.
	//
	// Change the number of requests per second for a particular update by query
	// operation.
	// Rethrottling that speeds up the query takes effect immediately but
	// rethrotting that slows down the query takes effect after completing the
	// current batch to prevent scroll timeouts.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html
	UpdateByQueryRethrottle core_update_by_query_rethrottle.NewUpdateByQueryRethrottle
}

type DanglingIndices added in v8.7.1

type DanglingIndices struct {
	// Delete a dangling index.
	//
	// If Elasticsearch encounters index data that is absent from the current
	// cluster state, those indices are considered to be dangling.
	// For example, this can happen if you delete more than
	// `cluster.indices.tombstones.size` indices while an Elasticsearch node is
	// offline.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html
	DeleteDanglingIndex dangling_indices_delete_dangling_index.NewDeleteDanglingIndex
	// Import a dangling index.
	//
	// If Elasticsearch encounters index data that is absent from the current
	// cluster state, those indices are considered to be dangling.
	// For example, this can happen if you delete more than
	// `cluster.indices.tombstones.size` indices while an Elasticsearch node is
	// offline.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html
	ImportDanglingIndex dangling_indices_import_dangling_index.NewImportDanglingIndex
	// Get the dangling indices.
	//
	// If Elasticsearch encounters index data that is absent from the current
	// cluster state, those indices are considered to be dangling.
	// For example, this can happen if you delete more than
	// `cluster.indices.tombstones.size` indices while an Elasticsearch node is
	// offline.
	//
	// Use this API to list dangling indices, which you can then import or delete.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html
	ListDanglingIndices dangling_indices_list_dangling_indices.NewListDanglingIndices
}

type Enrich

type Enrich struct {
	// Delete an enrich policy.
	// Deletes an existing enrich policy and its enrich index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html
	DeletePolicy enrich_delete_policy.NewDeletePolicy
	// Creates the enrich index for an existing enrich policy.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html
	ExecutePolicy enrich_execute_policy.NewExecutePolicy
	// Get an enrich policy.
	// Returns information about an enrich policy.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html
	GetPolicy enrich_get_policy.NewGetPolicy
	// Create an enrich policy.
	// Creates an enrich policy.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html
	PutPolicy enrich_put_policy.NewPutPolicy
	// Get enrich stats.
	// Returns enrich coordinator statistics and information about enrich policies
	// that are currently executing.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html
	Stats enrich_stats.NewStats
}

type Eql

type Eql struct {
	// Deletes an async EQL search or a stored synchronous EQL search.
	// The API also deletes results for the search.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html
	Delete eql_delete.NewDelete
	// Returns the current status and available results for an async EQL search or a
	// stored synchronous EQL search.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-search-api.html
	Get eql_get.NewGet
	// Returns the current status for an async EQL search or a stored synchronous
	// EQL search without returning results.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-status-api.html
	GetStatus eql_get_status.NewGetStatus
	// Returns results matching a query expressed in Event Query Language (EQL)
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html
	Search eql_search.NewSearch
}

type Esql added in v8.12.0

type Features

type Features struct {
	// Gets a list of features which can be included in snapshots using the
	// feature_states field when creating a snapshot
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-features-api.html
	GetFeatures features_get_features.NewGetFeatures
	// Resets the internal state of features, usually by deleting system indices
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
	ResetFeatures features_reset_features.NewResetFeatures
}

type Fleet

type Fleet struct {
	// Returns the current global checkpoints for an index. This API is design for
	// internal use by the fleet server project.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html
	GlobalCheckpoints fleet_global_checkpoints.NewGlobalCheckpoints
	// Executes several [fleet
	// searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html)
	// with a single API request.
	// The API follows the same structure as the [multi
	// search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html)
	// API. However, similar to the fleet search API, it
	// supports the wait_for_checkpoints parameter.
	//
	Msearch fleet_msearch.NewMsearch
	// Creates a secret stored by Fleet.
	//
	PostSecret fleet_post_secret.NewPostSecret
	// The purpose of the fleet search api is to provide a search api where the
	// search will only be executed
	// after provided checkpoint has been processed and is visible for searches
	// inside of Elasticsearch.
	//
	Search fleet_search.NewSearch
}

type Graph

type Graph struct {
	// Extracts and summarizes information about the documents and terms in an
	// Elasticsearch data stream or index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html
	Explore graph_explore.NewExplore
}

type Ilm

type Ilm struct {
	// Deletes the specified lifecycle policy definition. You cannot delete policies
	// that are currently in use. If the policy is being used to manage any indices,
	// the request fails and returns an error.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html
	DeleteLifecycle ilm_delete_lifecycle.NewDeleteLifecycle
	// Retrieves information about the index’s current lifecycle state, such as the
	// currently executing phase, action, and step. Shows when the index entered
	// each one, the definition of the running phase, and information about any
	// failures.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html
	ExplainLifecycle ilm_explain_lifecycle.NewExplainLifecycle
	// Retrieves a lifecycle policy.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html
	GetLifecycle ilm_get_lifecycle.NewGetLifecycle
	// Retrieves the current index lifecycle management (ILM) status.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html
	GetStatus ilm_get_status.NewGetStatus
	// Switches the indices, ILM policies, and legacy, composable and component
	// templates from using custom node attributes and
	// attribute-based allocation filters to using data tiers, and optionally
	// deletes one legacy index template.+
	// Using node roles enables ILM to automatically move the indices between data
	// tiers.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html
	MigrateToDataTiers ilm_migrate_to_data_tiers.NewMigrateToDataTiers
	// Manually moves an index into the specified step and executes that step.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html
	MoveToStep ilm_move_to_step.NewMoveToStep
	// Creates a lifecycle policy. If the specified policy exists, the policy is
	// replaced and the policy version is incremented.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html
	PutLifecycle ilm_put_lifecycle.NewPutLifecycle
	// Removes the assigned lifecycle policy and stops managing the specified index
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html
	RemovePolicy ilm_remove_policy.NewRemovePolicy
	// Retries executing the policy for an index that is in the ERROR step.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html
	Retry ilm_retry.NewRetry
	// Start the index lifecycle management (ILM) plugin.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html
	Start ilm_start.NewStart
	// Halts all lifecycle management operations and stops the index lifecycle
	// management (ILM) plugin
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html
	Stop ilm_stop.NewStop
}

type Indices

type Indices struct {
	// Add an index block.
	// Limits the operations allowed on an index by blocking specific operation
	// types.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html
	AddBlock indices_add_block.NewAddBlock
	// Get tokens from text analysis.
	// The analyze API performs
	// [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html)
	// on a text string and returns the resulting tokens.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html
	Analyze indices_analyze.NewAnalyze
	// Clears the caches of one or more indices.
	// For data streams, the API clears the caches of the stream’s backing indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html
	ClearCache indices_clear_cache.NewClearCache
	// Clones an existing index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clone-index.html
	Clone indices_clone.NewClone
	// Closes an index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-close.html
	Close indices_close.NewClose
	// Create an index.
	// Creates a new index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html
	Create indices_create.NewCreate
	// Create a data stream.
	// Creates a data stream.
	// You must have a matching index template with data stream enabled.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
	CreateDataStream indices_create_data_stream.NewCreateDataStream
	// Get data stream stats.
	// Retrieves statistics for one or more data streams.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
	DataStreamsStats indices_data_streams_stats.NewDataStreamsStats
	// Delete indices.
	// Deletes one or more indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html
	Delete indices_delete.NewDelete
	// Delete an alias.
	// Removes a data stream or index from an alias.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
	DeleteAlias indices_delete_alias.NewDeleteAlias
	// Delete data stream lifecycles.
	// Removes the data stream lifecycle from a data stream, rendering it not
	// managed by the data stream lifecycle.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-delete-lifecycle.html
	DeleteDataLifecycle indices_delete_data_lifecycle.NewDeleteDataLifecycle
	// Delete data streams.
	// Deletes one or more data streams and their backing indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
	DeleteDataStream indices_delete_data_stream.NewDeleteDataStream
	// Delete an index template.
	// The provided <index-template> may contain multiple template names separated
	// by a comma. If multiple template
	// names are specified then there is no wildcard support and the provided names
	// should match completely with
	// existing templates.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-template.html
	DeleteIndexTemplate indices_delete_index_template.NewDeleteIndexTemplate
	// Deletes a legacy index template.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-template-v1.html
	DeleteTemplate indices_delete_template.NewDeleteTemplate
	// Analyzes the disk usage of each field of an index or data stream.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-disk-usage.html
	DiskUsage indices_disk_usage.NewDiskUsage
	// Aggregates a time series (TSDS) index and stores pre-computed statistical
	// summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric
	// field grouped by a configured time interval.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-downsample-data-stream.html
	Downsample indices_downsample.NewDownsample
	// Check indices.
	// Checks if one or more indices, index aliases, or data streams exist.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html
	Exists indices_exists.NewExists
	// Check aliases.
	// Checks if one or more data stream or index aliases exist.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
	ExistsAlias indices_exists_alias.NewExistsAlias
	// Returns information about whether a particular index template exists.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html
	ExistsIndexTemplate indices_exists_index_template.NewExistsIndexTemplate
	// Check existence of index templates.
	// Returns information about whether a particular index template exists.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-template-exists-v1.html
	ExistsTemplate indices_exists_template.NewExistsTemplate
	// Get the status for a data stream lifecycle.
	// Retrieves information about an index or data stream’s current data stream
	// lifecycle status, such as time since index creation, time since rollover, the
	// lifecycle configuration managing the index, or any errors encountered during
	// lifecycle execution.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html
	ExplainDataLifecycle indices_explain_data_lifecycle.NewExplainDataLifecycle
	// Returns field usage information for each shard and field of an index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/field-usage-stats.html
	FieldUsageStats indices_field_usage_stats.NewFieldUsageStats
	// Flushes one or more data streams or indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-flush.html
	Flush indices_flush.NewFlush
	// Performs the force merge operation on one or more indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-forcemerge.html
	Forcemerge indices_forcemerge.NewForcemerge
	// Get index information.
	// Returns information about one or more indices. For data streams, the API
	// returns information about the
	// stream’s backing indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html
	Get indices_get.NewGet
	// Get aliases.
	// Retrieves information for one or more data stream or index aliases.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
	GetAlias indices_get_alias.NewGetAlias
	// Get data stream lifecycles.
	// Retrieves the data stream lifecycle configuration of one or more data
	// streams.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-get-lifecycle.html
	GetDataLifecycle indices_get_data_lifecycle.NewGetDataLifecycle
	// Get data streams.
	// Retrieves information about one or more data streams.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
	GetDataStream indices_get_data_stream.NewGetDataStream
	// Get mapping definitions.
	// Retrieves mapping definitions for one or more fields.
	// For data streams, the API retrieves field mappings for the stream’s backing
	// indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html
	GetFieldMapping indices_get_field_mapping.NewGetFieldMapping
	// Get index templates.
	// Returns information about one or more index templates.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template.html
	GetIndexTemplate indices_get_index_template.NewGetIndexTemplate
	// Get mapping definitions.
	// Retrieves mapping definitions for one or more indices.
	// For data streams, the API retrieves mappings for the stream’s backing
	// indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-mapping.html
	GetMapping indices_get_mapping.NewGetMapping
	// Get index settings.
	// Returns setting information for one or more indices. For data streams,
	// returns setting information for the stream’s backing indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html
	GetSettings indices_get_settings.NewGetSettings
	// Get index templates.
	// Retrieves information about one or more index templates.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template-v1.html
	GetTemplate indices_get_template.NewGetTemplate
	// Convert an index alias to a data stream.
	// Converts an index alias to a data stream.
	// You must have a matching index template that is data stream enabled.
	// The alias must meet the following criteria:
	// The alias must have a write index;
	// All indices for the alias must have a `@timestamp` field mapping of a `date`
	// or `date_nanos` field type;
	// The alias must not have any filters;
	// The alias must not use custom routing.
	// If successful, the request removes the alias and creates a data stream with
	// the same name.
	// The indices for the alias become hidden backing indices for the stream.
	// The write index for the alias becomes the write index for the stream.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
	MigrateToDataStream indices_migrate_to_data_stream.NewMigrateToDataStream
	// Update data streams.
	// Performs one or more data stream modification actions in a single atomic
	// operation.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
	ModifyDataStream indices_modify_data_stream.NewModifyDataStream
	// Opens a closed index.
	// For data streams, the API opens any closed backing indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html
	Open indices_open.NewOpen
	// Promotes a data stream from a replicated data stream managed by CCR to a
	// regular data stream
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
	PromoteDataStream indices_promote_data_stream.NewPromoteDataStream
	// Create or update an alias.
	// Adds a data stream or index to an alias.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
	PutAlias indices_put_alias.NewPutAlias
	// Update data stream lifecycles.
	// Update the data stream lifecycle of the specified data streams.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-put-lifecycle.html
	PutDataLifecycle indices_put_data_lifecycle.NewPutDataLifecycle
	// Create or update an index template.
	// Index templates define settings, mappings, and aliases that can be applied
	// automatically to new indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-template.html
	PutIndexTemplate indices_put_index_template.NewPutIndexTemplate
	// Update field mappings.
	// Adds new fields to an existing data stream or index.
	// You can also use this API to change the search settings of existing fields.
	// For data streams, these changes are applied to all backing indices by
	// default.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html
	PutMapping indices_put_mapping.NewPutMapping
	// Update index settings.
	// Changes dynamic index settings in real time. For data streams, index setting
	// changes are applied to all backing indices by default.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html
	PutSettings indices_put_settings.NewPutSettings
	// Create or update an index template.
	// Index templates define settings, mappings, and aliases that can be applied
	// automatically to new indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html
	PutTemplate indices_put_template.NewPutTemplate
	// Returns information about ongoing and completed shard recoveries for one or
	// more indices.
	// For data streams, the API returns information for the stream’s backing
	// indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-recovery.html
	Recovery indices_recovery.NewRecovery
	// Refresh an index.
	// A refresh makes recent operations performed on one or more indices available
	// for search.
	// For data streams, the API runs the refresh operation on the stream’s backing
	// indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html
	Refresh indices_refresh.NewRefresh
	// Reloads an index's search analyzers and their resources.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-reload-analyzers.html
	ReloadSearchAnalyzers indices_reload_search_analyzers.NewReloadSearchAnalyzers
	// Resolves the specified index expressions to return information about each
	// cluster, including
	// the local cluster, if included.
	// Multiple patterns and remote clusters are supported.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-resolve-cluster-api.html
	ResolveCluster indices_resolve_cluster.NewResolveCluster
	// Resolves the specified name(s) and/or index patterns for indices, aliases,
	// and data streams.
	// Multiple patterns and remote clusters are supported.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-resolve-index-api.html
	ResolveIndex indices_resolve_index.NewResolveIndex
	// Roll over to a new index.
	// Creates a new index for a data stream or index alias.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html
	Rollover indices_rollover.NewRollover
	// Returns low-level information about the Lucene segments in index shards.
	// For data streams, the API returns information about the stream’s backing
	// indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-segments.html
	Segments indices_segments.NewSegments
	// Retrieves store information about replica shards in one or more indices.
	// For data streams, the API retrieves store information for the stream’s
	// backing indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shards-stores.html
	ShardStores indices_shard_stores.NewShardStores
	// Shrinks an existing index into a new index with fewer primary shards.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shrink-index.html
	Shrink indices_shrink.NewShrink
	// Simulate an index.
	// Returns the index configuration that would be applied to the specified index
	// from an existing index template.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-simulate-index.html
	SimulateIndexTemplate indices_simulate_index_template.NewSimulateIndexTemplate
	// Simulate an index template.
	// Returns the index configuration that would be applied by a particular index
	// template.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-simulate-template.html
	SimulateTemplate indices_simulate_template.NewSimulateTemplate
	// Splits an existing index into a new index with more primary shards.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-split-index.html
	Split indices_split.NewSplit
	// Returns statistics for one or more indices.
	// For data streams, the API retrieves statistics for the stream’s backing
	// indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html
	Stats indices_stats.NewStats
	// Unfreezes an index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html
	Unfreeze indices_unfreeze.NewUnfreeze
	// Create or update an alias.
	// Adds a data stream or index to an alias.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
	UpdateAliases indices_update_aliases.NewUpdateAliases
	// Validate a query.
	// Validates a query without running it.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-validate.html
	ValidateQuery indices_validate_query.NewValidateQuery
}

type Ingest

type Ingest struct {
	// Deletes a geoip database configuration.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-geoip-database-api.html
	DeleteGeoipDatabase ingest_delete_geoip_database.NewDeleteGeoipDatabase
	// Deletes one or more existing ingest pipeline.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-pipeline-api.html
	DeletePipeline ingest_delete_pipeline.NewDeletePipeline
	// Gets download statistics for GeoIP2 databases used with the geoip processor.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html
	GeoIpStats ingest_geo_ip_stats.NewGeoIpStats
	// Returns information about one or more geoip database configurations.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-geoip-database-api.html
	GetGeoipDatabase ingest_get_geoip_database.NewGetGeoipDatabase
	// Returns information about one or more ingest pipelines.
	// This API returns a local reference of the pipeline.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-pipeline-api.html
	GetPipeline ingest_get_pipeline.NewGetPipeline
	// Extracts structured fields out of a single text field within a document.
	// You choose which field to extract matched fields from, as well as the grok
	// pattern you expect will match.
	// A grok pattern is like a regular expression that supports aliased expressions
	// that can be reused.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html
	ProcessorGrok ingest_processor_grok.NewProcessorGrok
	// Returns information about one or more geoip database configurations.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/put-geoip-database-api.html
	PutGeoipDatabase ingest_put_geoip_database.NewPutGeoipDatabase
	// Creates or updates an ingest pipeline.
	// Changes made using this API take effect immediately.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html
	PutPipeline ingest_put_pipeline.NewPutPipeline
	// Executes an ingest pipeline against a set of provided documents.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html
	Simulate ingest_simulate.NewSimulate
}

type License

type License struct {
	// Deletes licensing information for the cluster
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-license.html
	Delete license_delete.NewDelete
	// Get license information.
	// Returns information about your Elastic license, including its type, its
	// status, when it was issued, and when it expires.
	// For more information about the different types of licenses, refer to [Elastic
	// Stack subscriptions](https://www.elastic.co/subscriptions).
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-license.html
	Get license_get.NewGet
	// Retrieves information about the status of the basic license.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html
	GetBasicStatus license_get_basic_status.NewGetBasicStatus
	// Retrieves information about the status of the trial license.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trial-status.html
	GetTrialStatus license_get_trial_status.NewGetTrialStatus
	// Updates the license for the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-license.html
	Post license_post.NewPost
	// The start basic API enables you to initiate an indefinite basic license,
	// which gives access to all the basic features. If the basic license does not
	// support all of the features that are available with your current license,
	// however, you are notified in the response. You must then re-submit the API
	// request with the acknowledge parameter set to true.
	// To check the status of your basic license, use the following API: [Get basic
	// status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html).
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/start-basic.html
	PostStartBasic license_post_start_basic.NewPostStartBasic
	// The start trial API enables you to start a 30-day trial, which gives access
	// to all subscription features.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trial.html
	PostStartTrial license_post_start_trial.NewPostStartTrial
}

type Logstash

type Logstash struct {
	// Deletes a pipeline used for Logstash Central Management.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html
	DeletePipeline logstash_delete_pipeline.NewDeletePipeline
	// Retrieves pipelines used for Logstash Central Management.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html
	GetPipeline logstash_get_pipeline.NewGetPipeline
	// Creates or updates a pipeline used for Logstash Central Management.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html
	PutPipeline logstash_put_pipeline.NewPutPipeline
}

type Migration

type Migration struct {
	// Retrieves information about different cluster, node, and index level settings
	// that use deprecated features that will be removed or changed in the next
	// major version.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html
	Deprecations migration_deprecations.NewDeprecations
	// Find out whether system features need to be upgraded or not
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html
	GetFeatureUpgradeStatus migration_get_feature_upgrade_status.NewGetFeatureUpgradeStatus
	// Begin upgrades for system features
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html
	PostFeatureUpgrade migration_post_feature_upgrade.NewPostFeatureUpgrade
}

type Ml

type Ml struct {
	// Clear trained model deployment cache.
	// Cache will be cleared on all nodes where the trained model is assigned.
	// A trained model deployment may have an inference cache enabled.
	// As requests are handled by each allocated node, their responses may be cached
	// on that individual node.
	// Calling this API clears the caches without restarting the deployment.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-trained-model-deployment-cache.html
	ClearTrainedModelDeploymentCache ml_clear_trained_model_deployment_cache.NewClearTrainedModelDeploymentCache
	// Close anomaly detection jobs.
	// A job can be opened and closed multiple times throughout its lifecycle. A
	// closed job cannot receive data or perform analysis operations, but you can
	// still explore and navigate results.
	// When you close a job, it runs housekeeping tasks such as pruning the model
	// history, flushing buffers, calculating final results and persisting the model
	// snapshots. Depending upon the size of the job, it could take several minutes
	// to close and the equivalent time to re-open. After it is closed, the job has
	// a minimal overhead on the cluster except for maintaining its meta data.
	// Therefore it is a best practice to close jobs that are no longer required to
	// process data.
	// If you close an anomaly detection job whose datafeed is running, the request
	// first tries to stop the datafeed. This behavior is equivalent to calling stop
	// datafeed API with the same timeout and force parameters as the close job
	// request.
	// When a datafeed that has a specified end date stops, it automatically closes
	// its associated job.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html
	CloseJob ml_close_job.NewCloseJob
	// Delete a calendar.
	// Removes all scheduled events from a calendar, then deletes it.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html
	DeleteCalendar ml_delete_calendar.NewDeleteCalendar
	// Delete events from a calendar.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html
	DeleteCalendarEvent ml_delete_calendar_event.NewDeleteCalendarEvent
	// Delete anomaly jobs from a calendar.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html
	DeleteCalendarJob ml_delete_calendar_job.NewDeleteCalendarJob
	// Delete a data frame analytics job.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html
	DeleteDataFrameAnalytics ml_delete_data_frame_analytics.NewDeleteDataFrameAnalytics
	// Delete a datafeed.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html
	DeleteDatafeed ml_delete_datafeed.NewDeleteDatafeed
	// Delete expired ML data.
	// Deletes all job results, model snapshots and forecast data that have exceeded
	// their retention days period. Machine learning state documents that are not
	// associated with any job are also deleted.
	// You can limit the request to a single or set of anomaly detection jobs by
	// using a job identifier, a group name, a comma-separated list of jobs, or a
	// wildcard expression. You can delete expired data for all anomaly detection
	// jobs by using _all, by specifying * as the <job_id>, or by omitting the
	// <job_id>.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html
	DeleteExpiredData ml_delete_expired_data.NewDeleteExpiredData
	// Delete a filter.
	// If an anomaly detection job references the filter, you cannot delete the
	// filter. You must update or delete the job before you can delete the filter.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html
	DeleteFilter ml_delete_filter.NewDeleteFilter
	// Delete forecasts from a job.
	// By default, forecasts are retained for 14 days. You can specify a
	// different retention period with the `expires_in` parameter in the forecast
	// jobs API. The delete forecast API enables you to delete one or more
	// forecasts before they expire.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html
	DeleteForecast ml_delete_forecast.NewDeleteForecast
	// Delete an anomaly detection job.
	// All job configuration, model state and results are deleted.
	// It is not currently possible to delete multiple jobs using wildcards or a
	// comma separated list. If you delete a job that has a datafeed, the request
	// first tries to delete the datafeed. This behavior is equivalent to calling
	// the delete datafeed API with the same timeout and force parameters as the
	// delete job request.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html
	DeleteJob ml_delete_job.NewDeleteJob
	// Delete a model snapshot.
	// You cannot delete the active model snapshot. To delete that snapshot, first
	// revert to a different one. To identify the active model snapshot, refer to
	// the `model_snapshot_id` in the results from the get jobs API.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html
	DeleteModelSnapshot ml_delete_model_snapshot.NewDeleteModelSnapshot
	// Delete an unreferenced trained model.
	// The request deletes a trained inference model that is not referenced by an
	// ingest pipeline.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html
	DeleteTrainedModel ml_delete_trained_model.NewDeleteTrainedModel
	// Delete a trained model alias.
	// This API deletes an existing model alias that refers to a trained model. If
	// the model alias is missing or refers to a model other than the one identified
	// by the `model_id`, this API returns an error.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html
	DeleteTrainedModelAlias ml_delete_trained_model_alias.NewDeleteTrainedModelAlias
	// Estimate job model memory usage.
	// Makes an estimation of the memory usage for an anomaly detection job model.
	// It is based on analysis configuration details for the job and cardinality
	// estimates for the fields it references.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html
	EstimateModelMemory ml_estimate_model_memory.NewEstimateModelMemory
	// Evaluate data frame analytics.
	// The API packages together commonly used evaluation metrics for various types
	// of machine learning features. This has been designed for use on indexes
	// created by data frame analytics. Evaluation requires both a ground truth
	// field and an analytics result field to be present.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html
	EvaluateDataFrame ml_evaluate_data_frame.NewEvaluateDataFrame
	// Explain data frame analytics config.
	// This API provides explanations for a data frame analytics config that either
	// exists already or one that has not been created yet. The following
	// explanations are provided:
	// * which fields are included or not in the analysis and why,
	// * how much memory is estimated to be required. The estimate can be used when
	// deciding the appropriate value for model_memory_limit setting later on.
	// If you have object fields or fields that are excluded via source filtering,
	// they are not included in the explanation.
	// http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html
	ExplainDataFrameAnalytics ml_explain_data_frame_analytics.NewExplainDataFrameAnalytics
	// Force buffered data to be processed.
	// The flush jobs API is only applicable when sending data for analysis using
	// the post data API. Depending on the content of the buffer, then it might
	// additionally calculate new results. Both flush and close operations are
	// similar, however the flush is more efficient if you are expecting to send
	// more data for analysis. When flushing, the job remains open and is available
	// to continue analyzing data. A close operation additionally prunes and
	// persists the model state to disk and the job must be opened again before
	// analyzing further data.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html
	FlushJob ml_flush_job.NewFlushJob
	// Predict future behavior of a time series.
	//
	// Forecasts are not supported for jobs that perform population analysis; an
	// error occurs if you try to create a forecast for a job that has an
	// `over_field_name` in its configuration. Forcasts predict future behavior
	// based on historical data.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html
	Forecast ml_forecast.NewForecast
	// Get anomaly detection job results for buckets.
	// The API presents a chronological view of the records, grouped by bucket.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html
	GetBuckets ml_get_buckets.NewGetBuckets
	// Get info about events in calendars.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html
	GetCalendarEvents ml_get_calendar_events.NewGetCalendarEvents
	// Get calendar configuration info.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html
	GetCalendars ml_get_calendars.NewGetCalendars
	// Get anomaly detection job results for categories.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html
	GetCategories ml_get_categories.NewGetCategories
	// Get data frame analytics job configuration info.
	// You can get information for multiple data frame analytics jobs in a single
	// API request by using a comma-separated list of data frame analytics jobs or a
	// wildcard expression.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html
	GetDataFrameAnalytics ml_get_data_frame_analytics.NewGetDataFrameAnalytics
	// Get data frame analytics jobs usage info.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html
	GetDataFrameAnalyticsStats ml_get_data_frame_analytics_stats.NewGetDataFrameAnalyticsStats
	// Get datafeeds usage info.
	// You can get statistics for multiple datafeeds in a single API request by
	// using a comma-separated list of datafeeds or a wildcard expression. You can
	// get statistics for all datafeeds by using `_all`, by specifying `*` as the
	// `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the
	// only information you receive is the `datafeed_id` and the `state`.
	// This API returns a maximum of 10,000 datafeeds.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html
	GetDatafeedStats ml_get_datafeed_stats.NewGetDatafeedStats
	// Get datafeeds configuration info.
	// You can get information for multiple datafeeds in a single API request by
	// using a comma-separated list of datafeeds or a wildcard expression. You can
	// get information for all datafeeds by using `_all`, by specifying `*` as the
	// `<feed_id>`, or by omitting the `<feed_id>`.
	// This API returns a maximum of 10,000 datafeeds.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html
	GetDatafeeds ml_get_datafeeds.NewGetDatafeeds
	// Get filters.
	// You can get a single filter or all filters.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html
	GetFilters ml_get_filters.NewGetFilters
	// Get anomaly detection job results for influencers.
	// Influencers are the entities that have contributed to, or are to blame for,
	// the anomalies. Influencer results are available only if an
	// `influencer_field_name` is specified in the job configuration.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html
	GetInfluencers ml_get_influencers.NewGetInfluencers
	// Get anomaly detection jobs usage info.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html
	GetJobStats ml_get_job_stats.NewGetJobStats
	// Get anomaly detection jobs configuration info.
	// You can get information for multiple anomaly detection jobs in a single API
	// request by using a group name, a comma-separated list of jobs, or a wildcard
	// expression. You can get information for all anomaly detection jobs by using
	// `_all`, by specifying `*` as the `<job_id>`, or by omitting the `<job_id>`.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html
	GetJobs ml_get_jobs.NewGetJobs
	// Get machine learning memory usage info.
	// Get information about how machine learning jobs and trained models are using
	// memory,
	// on each node, both within the JVM heap, and natively, outside of the JVM.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html
	GetMemoryStats ml_get_memory_stats.NewGetMemoryStats
	// Get anomaly detection job model snapshot upgrade usage info.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html
	GetModelSnapshotUpgradeStats ml_get_model_snapshot_upgrade_stats.NewGetModelSnapshotUpgradeStats
	// Get model snapshots info.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html
	GetModelSnapshots ml_get_model_snapshots.NewGetModelSnapshots
	// Get overall bucket results.
	//
	// Retrievs overall bucket results that summarize the bucket results of
	// multiple anomaly detection jobs.
	//
	// The `overall_score` is calculated by combining the scores of all the
	// buckets within the overall bucket span. First, the maximum
	// `anomaly_score` per anomaly detection job in the overall bucket is
	// calculated. Then the `top_n` of those scores are averaged to result in
	// the `overall_score`. This means that you can fine-tune the
	// `overall_score` so that it is more or less sensitive to the number of
	// jobs that detect an anomaly at the same time. For example, if you set
	// `top_n` to `1`, the `overall_score` is the maximum bucket score in the
	// overall bucket. Alternatively, if you set `top_n` to the number of jobs,
	// the `overall_score` is high only when all jobs detect anomalies in that
	// overall bucket. If you set the `bucket_span` parameter (to a value
	// greater than its default), the `overall_score` is the maximum
	// `overall_score` of the overall buckets that have a span equal to the
	// jobs' largest bucket span.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html
	GetOverallBuckets ml_get_overall_buckets.NewGetOverallBuckets
	// Get anomaly records for an anomaly detection job.
	// Records contain the detailed analytical results. They describe the anomalous
	// activity that has been identified in the input data based on the detector
	// configuration.
	// There can be many anomaly records depending on the characteristics and size
	// of the input data. In practice, there are often too many to be able to
	// manually process them. The machine learning features therefore perform a
	// sophisticated aggregation of the anomaly records into buckets.
	// The number of record results depends on the number of anomalies found in each
	// bucket, which relates to the number of time series being modeled and the
	// number of detectors.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html
	GetRecords ml_get_records.NewGetRecords
	// Get trained model configuration info.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html
	GetTrainedModels ml_get_trained_models.NewGetTrainedModels
	// Get trained models usage info.
	// You can get usage information for multiple trained
	// models in a single API request by using a comma-separated list of model IDs
	// or a wildcard expression.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html
	GetTrainedModelsStats ml_get_trained_models_stats.NewGetTrainedModelsStats
	// Evaluate a trained model.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-trained-model.html
	InferTrainedModel ml_infer_trained_model.NewInferTrainedModel
	// Return ML defaults and limits.
	// Returns defaults and limits used by machine learning.
	// This endpoint is designed to be used by a user interface that needs to fully
	// understand machine learning configurations where some options are not
	// specified, meaning that the defaults should be used. This endpoint may be
	// used to find out what those defaults are. It also provides information about
	// the maximum size of machine learning jobs that could run in the current
	// cluster configuration.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html
	Info ml_info.NewInfo
	// Open anomaly detection jobs.
	// An anomaly detection job must be opened to be ready to receive and analyze
	// data. It can be opened and closed multiple times throughout its lifecycle.
	// When you open a new job, it starts with an empty model.
	// When you open an existing job, the most recent model state is automatically
	// loaded. The job is ready to resume its analysis from where it left off, once
	// new data is received.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html
	OpenJob ml_open_job.NewOpenJob
	// Add scheduled events to the calendar.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html
	PostCalendarEvents ml_post_calendar_events.NewPostCalendarEvents
	// Send data to an anomaly detection job for analysis.
	//
	// IMPORTANT: For each job, data can be accepted from only a single connection
	// at a time.
	// It is not currently possible to post data to multiple jobs using wildcards or
	// a comma-separated list.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html
	PostData ml_post_data.NewPostData
	// Preview features used by data frame analytics.
	// Previews the extracted features used by a data frame analytics config.
	// http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html
	PreviewDataFrameAnalytics ml_preview_data_frame_analytics.NewPreviewDataFrameAnalytics
	// Preview a datafeed.
	// This API returns the first "page" of search results from a datafeed.
	// You can preview an existing datafeed or provide configuration details for a
	// datafeed
	// and anomaly detection job in the API. The preview shows the structure of the
	// data
	// that will be passed to the anomaly detection engine.
	// IMPORTANT: When Elasticsearch security features are enabled, the preview uses
	// the credentials of the user that
	// called the API. However, when the datafeed starts it uses the roles of the
	// last user that created or updated the
	// datafeed. To get a preview that accurately reflects the behavior of the
	// datafeed, use the appropriate credentials.
	// You can also use secondary authorization headers to supply the credentials.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html
	PreviewDatafeed ml_preview_datafeed.NewPreviewDatafeed
	// Create a calendar.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html
	PutCalendar ml_put_calendar.NewPutCalendar
	// Add anomaly detection job to calendar.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html
	PutCalendarJob ml_put_calendar_job.NewPutCalendarJob
	// Create a data frame analytics job.
	// This API creates a data frame analytics job that performs an analysis on the
	// source indices and stores the outcome in a destination index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html
	PutDataFrameAnalytics ml_put_data_frame_analytics.NewPutDataFrameAnalytics
	// Create a datafeed.
	// Datafeeds retrieve data from Elasticsearch for analysis by an anomaly
	// detection job.
	// You can associate only one datafeed with each anomaly detection job.
	// The datafeed contains a query that runs at a defined interval (`frequency`).
	// If you are concerned about delayed data, you can add a delay (`query_delay')
	// at each interval.
	// When Elasticsearch security features are enabled, your datafeed remembers
	// which roles the user who created it had
	// at the time of creation and runs the query using those same roles. If you
	// provide secondary authorization headers,
	// those credentials are used instead.
	// You must use Kibana, this API, or the create anomaly detection jobs API to
	// create a datafeed. Do not add a datafeed
	// directly to the `.ml-config` index. Do not give users `write` privileges on
	// the `.ml-config` index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html
	PutDatafeed ml_put_datafeed.NewPutDatafeed
	// Create a filter.
	// A filter contains a list of strings. It can be used by one or more anomaly
	// detection jobs.
	// Specifically, filters are referenced in the `custom_rules` property of
	// detector configuration objects.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html
	PutFilter ml_put_filter.NewPutFilter
	// Create an anomaly detection job.
	// If you include a `datafeed_config`, you must have read index privileges on
	// the source index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html
	PutJob ml_put_job.NewPutJob
	// Create a trained model.
	// Enable you to supply a trained model that is not created by data frame
	// analytics.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html
	PutTrainedModel ml_put_trained_model.NewPutTrainedModel
	// Create or update a trained model alias.
	// A trained model alias is a logical name used to reference a single trained
	// model.
	// You can use aliases instead of trained model identifiers to make it easier to
	// reference your models. For example, you can use aliases in inference
	// aggregations and processors.
	// An alias must be unique and refer to only a single trained model. However,
	// you can have multiple aliases for each trained model.
	// If you use this API to update an alias such that it references a different
	// trained model ID and the model uses a different type of data frame analytics,
	// an error occurs. For example, this situation occurs if you have a trained
	// model for regression analysis and a trained model for classification
	// analysis; you cannot reassign an alias from one type of trained model to
	// another.
	// If you use this API to update an alias and there are very few input fields in
	// common between the old and new trained models for the model alias, the API
	// returns a warning.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html
	PutTrainedModelAlias ml_put_trained_model_alias.NewPutTrainedModelAlias
	// Create part of a trained model definition.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html
	PutTrainedModelDefinitionPart ml_put_trained_model_definition_part.NewPutTrainedModelDefinitionPart
	// Create a trained model vocabulary.
	// This API is supported only for natural language processing (NLP) models.
	// The vocabulary is stored in the index as described in
	// `inference_config.*.vocabulary` of the trained model definition.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html
	PutTrainedModelVocabulary ml_put_trained_model_vocabulary.NewPutTrainedModelVocabulary
	// Reset an anomaly detection job.
	// All model state and results are deleted. The job is ready to start over as if
	// it had just been created.
	// It is not currently possible to reset multiple jobs using wildcards or a
	// comma separated list.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html
	ResetJob ml_reset_job.NewResetJob
	// Revert to a snapshot.
	// The machine learning features react quickly to anomalous input, learning new
	// behaviors in data. Highly anomalous input increases the variance in the
	// models whilst the system learns whether this is a new step-change in behavior
	// or a one-off event. In the case where this anomalous input is known to be a
	// one-off, then it might be appropriate to reset the model state to a time
	// before this event. For example, you might consider reverting to a saved
	// snapshot after Black Friday or a critical system failure.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html
	RevertModelSnapshot ml_revert_model_snapshot.NewRevertModelSnapshot
	// Set upgrade_mode for ML indices.
	// Sets a cluster wide upgrade_mode setting that prepares machine learning
	// indices for an upgrade.
	// When upgrading your cluster, in some circumstances you must restart your
	// nodes and reindex your machine learning indices. In those circumstances,
	// there must be no machine learning jobs running. You can close the machine
	// learning jobs, do the upgrade, then open all the jobs again. Alternatively,
	// you can use this API to temporarily halt tasks associated with the jobs and
	// datafeeds and prevent new jobs from opening. You can also use this API
	// during upgrades that do not require you to reindex your machine learning
	// indices, though stopping jobs is not a requirement in that case.
	// You can see the current value for the upgrade_mode setting by using the get
	// machine learning info API.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html
	SetUpgradeMode ml_set_upgrade_mode.NewSetUpgradeMode
	// Start a data frame analytics job.
	// A data frame analytics job can be started and stopped multiple times
	// throughout its lifecycle.
	// If the destination index does not exist, it is created automatically the
	// first time you start the data frame analytics job. The
	// `index.number_of_shards` and `index.number_of_replicas` settings for the
	// destination index are copied from the source index. If there are multiple
	// source indices, the destination index copies the highest setting values. The
	// mappings for the destination index are also copied from the source indices.
	// If there are any mapping conflicts, the job fails to start.
	// If the destination index exists, it is used as is. You can therefore set up
	// the destination index in advance with custom settings and mappings.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html
	StartDataFrameAnalytics ml_start_data_frame_analytics.NewStartDataFrameAnalytics
	// Start datafeeds.
	//
	// A datafeed must be started in order to retrieve data from Elasticsearch. A
	// datafeed can be started and stopped
	// multiple times throughout its lifecycle.
	//
	// Before you can start a datafeed, the anomaly detection job must be open.
	// Otherwise, an error occurs.
	//
	// If you restart a stopped datafeed, it continues processing input data from
	// the next millisecond after it was stopped.
	// If new data was indexed for that exact millisecond between stopping and
	// starting, it will be ignored.
	//
	// When Elasticsearch security features are enabled, your datafeed remembers
	// which roles the last user to create or
	// update it had at the time of creation or update and runs the query using
	// those same roles. If you provided secondary
	// authorization headers when you created or updated the datafeed, those
	// credentials are used instead.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html
	StartDatafeed ml_start_datafeed.NewStartDatafeed
	// Start a trained model deployment.
	// It allocates the model to every machine learning node.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trained-model-deployment.html
	StartTrainedModelDeployment ml_start_trained_model_deployment.NewStartTrainedModelDeployment
	// Stop data frame analytics jobs.
	// A data frame analytics job can be started and stopped multiple times
	// throughout its lifecycle.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html
	StopDataFrameAnalytics ml_stop_data_frame_analytics.NewStopDataFrameAnalytics
	// Stop datafeeds.
	// A datafeed that is stopped ceases to retrieve data from Elasticsearch. A
	// datafeed can be started and stopped
	// multiple times throughout its lifecycle.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html
	StopDatafeed ml_stop_datafeed.NewStopDatafeed
	// Stop a trained model deployment.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-trained-model-deployment.html
	StopTrainedModelDeployment ml_stop_trained_model_deployment.NewStopTrainedModelDeployment
	// Update a data frame analytics job.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html
	UpdateDataFrameAnalytics ml_update_data_frame_analytics.NewUpdateDataFrameAnalytics
	// Update a datafeed.
	// You must stop and start the datafeed for the changes to be applied.
	// When Elasticsearch security features are enabled, your datafeed remembers
	// which roles the user who updated it had at
	// the time of the update and runs the query using those same roles. If you
	// provide secondary authorization headers,
	// those credentials are used instead.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html
	UpdateDatafeed ml_update_datafeed.NewUpdateDatafeed
	// Update a filter.
	// Updates the description of a filter, adds items, or removes items from the
	// list.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html
	UpdateFilter ml_update_filter.NewUpdateFilter
	// Update an anomaly detection job.
	// Updates certain properties of an anomaly detection job.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html
	UpdateJob ml_update_job.NewUpdateJob
	// Update a snapshot.
	// Updates certain properties of a snapshot.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html
	UpdateModelSnapshot ml_update_model_snapshot.NewUpdateModelSnapshot
	// Update a trained model deployment.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html
	UpdateTrainedModelDeployment ml_update_trained_model_deployment.NewUpdateTrainedModelDeployment
	// Upgrade a snapshot.
	// Upgrades an anomaly detection model snapshot to the latest major version.
	// Over time, older snapshot formats are deprecated and removed. Anomaly
	// detection jobs support only snapshots that are from the current or previous
	// major version.
	// This API provides a means to upgrade a snapshot to the current major version.
	// This aids in preparing the cluster for an upgrade to the next major version.
	// Only one snapshot per anomaly detection job can be upgraded at a time and the
	// upgraded snapshot cannot be the current snapshot of the anomaly detection
	// job.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html
	UpgradeJobSnapshot ml_upgrade_job_snapshot.NewUpgradeJobSnapshot
	// Validates an anomaly detection job.
	// https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html
	Validate ml_validate.NewValidate
	// Validates an anomaly detection detector.
	// https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html
	ValidateDetector ml_validate_detector.NewValidateDetector
}

type Monitoring added in v8.9.0

type Monitoring struct {
	// Used by the monitoring features to send monitoring data.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/monitor-elasticsearch-cluster.html
	Bulk monitoring_bulk.NewBulk
}

type Nodes

type Nodes struct {
	// You can use this API to clear the archived repositories metering information
	// in the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html
	ClearRepositoriesMeteringArchive nodes_clear_repositories_metering_archive.NewClearRepositoriesMeteringArchive
	// You can use the cluster repositories metering API to retrieve repositories
	// metering information in a cluster.
	// This API exposes monotonically non-decreasing counters and it’s expected that
	// clients would durably store the
	// information needed to compute aggregations over a period of time.
	// Additionally, the information exposed by this
	// API is volatile, meaning that it won’t be present after node restarts.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html
	GetRepositoriesMeteringInfo nodes_get_repositories_metering_info.NewGetRepositoriesMeteringInfo
	// This API yields a breakdown of the hot threads on each selected node in the
	// cluster.
	// The output is plain text with a breakdown of each node’s top hot threads.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html
	HotThreads nodes_hot_threads.NewHotThreads
	// Returns cluster nodes information.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html
	Info nodes_info.NewInfo
	// Reloads the keystore on nodes in the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/secure-settings.html#reloadable-secure-settings
	ReloadSecureSettings nodes_reload_secure_settings.NewReloadSecureSettings
	// Returns cluster nodes statistics.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html
	Stats nodes_stats.NewStats
	// Returns information on the usage of features.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-usage.html
	Usage nodes_usage.NewUsage
}

type Profiling added in v8.15.0

type Profiling struct {
	// Extracts a UI-optimized structure to render flamegraphs from Universal
	// Profiling.
	// https://www.elastic.co/guide/en/observability/current/universal-profiling.html
	Flamegraph profiling_flamegraph.NewFlamegraph
	// Extracts raw stacktrace information from Universal Profiling.
	// https://www.elastic.co/guide/en/observability/current/universal-profiling.html
	Stacktraces profiling_stacktraces.NewStacktraces
	// Returns basic information about the status of Universal Profiling.
	// https://www.elastic.co/guide/en/observability/current/universal-profiling.html
	Status profiling_status.NewStatus
	// Extracts a list of topN functions from Universal Profiling.
	// https://www.elastic.co/guide/en/observability/current/universal-profiling.html
	TopnFunctions profiling_topn_functions.NewTopnFunctions
}

type QueryRules added in v8.15.0

type QueryRules struct {
	// Deletes a query rule within a query ruleset.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-query-rule.html
	DeleteRule query_rules_delete_rule.NewDeleteRule
	// Deletes a query ruleset.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-query-ruleset.html
	DeleteRuleset query_rules_delete_ruleset.NewDeleteRuleset
	// Returns the details about a query rule within a query ruleset
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-query-rule.html
	GetRule query_rules_get_rule.NewGetRule
	// Returns the details about a query ruleset
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-query-ruleset.html
	GetRuleset query_rules_get_ruleset.NewGetRuleset
	// Returns summarized information about existing query rulesets.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/list-query-rulesets.html
	ListRulesets query_rules_list_rulesets.NewListRulesets
	// Creates or updates a query rule within a query ruleset.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/put-query-rule.html
	PutRule query_rules_put_rule.NewPutRule
	// Creates or updates a query ruleset.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/put-query-ruleset.html
	PutRuleset query_rules_put_ruleset.NewPutRuleset
	// Creates or updates a query ruleset.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/test-query-ruleset.html
	Test query_rules_test.NewTest
}

type Request added in v8.5.0

type Request interface {
	Perform(ctx context.Context) (*http.Response, error)
}

Request defines the TypedApi requests.

type Rollup

type Rollup struct {
	// Deletes an existing rollup job.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-delete-job.html
	DeleteJob rollup_delete_job.NewDeleteJob
	// Retrieves the configuration, stats, and status of rollup jobs.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-job.html
	GetJobs rollup_get_jobs.NewGetJobs
	// Returns the capabilities of any rollup jobs that have been configured for a
	// specific index or index pattern.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-caps.html
	GetRollupCaps rollup_get_rollup_caps.NewGetRollupCaps
	// Returns the rollup capabilities of all jobs inside of a rollup index (for
	// example, the index where rollup data is stored).
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-index-caps.html
	GetRollupIndexCaps rollup_get_rollup_index_caps.NewGetRollupIndexCaps
	// Creates a rollup job.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-put-job.html
	PutJob rollup_put_job.NewPutJob
	// Enables searching rolled-up data using the standard Query DSL.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-search.html
	RollupSearch rollup_rollup_search.NewRollupSearch
	// Starts an existing, stopped rollup job.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-start-job.html
	StartJob rollup_start_job.NewStartJob
	// Stops an existing, started rollup job.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-stop-job.html
	StopJob rollup_stop_job.NewStopJob
}

type SearchApplication added in v8.8.0

type SearchApplication struct {
	// Delete a search application.
	// Remove a search application and its associated alias. Indices attached to the
	// search application are not removed.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-search-application.html
	Delete search_application_delete.NewDelete
	// Delete a behavioral analytics collection.
	// The associated data stream is also deleted.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-analytics-collection.html
	DeleteBehavioralAnalytics search_application_delete_behavioral_analytics.NewDeleteBehavioralAnalytics
	// Get search application details.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-search-application.html
	Get search_application_get.NewGet
	// Get behavioral analytics collections.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/list-analytics-collection.html
	GetBehavioralAnalytics search_application_get_behavioral_analytics.NewGetBehavioralAnalytics
	// Returns the existing search applications.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/list-search-applications.html
	List search_application_list.NewList
	// Create or update a search application.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/put-search-application.html
	Put search_application_put.NewPut
	// Create a behavioral analytics collection.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/put-analytics-collection.html
	PutBehavioralAnalytics search_application_put_behavioral_analytics.NewPutBehavioralAnalytics
	// Run a search application search.
	// Generate and run an Elasticsearch query that uses the specified query
	// parameteter and the search template associated with the search application or
	// default template.
	// Unspecified template parameters are assigned their default values if
	// applicable.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/search-application-search.html
	Search search_application_search.NewSearch
}

type Security

type Security struct {
	// Activate a user profile.
	//
	// Create or update a user profile on behalf of another user.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html
	ActivateUserProfile security_activate_user_profile.NewActivateUserProfile
	// Authenticate a user.
	//
	// Authenticates a user and returns information about the authenticated user.
	// Include the user information in a [basic auth
	// header](https://en.wikipedia.org/wiki/Basic_access_authentication).
	// A successful call returns a JSON structure that shows user information such
	// as their username, the roles that are assigned to the user, any assigned
	// metadata, and information about the realms that authenticated and authorized
	// the user.
	// If the user cannot be authenticated, this API returns a 401 status code.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html
	Authenticate security_authenticate.NewAuthenticate
	// Bulk delete roles.
	//
	// The role management APIs are generally the preferred way to manage roles,
	// rather than using file-based role management.
	// The bulk delete roles API cannot delete roles that are defined in roles
	// files.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-delete-role.html
	BulkDeleteRole security_bulk_delete_role.NewBulkDeleteRole
	// Bulk create or update roles.
	//
	// The role management APIs are generally the preferred way to manage roles,
	// rather than using file-based role management.
	// The bulk create or update roles API cannot update roles that are defined in
	// roles files.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-put-role.html
	BulkPutRole security_bulk_put_role.NewBulkPutRole
	// Updates the attributes of multiple existing API keys.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html
	BulkUpdateApiKeys security_bulk_update_api_keys.NewBulkUpdateApiKeys
	// Change passwords.
	//
	// Change the passwords of users in the native realm and built-in users.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html
	ChangePassword security_change_password.NewChangePassword
	// Clear the API key cache.
	//
	// Evict a subset of all entries from the API key cache.
	// The cache is also automatically cleared on state changes of the security
	// index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html
	ClearApiKeyCache security_clear_api_key_cache.NewClearApiKeyCache
	// Clear the privileges cache.
	//
	// Evict privileges from the native application privilege cache.
	// The cache is also automatically cleared for applications that have their
	// privileges updated.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html
	ClearCachedPrivileges security_clear_cached_privileges.NewClearCachedPrivileges
	// Clear the user cache.
	//
	// Evict users from the user cache. You can completely clear the cache or evict
	// specific users.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html
	ClearCachedRealms security_clear_cached_realms.NewClearCachedRealms
	// Clear the roles cache.
	//
	// Evict roles from the native role cache.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html
	ClearCachedRoles security_clear_cached_roles.NewClearCachedRoles
	// Clear service account token caches.
	//
	// Evict a subset of all entries from the service account token caches.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html
	ClearCachedServiceTokens security_clear_cached_service_tokens.NewClearCachedServiceTokens
	// Create an API key.
	//
	// Create an API key for access without requiring basic authentication.
	// A successful request returns a JSON structure that contains the API key, its
	// unique id, and its name.
	// If applicable, it also returns expiration information for the API key in
	// milliseconds.
	// NOTE: By default, API keys never expire. You can specify expiration
	// information when you create the API keys.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
	CreateApiKey security_create_api_key.NewCreateApiKey
	// Creates a cross-cluster API key for API key based remote cluster access.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html
	CreateCrossClusterApiKey security_create_cross_cluster_api_key.NewCreateCrossClusterApiKey
	// Create a service account token.
	//
	// Create a service accounts token for access without requiring basic
	// authentication.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html
	CreateServiceToken security_create_service_token.NewCreateServiceToken
	// Delete application privileges.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html
	DeletePrivileges security_delete_privileges.NewDeletePrivileges
	// Delete roles.
	//
	// Delete roles in the native realm.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html
	DeleteRole security_delete_role.NewDeleteRole
	// Delete role mappings.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html
	DeleteRoleMapping security_delete_role_mapping.NewDeleteRoleMapping
	// Delete service account tokens.
	//
	// Delete service account tokens for a service in a specified namespace.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html
	DeleteServiceToken security_delete_service_token.NewDeleteServiceToken
	// Delete users.
	//
	// Delete users from the native realm.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html
	DeleteUser security_delete_user.NewDeleteUser
	// Disable users.
	//
	// Disable users in the native realm.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html
	DisableUser security_disable_user.NewDisableUser
	// Disable a user profile.
	//
	// Disable user profiles so that they are not visible in user profile searches.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user-profile.html
	DisableUserProfile security_disable_user_profile.NewDisableUserProfile
	// Enable users.
	//
	// Enable users in the native realm.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html
	EnableUser security_enable_user.NewEnableUser
	// Enable a user profile.
	//
	// Enable user profiles to make them visible in user profile searches.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user-profile.html
	EnableUserProfile security_enable_user_profile.NewEnableUserProfile
	// Enroll Kibana.
	//
	// Enable a Kibana instance to configure itself for communication with a secured
	// Elasticsearch cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-kibana-enrollment.html
	EnrollKibana security_enroll_kibana.NewEnrollKibana
	// Enroll a node.
	//
	// Enroll a new node to allow it to join an existing cluster with security
	// features enabled.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-node-enrollment.html
	EnrollNode security_enroll_node.NewEnrollNode
	// Get API key information.
	//
	// Retrieves information for one or more API keys.
	// NOTE: If you have only the `manage_own_api_key` privilege, this API returns
	// only the API keys that you own.
	// If you have `read_security`, `manage_api_key` or greater privileges
	// (including `manage_security`), this API returns all API keys regardless of
	// ownership.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html
	GetApiKey security_get_api_key.NewGetApiKey
	// Get builtin privileges.
	//
	// Get the list of cluster privileges and index privileges that are available in
	// this version of Elasticsearch.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html
	GetBuiltinPrivileges security_get_builtin_privileges.NewGetBuiltinPrivileges
	// Get application privileges.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html
	GetPrivileges security_get_privileges.NewGetPrivileges
	// Get roles.
	//
	// Get roles in the native realm.
	// The role management APIs are generally the preferred way to manage roles,
	// rather than using file-based role management.
	// The get roles API cannot retrieve roles that are defined in roles files.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html
	GetRole security_get_role.NewGetRole
	// Get role mappings.
	//
	// Role mappings define which roles are assigned to each user.
	// The role mapping APIs are generally the preferred way to manage role mappings
	// rather than using role mapping files.
	// The get role mappings API cannot retrieve role mappings that are defined in
	// role mapping files.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html
	GetRoleMapping security_get_role_mapping.NewGetRoleMapping
	// Get service accounts.
	//
	// Get a list of service accounts that match the provided path parameters.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html
	GetServiceAccounts security_get_service_accounts.NewGetServiceAccounts
	// Get service account credentials.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html
	GetServiceCredentials security_get_service_credentials.NewGetServiceCredentials
	// Retrieve settings for the security system indices
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html
	GetSettings security_get_settings.NewGetSettings
	// Get a token.
	//
	// Create a bearer token for access without requiring basic authentication.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html
	GetToken security_get_token.NewGetToken
	// Get users.
	//
	// Get information about users in the native realm and built-in users.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html
	GetUser security_get_user.NewGetUser
	// Get user privileges.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html
	GetUserPrivileges security_get_user_privileges.NewGetUserPrivileges
	// Get a user profile.
	//
	// Get a user's profile using the unique profile ID.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html
	GetUserProfile security_get_user_profile.NewGetUserProfile
	// Grant an API key.
	//
	// Create an API key on behalf of another user.
	// This API is similar to the create API keys API, however it creates the API
	// key for a user that is different than the user that runs the API.
	// The caller must have authentication credentials (either an access token, or a
	// username and password) for the user on whose behalf the API key will be
	// created.
	// It is not possible to use this API to create an API key without that user’s
	// credentials.
	// The user, for whom the authentication credentials is provided, can optionally
	// "run as" (impersonate) another user.
	// In this case, the API key will be created on behalf of the impersonated user.
	//
	// This API is intended be used by applications that need to create and manage
	// API keys for end users, but cannot guarantee that those users have permission
	// to create API keys on their own behalf.
	//
	// A successful grant API key API call returns a JSON structure that contains
	// the API key, its unique id, and its name.
	// If applicable, it also returns expiration information for the API key in
	// milliseconds.
	//
	// By default, API keys never expire. You can specify expiration information
	// when you create the API keys.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html
	GrantApiKey security_grant_api_key.NewGrantApiKey
	// Check user privileges.
	//
	// Determine whether the specified user has a specified list of privileges.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html
	HasPrivileges security_has_privileges.NewHasPrivileges
	// Check user profile privileges.
	//
	// Determine whether the users associated with the specified user profile IDs
	// have all the requested privileges.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html
	HasPrivilegesUserProfile security_has_privileges_user_profile.NewHasPrivilegesUserProfile
	// Invalidate API keys.
	//
	// This API invalidates API keys created by the create API key or grant API key
	// APIs.
	// Invalidated API keys fail authentication, but they can still be viewed using
	// the get API key information and query API key information APIs, for at least
	// the configured retention period, until they are automatically deleted.
	// The `manage_api_key` privilege allows deleting any API keys.
	// The `manage_own_api_key` only allows deleting API keys that are owned by the
	// user.
	// In addition, with the `manage_own_api_key` privilege, an invalidation request
	// must be issued in one of the three formats:
	// - Set the parameter `owner=true`.
	// - Or, set both `username` and `realm_name` to match the user’s identity.
	// - Or, if the request is issued by an API key, that is to say an API key
	// invalidates itself, specify its ID in the `ids` field.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html
	InvalidateApiKey security_invalidate_api_key.NewInvalidateApiKey
	// Invalidate a token.
	//
	// The access tokens returned by the get token API have a finite period of time
	// for which they are valid.
	// After that time period, they can no longer be used.
	// The time period is defined by the `xpack.security.authc.token.timeout`
	// setting.
	//
	// The refresh tokens returned by the get token API are only valid for 24 hours.
	// They can also be used exactly once.
	// If you want to invalidate one or more access or refresh tokens immediately,
	// use this invalidate token API.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html
	InvalidateToken security_invalidate_token.NewInvalidateToken
	// Exchanges an OpenID Connection authentication response message for an
	// Elasticsearch access token and refresh token pair
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-authenticate.html
	OidcAuthenticate security_oidc_authenticate.NewOidcAuthenticate
	// Invalidates a refresh token and access token that was generated from the
	// OpenID Connect Authenticate API
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-logout.html
	OidcLogout security_oidc_logout.NewOidcLogout
	// Creates an OAuth 2.0 authentication request as a URL string
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-prepare-authentication.html
	OidcPrepareAuthentication security_oidc_prepare_authentication.NewOidcPrepareAuthentication
	// Create or update application privileges.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html
	PutPrivileges security_put_privileges.NewPutPrivileges
	// Create or update roles.
	//
	// The role management APIs are generally the preferred way to manage roles in
	// the native realm, rather than using file-based role management.
	// The create or update roles API cannot update roles that are defined in roles
	// files.
	// File-based role management is not available in Elastic Serverless.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html
	PutRole security_put_role.NewPutRole
	// Create or update role mappings.
	//
	// Role mappings define which roles are assigned to each user.
	// Each mapping has rules that identify users and a list of roles that are
	// granted to those users.
	// The role mapping APIs are generally the preferred way to manage role mappings
	// rather than using role mapping files. The create or update role mappings API
	// cannot update role mappings that are defined in role mapping files.
	//
	// This API does not create roles. Rather, it maps users to existing roles.
	// Roles can be created by using the create or update roles API or roles files.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html
	PutRoleMapping security_put_role_mapping.NewPutRoleMapping
	// Create or update users.
	//
	// A password is required for adding a new user but is optional when updating an
	// existing user.
	// To change a user’s password without updating any other fields, use the change
	// password API.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html
	PutUser security_put_user.NewPutUser
	// Find API keys with a query.
	//
	// Get a paginated list of API keys and their information. You can optionally
	// filter the results with a query.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html
	QueryApiKeys security_query_api_keys.NewQueryApiKeys
	// Find roles with a query.
	//
	// Get roles in a paginated manner. You can optionally filter the results with a
	// query.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html
	QueryRole security_query_role.NewQueryRole
	// Find users with a query.
	//
	// Get information for users in a paginated manner.
	// You can optionally filter the results with a query.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html
	QueryUser security_query_user.NewQueryUser
	// Authenticate SAML.
	//
	// Submits a SAML response message to Elasticsearch for consumption.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html
	SamlAuthenticate security_saml_authenticate.NewSamlAuthenticate
	// Logout of SAML completely.
	//
	// Verifies the logout response sent from the SAML IdP.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html
	SamlCompleteLogout security_saml_complete_logout.NewSamlCompleteLogout
	// Invalidate SAML.
	//
	// Submits a SAML LogoutRequest message to Elasticsearch for consumption.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html
	SamlInvalidate security_saml_invalidate.NewSamlInvalidate
	// Logout of SAML.
	//
	// Submits a request to invalidate an access token and refresh token.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html
	SamlLogout security_saml_logout.NewSamlLogout
	// Prepare SAML authentication.
	//
	// Creates a SAML authentication request (`<AuthnRequest>`) as a URL string,
	// based on the configuration of the respective SAML realm in Elasticsearch.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html
	SamlPrepareAuthentication security_saml_prepare_authentication.NewSamlPrepareAuthentication
	// Create SAML service provider metadata.
	//
	// Generate SAML metadata for a SAML 2.0 Service Provider.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html
	SamlServiceProviderMetadata security_saml_service_provider_metadata.NewSamlServiceProviderMetadata
	// Suggest a user profile.
	//
	// Get suggestions for user profiles that match specified search criteria.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-suggest-user-profile.html
	SuggestUserProfiles security_suggest_user_profiles.NewSuggestUserProfiles
	// Update an API key.
	//
	// Updates attributes of an existing API key.
	// Users can only update API keys that they created or that were granted to
	// them.
	// Use this API to update API keys created by the create API Key or grant API
	// Key APIs.
	// If you need to apply the same update to many API keys, you can use bulk
	// update API Keys to reduce overhead.
	// It’s not possible to update expired API keys, or API keys that have been
	// invalidated by invalidate API Key.
	// This API supports updates to an API key’s access scope and metadata.
	// The access scope of an API key is derived from the `role_descriptors` you
	// specify in the request, and a snapshot of the owner user’s permissions at the
	// time of the request.
	// The snapshot of the owner’s permissions is updated automatically on every
	// call.
	// If you don’t specify `role_descriptors` in the request, a call to this API
	// might still change the API key’s access scope.
	// This change can occur if the owner user’s permissions have changed since the
	// API key was created or last modified.
	// To update another user’s API key, use the `run_as` feature to submit a
	// request on behalf of another user.
	// IMPORTANT: It’s not possible to use an API key as the authentication
	// credential for this API.
	// To update an API key, the owner user’s credentials are required.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html
	UpdateApiKey security_update_api_key.NewUpdateApiKey
	// Update settings for the security system index
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html
	UpdateSettings security_update_settings.NewUpdateSettings
	// Update user profile data.
	//
	// Update specific data for the user profile that is associated with a unique
	// ID.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html
	UpdateUserProfileData security_update_user_profile_data.NewUpdateUserProfileData
}

type Shutdown

type Shutdown struct {
	// Removes a node from the shutdown list. Designed for indirect use by ECE/ESS
	// and ECK. Direct use is not supported.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current
	DeleteNode shutdown_delete_node.NewDeleteNode
	// Retrieve status of a node or nodes that are currently marked as shutting
	// down. Designed for indirect use by ECE/ESS and ECK. Direct use is not
	// supported.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current
	GetNode shutdown_get_node.NewGetNode
	// Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK.
	// Direct use is not supported.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current
	PutNode shutdown_put_node.NewPutNode
}

type Slm

type Slm struct {
	// Deletes an existing snapshot lifecycle policy.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html
	DeleteLifecycle slm_delete_lifecycle.NewDeleteLifecycle
	// Immediately creates a snapshot according to the lifecycle policy, without
	// waiting for the scheduled time.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html
	ExecuteLifecycle slm_execute_lifecycle.NewExecuteLifecycle
	// Deletes any snapshots that are expired according to the policy's retention
	// rules.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html
	ExecuteRetention slm_execute_retention.NewExecuteRetention
	// Retrieves one or more snapshot lifecycle policy definitions and information
	// about the latest snapshot attempts.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html
	GetLifecycle slm_get_lifecycle.NewGetLifecycle
	// Returns global and policy-level statistics about actions taken by snapshot
	// lifecycle management.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-stats.html
	GetStats slm_get_stats.NewGetStats
	// Retrieves the status of snapshot lifecycle management (SLM).
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html
	GetStatus slm_get_status.NewGetStatus
	// Creates or updates a snapshot lifecycle policy.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html
	PutLifecycle slm_put_lifecycle.NewPutLifecycle
	// Turns on snapshot lifecycle management (SLM).
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html
	Start slm_start.NewStart
	// Turns off snapshot lifecycle management (SLM).
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html
	Stop slm_stop.NewStop
}

type Snapshot

type Snapshot struct {
	// Triggers the review of a snapshot repository’s contents and deletes any stale
	// data not referenced by existing snapshots.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/clean-up-snapshot-repo-api.html
	CleanupRepository snapshot_cleanup_repository.NewCleanupRepository
	// Clones indices from one snapshot into another snapshot in the same
	// repository.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
	Clone snapshot_clone.NewClone
	// Creates a snapshot in a repository.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
	Create snapshot_create.NewCreate
	// Creates a repository.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
	CreateRepository snapshot_create_repository.NewCreateRepository
	// Deletes one or more snapshots.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
	Delete snapshot_delete.NewDelete
	// Deletes a repository.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
	DeleteRepository snapshot_delete_repository.NewDeleteRepository
	// Returns information about a snapshot.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
	Get snapshot_get.NewGet
	// Returns information about a repository.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
	GetRepository snapshot_get_repository.NewGetRepository
	// Verifies the integrity of the contents of a snapshot repository
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
	RepositoryVerifyIntegrity snapshot_repository_verify_integrity.NewRepositoryVerifyIntegrity
	// Restores a snapshot.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
	Restore snapshot_restore.NewRestore
	// Returns information about the status of a snapshot.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
	Status snapshot_status.NewStatus
	// Verifies a repository.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html
	VerifyRepository snapshot_verify_repository.NewVerifyRepository
}

type Sql

type Sql struct {
	// Clears the SQL cursor
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html
	ClearCursor sql_clear_cursor.NewClearCursor
	// Deletes an async SQL search or a stored synchronous SQL search. If the search
	// is still running, the API cancels it.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-async-sql-search-api.html
	DeleteAsync sql_delete_async.NewDeleteAsync
	// Returns the current status and available results for an async SQL search or
	// stored synchronous SQL search
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-sql-search-api.html
	GetAsync sql_get_async.NewGetAsync
	// Returns the current status of an async SQL search or a stored synchronous SQL
	// search
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-sql-search-status-api.html
	GetAsyncStatus sql_get_async_status.NewGetAsyncStatus
	// Executes a SQL request
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html
	Query sql_query.NewQuery
	// Translates SQL into Elasticsearch queries
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html
	Translate sql_translate.NewTranslate
}

type Ssl

type Ssl struct {
	// Get SSL certificates.
	//
	// Get information about the X.509 certificates that are used to encrypt
	// communications in the cluster.
	// The API returns a list that includes certificates from all TLS contexts
	// including:
	//
	// - Settings for transport and HTTP interfaces
	// - TLS settings that are used within authentication realms
	// - TLS settings for remote monitoring exporters
	//
	// The list includes certificates that are used for configuring trust, such as
	// those configured in the `xpack.security.transport.ssl.truststore` and
	// `xpack.security.transport.ssl.certificate_authorities` settings.
	// It also includes certificates that are used for configuring server identity,
	// such as `xpack.security.http.ssl.keystore` and
	// `xpack.security.http.ssl.certificate settings`.
	//
	// The list does not include certificates that are sourced from the default SSL
	// context of the Java Runtime Environment (JRE), even if those certificates are
	// in use within Elasticsearch.
	//
	// NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the
	// API returns all the certificates that are included in the PKCS#11 token
	// irrespective of whether these are used in the Elasticsearch TLS
	// configuration.
	//
	// If Elasticsearch is configured to use a keystore or truststore, the API
	// output includes all certificates in that store, even though some of the
	// certificates might not be in active use within the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html
	Certificates ssl_certificates.NewCertificates
}

type Tasks

type Tasks struct {
	// Cancels a task, if it can be cancelled through an API.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
	Cancel tasks_cancel.NewCancel
	// Get task information.
	// Returns information about the tasks currently executing in the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
	Get tasks_get.NewGet
	// The task management API returns information about tasks currently executing
	// on one or more nodes in the cluster.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
	List tasks_list.NewList
}

type TextStructure added in v8.9.0

type TextStructure struct {
	// Finds the structure of a text field in an index.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/find-field-structure.html
	FindFieldStructure text_structure_find_field_structure.NewFindFieldStructure
	// Finds the structure of a list of messages. The messages must contain data
	// that is suitable to be ingested into Elasticsearch.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/find-message-structure.html
	FindMessageStructure text_structure_find_message_structure.NewFindMessageStructure
	// Finds the structure of a text file. The text file must contain data that is
	// suitable to be ingested into Elasticsearch.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html
	FindStructure text_structure_find_structure.NewFindStructure
	// Tests a Grok pattern on some text.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/test-grok-pattern.html
	TestGrokPattern text_structure_test_grok_pattern.NewTestGrokPattern
}

type Transform

type Transform struct {
	// Delete a transform.
	// Deletes a transform.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html
	DeleteTransform transform_delete_transform.NewDeleteTransform
	// Retrieves transform usage information for transform nodes.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-node-stats.html
	GetNodeStats transform_get_node_stats.NewGetNodeStats
	// Get transforms.
	// Retrieves configuration information for transforms.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html
	GetTransform transform_get_transform.NewGetTransform
	// Get transform stats.
	// Retrieves usage information for transforms.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html
	GetTransformStats transform_get_transform_stats.NewGetTransformStats
	// Preview a transform.
	// Generates a preview of the results that you will get when you create a
	// transform with the same configuration.
	//
	// It returns a maximum of 100 results. The calculations are based on all the
	// current data in the source index. It also
	// generates a list of mappings and settings for the destination index. These
	// values are determined based on the field
	// types of the source index and the transform aggregations.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html
	PreviewTransform transform_preview_transform.NewPreviewTransform
	// Create a transform.
	// Creates a transform.
	//
	// A transform copies data from source indices, transforms it, and persists it
	// into an entity-centric destination index. You can also think of the
	// destination index as a two-dimensional tabular data structure (known as
	// a data frame). The ID for each document in the data frame is generated from a
	// hash of the entity, so there is a
	// unique row per entity.
	//
	// You must choose either the latest or pivot method for your transform; you
	// cannot use both in a single transform. If
	// you choose to use the pivot method for your transform, the entities are
	// defined by the set of `group_by` fields in
	// the pivot object. If you choose to use the latest method, the entities are
	// defined by the `unique_key` field values
	// in the latest object.
	//
	// You must have `create_index`, `index`, and `read` privileges on the
	// destination index and `read` and
	// `view_index_metadata` privileges on the source indices. When Elasticsearch
	// security features are enabled, the
	// transform remembers which roles the user that created it had at the time of
	// creation and uses those same roles. If
	// those roles do not have the required privileges on the source and destination
	// indices, the transform fails when it
	// attempts unauthorized operations.
	//
	// NOTE: You must use Kibana or this API to create a transform. Do not add a
	// transform directly into any
	// `.transform-internal*` indices using the Elasticsearch index API. If
	// Elasticsearch security features are enabled, do
	// not give users any privileges on `.transform-internal*` indices. If you used
	// transforms prior to 7.5, also do not
	// give users any privileges on `.data-frame-internal*` indices.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html
	PutTransform transform_put_transform.NewPutTransform
	// Reset a transform.
	// Resets a transform.
	// Before you can reset it, you must stop it; alternatively, use the `force`
	// query parameter.
	// If the destination index was created by the transform, it is deleted.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html
	ResetTransform transform_reset_transform.NewResetTransform
	// Schedule a transform to start now.
	// Instantly runs a transform to process data.
	//
	// If you _schedule_now a transform, it will process the new data instantly,
	// without waiting for the configured frequency interval. After _schedule_now
	// API is called,
	// the transform will be processed again at now + frequency unless _schedule_now
	// API
	// is called again in the meantime.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html
	ScheduleNowTransform transform_schedule_now_transform.NewScheduleNowTransform
	// Start a transform.
	// Starts a transform.
	//
	// When you start a transform, it creates the destination index if it does not
	// already exist. The `number_of_shards` is
	// set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot
	// transform, it deduces the mapping
	// definitions for the destination index from the source indices and the
	// transform aggregations. If fields in the
	// destination index are derived from scripts (as in the case of
	// `scripted_metric` or `bucket_script` aggregations),
	// the transform uses dynamic mappings unless an index template exists. If it is
	// a latest transform, it does not deduce
	// mapping definitions; it uses dynamic mappings. To use explicit mappings,
	// create the destination index before you
	// start the transform. Alternatively, you can create an index template, though
	// it does not affect the deduced mappings
	// in a pivot transform.
	//
	// When the transform starts, a series of validations occur to ensure its
	// success. If you deferred validation when you
	// created the transform, they occur when you start the transform—​with the
	// exception of privilege checks. When
	// Elasticsearch security features are enabled, the transform remembers which
	// roles the user that created it had at the
	// time of creation and uses those same roles. If those roles do not have the
	// required privileges on the source and
	// destination indices, the transform fails when it attempts unauthorized
	// operations.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html
	StartTransform transform_start_transform.NewStartTransform
	// Stop transforms.
	// Stops one or more transforms.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html
	StopTransform transform_stop_transform.NewStopTransform
	// Update a transform.
	// Updates certain properties of a transform.
	//
	// All updated properties except `description` do not take effect until after
	// the transform starts the next checkpoint,
	// thus there is data consistency in each checkpoint. To use this API, you must
	// have `read` and `view_index_metadata`
	// privileges for the source indices. You must also have `index` and `read`
	// privileges for the destination index. When
	// Elasticsearch security features are enabled, the transform remembers which
	// roles the user who updated it had at the
	// time of update and runs with those privileges.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html
	UpdateTransform transform_update_transform.NewUpdateTransform
	// Upgrades all transforms.
	// This API identifies transforms that have a legacy configuration format and
	// upgrades them to the latest version. It
	// also cleans up the internal data structures that store the transform state
	// and checkpoints. The upgrade does not
	// affect the source and destination indices. The upgrade also does not affect
	// the roles that transforms use when
	// Elasticsearch security features are enabled; the role used to read source
	// data and write to the destination index
	// remains unchanged.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html
	UpgradeTransforms transform_upgrade_transforms.NewUpgradeTransforms
}

type Watcher

type Watcher struct {
	// Acknowledges a watch, manually throttling the execution of the watch's
	// actions.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html
	AckWatch watcher_ack_watch.NewAckWatch
	// Activates a currently inactive watch.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html
	ActivateWatch watcher_activate_watch.NewActivateWatch
	// Deactivates a currently active watch.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html
	DeactivateWatch watcher_deactivate_watch.NewDeactivateWatch
	// Removes a watch from Watcher.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html
	DeleteWatch watcher_delete_watch.NewDeleteWatch
	// This API can be used to force execution of the watch outside of its
	// triggering logic or to simulate the watch execution for debugging purposes.
	// For testing and debugging purposes, you also have fine-grained control on how
	// the watch runs. You can execute the watch without executing all of its
	// actions or alternatively by simulating them. You can also force execution by
	// ignoring the watch condition and control whether a watch record would be
	// written to the watch history after execution.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html
	ExecuteWatch watcher_execute_watch.NewExecuteWatch
	// Retrieve settings for the watcher system index
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-settings.html
	GetSettings watcher_get_settings.NewGetSettings
	// Retrieves a watch by its ID.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html
	GetWatch watcher_get_watch.NewGetWatch
	// Creates a new watch, or updates an existing one.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html
	PutWatch watcher_put_watch.NewPutWatch
	// Retrieves stored watches.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html
	QueryWatches watcher_query_watches.NewQueryWatches
	// Starts Watcher if it is not already running.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html
	Start watcher_start.NewStart
	// Retrieves the current Watcher metrics.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html
	Stats watcher_stats.NewStats
	// Stops Watcher if it is running.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html
	Stop watcher_stop.NewStop
	// Update settings for the watcher system index
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-update-settings.html
	UpdateSettings watcher_update_settings.NewUpdateSettings
}

type Xpack

type Xpack struct {
	// Provides general information about the installed X-Pack features.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html
	Info xpack_info.NewInfo
	// This API provides information about which features are currently enabled and
	// available under the current license and some usage statistics.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html
	Usage xpack_usage.NewUsage
}

Directories

Path Synopsis
asyncsearch
delete
Delete an async search.
Delete an async search.
get
Get async search results.
Get async search results.
status
Get the async search status.
Get the async search status.
submit
Run an async search.
Run an async search.
autoscaling
deleteautoscalingpolicy
Delete an autoscaling policy.
Delete an autoscaling policy.
getautoscalingcapacity
Get the autoscaling capacity.
Get the autoscaling capacity.
getautoscalingpolicy
Get an autoscaling policy.
Get an autoscaling policy.
putautoscalingpolicy
Create or update an autoscaling policy.
Create or update an autoscaling policy.
Checks if the specified combination of method, API, parameters, and arbitrary capabilities are supported
Checks if the specified combination of method, API, parameters, and arbitrary capabilities are supported
cat
aliases
Get aliases.
Get aliases.
allocation
Provides a snapshot of the number of shards allocated to each data node and their disk space.
Provides a snapshot of the number of shards allocated to each data node and their disk space.
componenttemplates
Get component templates.
Get component templates.
count
Get a document count.
Get a document count.
fielddata
Returns the amount of heap memory currently used by the field data cache on every data node in the cluster.
Returns the amount of heap memory currently used by the field data cache on every data node in the cluster.
health
Returns the health status of a cluster, similar to the cluster health API.
Returns the health status of a cluster, similar to the cluster health API.
help
Get CAT help.
Get CAT help.
indices
Get index information.
Get index information.
master
Returns information about the master node, including the ID, bound IP address, and name.
Returns information about the master node, including the ID, bound IP address, and name.
mldatafeeds
Get datafeeds.
Get datafeeds.
mldataframeanalytics
Get data frame analytics jobs.
Get data frame analytics jobs.
mljobs
Get anomaly detection jobs.
Get anomaly detection jobs.
mltrainedmodels
Get trained models.
Get trained models.
nodeattrs
Returns information about custom node attributes.
Returns information about custom node attributes.
nodes
Returns information about the nodes in a cluster.
Returns information about the nodes in a cluster.
pendingtasks
Returns cluster-level changes that have not yet been executed.
Returns cluster-level changes that have not yet been executed.
plugins
Returns a list of plugins running on each node of a cluster.
Returns a list of plugins running on each node of a cluster.
recovery
Returns information about ongoing and completed shard recoveries.
Returns information about ongoing and completed shard recoveries.
repositories
Returns the snapshot repositories for a cluster.
Returns the snapshot repositories for a cluster.
segments
Returns low-level information about the Lucene segments in index shards.
Returns low-level information about the Lucene segments in index shards.
shards
Returns information about the shards in a cluster.
Returns information about the shards in a cluster.
snapshots
Returns information about the snapshots stored in one or more repositories.
Returns information about the snapshots stored in one or more repositories.
tasks
Returns information about tasks currently executing in the cluster.
Returns information about tasks currently executing in the cluster.
templates
Returns information about index templates in a cluster.
Returns information about index templates in a cluster.
threadpool
Returns thread pool statistics for each node in a cluster.
Returns thread pool statistics for each node in a cluster.
transforms
Get transforms.
Get transforms.
ccr
deleteautofollowpattern
Deletes auto-follow patterns.
Deletes auto-follow patterns.
follow
Creates a new follower index configured to follow the referenced leader index.
Creates a new follower index configured to follow the referenced leader index.
followinfo
Retrieves information about all follower indices, including parameters and status for each follower index
Retrieves information about all follower indices, including parameters and status for each follower index
followstats
Retrieves follower stats.
Retrieves follower stats.
forgetfollower
Removes the follower retention leases from the leader.
Removes the follower retention leases from the leader.
getautofollowpattern
Gets configured auto-follow patterns.
Gets configured auto-follow patterns.
pauseautofollowpattern
Pauses an auto-follow pattern
Pauses an auto-follow pattern
pausefollow
Pauses a follower index.
Pauses a follower index.
putautofollowpattern
Creates a new named collection of auto-follow patterns against a specified remote cluster.
Creates a new named collection of auto-follow patterns against a specified remote cluster.
resumeautofollowpattern
Resumes an auto-follow pattern that has been paused
Resumes an auto-follow pattern that has been paused
resumefollow
Resumes a follower index that has been paused
Resumes a follower index that has been paused
stats
Gets all stats related to cross-cluster replication.
Gets all stats related to cross-cluster replication.
unfollow
Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.
Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.
cluster
allocationexplain
Provides explanations for shard allocations in the cluster.
Provides explanations for shard allocations in the cluster.
deletecomponenttemplate
Delete component templates.
Delete component templates.
deletevotingconfigexclusions
Clears cluster voting config exclusions.
Clears cluster voting config exclusions.
existscomponenttemplate
Check component templates.
Check component templates.
getcomponenttemplate
Get component templates.
Get component templates.
getsettings
Returns cluster-wide settings.
Returns cluster-wide settings.
health
The cluster health API returns a simple status on the health of the cluster.
The cluster health API returns a simple status on the health of the cluster.
info
Get cluster info.
Get cluster info.
pendingtasks
Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
postvotingconfigexclusions
Updates the cluster voting config exclusions by node ids or node names.
Updates the cluster voting config exclusions by node ids or node names.
putcomponenttemplate
Create or update a component template.
Create or update a component template.
putsettings
Updates the cluster settings.
Updates the cluster settings.
remoteinfo
The cluster remote info API allows you to retrieve all of the configured remote cluster information.
The cluster remote info API allows you to retrieve all of the configured remote cluster information.
reroute
Allows to manually change the allocation of individual shards in the cluster.
Allows to manually change the allocation of individual shards in the cluster.
state
Returns a comprehensive information about the state of the cluster.
Returns a comprehensive information about the state of the cluster.
stats
Returns cluster statistics.
Returns cluster statistics.
connector
checkin
Check in a connector.
Check in a connector.
delete
Delete a connector.
Delete a connector.
get
Get a connector.
Get a connector.
lastsync
Update the connector last sync stats.
Update the connector last sync stats.
list
Get all connectors.
Get all connectors.
post
Create a connector.
Create a connector.
put
Create or update a connector.
Create or update a connector.
secretpost
Creates a secret for a Connector.
Creates a secret for a Connector.
syncjobcancel
Cancel a connector sync job.
Cancel a connector sync job.
syncjobdelete
Delete a connector sync job.
Delete a connector sync job.
syncjobget
Get a connector sync job.
Get a connector sync job.
syncjoblist
Get all connector sync jobs.
Get all connector sync jobs.
syncjobpost
Create a connector sync job.
Create a connector sync job.
updateactivefiltering
Activate the connector draft filter.
Activate the connector draft filter.
updateapikeyid
Update the connector API key ID.
Update the connector API key ID.
updateconfiguration
Update the connector configuration.
Update the connector configuration.
updateerror
Update the connector error field.
Update the connector error field.
updatefiltering
Update the connector filtering.
Update the connector filtering.
updatefilteringvalidation
Update the connector draft filtering validation.
Update the connector draft filtering validation.
updateindexname
Update the connector index name.
Update the connector index name.
updatename
Update the connector name and description.
Update the connector name and description.
updatenative
Update the connector is_native flag.
Update the connector is_native flag.
updatepipeline
Update the connector pipeline.
Update the connector pipeline.
updatescheduling
Update the connector scheduling.
Update the connector scheduling.
updateservicetype
Update the connector service type.
Update the connector service type.
updatestatus
Update the connector status.
Update the connector status.
core
bulk
Bulk index or delete documents.
Bulk index or delete documents.
clearscroll
Clear a scrolling search.
Clear a scrolling search.
closepointintime
Close a point in time.
Close a point in time.
count
Returns number of documents matching a query.
Returns number of documents matching a query.
create
Index a document.
Index a document.
delete
Delete a document.
Delete a document.
deletebyquery
Delete documents.
Delete documents.
deletebyqueryrethrottle
Throttle a delete by query operation.
Throttle a delete by query operation.
deletescript
Delete a script or search template.
Delete a script or search template.
exists
Check a document.
Check a document.
existssource
Check for a document source.
Check for a document source.
explain
Explain a document match result.
Explain a document match result.
fieldcaps
Get the field capabilities.
Get the field capabilities.
get
Get a document by its ID.
Get a document by its ID.
getscript
Get a script or search template.
Get a script or search template.
getscriptcontext
Get script contexts.
Get script contexts.
getscriptlanguages
Get script languages.
Get script languages.
getsource
Get a document's source.
Get a document's source.
healthreport
Returns the health of the cluster.
Returns the health of the cluster.
index
Index a document.
Index a document.
info
Get cluster info.
Get cluster info.
knnsearch
Run a knn search.
Run a knn search.
mget
Get multiple documents.
Get multiple documents.
msearch
Run multiple searches.
Run multiple searches.
msearchtemplate
Run multiple templated searches.
Run multiple templated searches.
mtermvectors
Get multiple term vectors.
Get multiple term vectors.
openpointintime
Open a point in time.
Open a point in time.
ping
Ping the cluster.
Ping the cluster.
putscript
Create or update a script or search template.
Create or update a script or search template.
rankeval
Evaluate ranked search results.
Evaluate ranked search results.
reindex
Reindex documents.
Reindex documents.
reindexrethrottle
Throttle a reindex operation.
Throttle a reindex operation.
rendersearchtemplate
Render a search template.
Render a search template.
scriptspainlessexecute
Run a script.
Run a script.
scroll
Run a scrolling search.
Run a scrolling search.
search
Run a search.
Run a search.
searchmvt
Search a vector tile.
Search a vector tile.
searchshards
Get the search shards.
Get the search shards.
searchtemplate
Run a search with a search template.
Run a search with a search template.
termsenum
Get terms in an index.
Get terms in an index.
termvectors
Get term vector information.
Get term vector information.
update
Update a document.
Update a document.
updatebyquery
Update documents.
Update documents.
updatebyqueryrethrottle
Throttle an update by query operation.
Throttle an update by query operation.
danglingindices
deletedanglingindex
Delete a dangling index.
Delete a dangling index.
importdanglingindex
Import a dangling index.
Import a dangling index.
listdanglingindices
Get the dangling indices.
Get the dangling indices.
enrich
deletepolicy
Delete an enrich policy.
Delete an enrich policy.
executepolicy
Creates the enrich index for an existing enrich policy.
Creates the enrich index for an existing enrich policy.
getpolicy
Get an enrich policy.
Get an enrich policy.
putpolicy
Create an enrich policy.
Create an enrich policy.
stats
Get enrich stats.
Get enrich stats.
eql
delete
Deletes an async EQL search or a stored synchronous EQL search.
Deletes an async EQL search or a stored synchronous EQL search.
get
Returns the current status and available results for an async EQL search or a stored synchronous EQL search.
Returns the current status and available results for an async EQL search or a stored synchronous EQL search.
getstatus
Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
search
Returns results matching a query expressed in Event Query Language (EQL)
Returns results matching a query expressed in Event Query Language (EQL)
esql
asyncquery
Executes an ESQL request asynchronously
Executes an ESQL request asynchronously
query
Executes an ES|QL request
Executes an ES|QL request
features
getfeatures
Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot
Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot
resetfeatures
Resets the internal state of features, usually by deleting system indices
Resets the internal state of features, usually by deleting system indices
fleet
globalcheckpoints
Returns the current global checkpoints for an index.
Returns the current global checkpoints for an index.
msearch
Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request.
Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request.
postsecret
Creates a secret stored by Fleet.
Creates a secret stored by Fleet.
search
The purpose of the fleet search api is to provide a search api where the search will only be executed after provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
The purpose of the fleet search api is to provide a search api where the search will only be executed after provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
graph
explore
Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
ilm
deletelifecycle
Deletes the specified lifecycle policy definition.
Deletes the specified lifecycle policy definition.
explainlifecycle
Retrieves information about the index’s current lifecycle state, such as the currently executing phase, action, and step.
Retrieves information about the index’s current lifecycle state, such as the currently executing phase, action, and step.
getlifecycle
Retrieves a lifecycle policy.
Retrieves a lifecycle policy.
getstatus
Retrieves the current index lifecycle management (ILM) status.
Retrieves the current index lifecycle management (ILM) status.
migratetodatatiers
Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ Using node roles enables ILM to automatically move the indices between data tiers.
Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ Using node roles enables ILM to automatically move the indices between data tiers.
movetostep
Manually moves an index into the specified step and executes that step.
Manually moves an index into the specified step and executes that step.
putlifecycle
Creates a lifecycle policy.
Creates a lifecycle policy.
removepolicy
Removes the assigned lifecycle policy and stops managing the specified index
Removes the assigned lifecycle policy and stops managing the specified index
retry
Retries executing the policy for an index that is in the ERROR step.
Retries executing the policy for an index that is in the ERROR step.
start
Start the index lifecycle management (ILM) plugin.
Start the index lifecycle management (ILM) plugin.
stop
Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
indices
addblock
Add an index block.
Add an index block.
analyze
Get tokens from text analysis.
Get tokens from text analysis.
clearcache
Clears the caches of one or more indices.
Clears the caches of one or more indices.
clone
Clones an existing index.
Clones an existing index.
close
Closes an index.
Closes an index.
create
Create an index.
Create an index.
createdatastream
Create a data stream.
Create a data stream.
datastreamsstats
Get data stream stats.
Get data stream stats.
delete
Delete indices.
Delete indices.
deletealias
Delete an alias.
Delete an alias.
deletedatalifecycle
Delete data stream lifecycles.
Delete data stream lifecycles.
deletedatastream
Delete data streams.
Delete data streams.
deleteindextemplate
Delete an index template.
Delete an index template.
deletetemplate
Deletes a legacy index template.
Deletes a legacy index template.
diskusage
Analyzes the disk usage of each field of an index or data stream.
Analyzes the disk usage of each field of an index or data stream.
downsample
Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval.
Aggregates a time series (TSDS) index and stores pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval.
exists
Check indices.
Check indices.
existsalias
Check aliases.
Check aliases.
existsindextemplate
Returns information about whether a particular index template exists.
Returns information about whether a particular index template exists.
existstemplate
Check existence of index templates.
Check existence of index templates.
explaindatalifecycle
Get the status for a data stream lifecycle.
Get the status for a data stream lifecycle.
fieldusagestats
Returns field usage information for each shard and field of an index.
Returns field usage information for each shard and field of an index.
flush
Flushes one or more data streams or indices.
Flushes one or more data streams or indices.
forcemerge
Performs the force merge operation on one or more indices.
Performs the force merge operation on one or more indices.
get
Get index information.
Get index information.
getalias
Get aliases.
Get aliases.
getdatalifecycle
Get data stream lifecycles.
Get data stream lifecycles.
getdatastream
Get data streams.
Get data streams.
getfieldmapping
Get mapping definitions.
Get mapping definitions.
getindextemplate
Get index templates.
Get index templates.
getmapping
Get mapping definitions.
Get mapping definitions.
getsettings
Get index settings.
Get index settings.
gettemplate
Get index templates.
Get index templates.
migratetodatastream
Convert an index alias to a data stream.
Convert an index alias to a data stream.
modifydatastream
Update data streams.
Update data streams.
open
Opens a closed index.
Opens a closed index.
promotedatastream
Promotes a data stream from a replicated data stream managed by CCR to a regular data stream
Promotes a data stream from a replicated data stream managed by CCR to a regular data stream
putalias
Create or update an alias.
Create or update an alias.
putdatalifecycle
Update data stream lifecycles.
Update data stream lifecycles.
putindextemplate
Create or update an index template.
Create or update an index template.
putmapping
Update field mappings.
Update field mappings.
putsettings
Update index settings.
Update index settings.
puttemplate
Create or update an index template.
Create or update an index template.
recovery
Returns information about ongoing and completed shard recoveries for one or more indices.
Returns information about ongoing and completed shard recoveries for one or more indices.
refresh
Refresh an index.
Refresh an index.
reloadsearchanalyzers
Reloads an index's search analyzers and their resources.
Reloads an index's search analyzers and their resources.
resolvecluster
Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
resolveindex
Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
rollover
Roll over to a new index.
Roll over to a new index.
segments
Returns low-level information about the Lucene segments in index shards.
Returns low-level information about the Lucene segments in index shards.
shardstores
Retrieves store information about replica shards in one or more indices.
Retrieves store information about replica shards in one or more indices.
shrink
Shrinks an existing index into a new index with fewer primary shards.
Shrinks an existing index into a new index with fewer primary shards.
simulateindextemplate
Simulate an index.
Simulate an index.
simulatetemplate
Simulate an index template.
Simulate an index template.
split
Splits an existing index into a new index with more primary shards.
Splits an existing index into a new index with more primary shards.
stats
Returns statistics for one or more indices.
Returns statistics for one or more indices.
unfreeze
Unfreezes an index.
Unfreezes an index.
updatealiases
Create or update an alias.
Create or update an alias.
validatequery
Validate a query.
Validate a query.
Perform inference on the service
Perform inference on the service
delete
Delete an inference endpoint
Delete an inference endpoint
get
Get an inference endpoint
Get an inference endpoint
put
Create an inference endpoint
Create an inference endpoint
ingest
deletegeoipdatabase
Deletes a geoip database configuration.
Deletes a geoip database configuration.
deletepipeline
Deletes one or more existing ingest pipeline.
Deletes one or more existing ingest pipeline.
geoipstats
Gets download statistics for GeoIP2 databases used with the geoip processor.
Gets download statistics for GeoIP2 databases used with the geoip processor.
getgeoipdatabase
Returns information about one or more geoip database configurations.
Returns information about one or more geoip database configurations.
getpipeline
Returns information about one or more ingest pipelines.
Returns information about one or more ingest pipelines.
processorgrok
Extracts structured fields out of a single text field within a document.
Extracts structured fields out of a single text field within a document.
putgeoipdatabase
Returns information about one or more geoip database configurations.
Returns information about one or more geoip database configurations.
putpipeline
Creates or updates an ingest pipeline.
Creates or updates an ingest pipeline.
simulate
Executes an ingest pipeline against a set of provided documents.
Executes an ingest pipeline against a set of provided documents.
license
delete
Deletes licensing information for the cluster
Deletes licensing information for the cluster
get
Get license information.
Get license information.
getbasicstatus
Retrieves information about the status of the basic license.
Retrieves information about the status of the basic license.
gettrialstatus
Retrieves information about the status of the trial license.
Retrieves information about the status of the trial license.
post
Updates the license for the cluster.
Updates the license for the cluster.
poststartbasic
The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features.
The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features.
poststarttrial
The start trial API enables you to start a 30-day trial, which gives access to all subscription features.
The start trial API enables you to start a 30-day trial, which gives access to all subscription features.
logstash
deletepipeline
Deletes a pipeline used for Logstash Central Management.
Deletes a pipeline used for Logstash Central Management.
getpipeline
Retrieves pipelines used for Logstash Central Management.
Retrieves pipelines used for Logstash Central Management.
putpipeline
Creates or updates a pipeline used for Logstash Central Management.
Creates or updates a pipeline used for Logstash Central Management.
migration
deprecations
Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.
Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.
getfeatureupgradestatus
Find out whether system features need to be upgraded or not
Find out whether system features need to be upgraded or not
postfeatureupgrade
Begin upgrades for system features
Begin upgrades for system features
ml
cleartrainedmodeldeploymentcache
Clear trained model deployment cache.
Clear trained model deployment cache.
closejob
Close anomaly detection jobs.
Close anomaly detection jobs.
deletecalendar
Delete a calendar.
Delete a calendar.
deletecalendarevent
Delete events from a calendar.
Delete events from a calendar.
deletecalendarjob
Delete anomaly jobs from a calendar.
Delete anomaly jobs from a calendar.
deletedatafeed
Delete a datafeed.
Delete a datafeed.
deletedataframeanalytics
Delete a data frame analytics job.
Delete a data frame analytics job.
deleteexpireddata
Delete expired ML data.
Delete expired ML data.
deletefilter
Delete a filter.
Delete a filter.
deleteforecast
Delete forecasts from a job.
Delete forecasts from a job.
deletejob
Delete an anomaly detection job.
Delete an anomaly detection job.
deletemodelsnapshot
Delete a model snapshot.
Delete a model snapshot.
deletetrainedmodel
Delete an unreferenced trained model.
Delete an unreferenced trained model.
deletetrainedmodelalias
Delete a trained model alias.
Delete a trained model alias.
estimatemodelmemory
Estimate job model memory usage.
Estimate job model memory usage.
evaluatedataframe
Evaluate data frame analytics.
Evaluate data frame analytics.
explaindataframeanalytics
Explain data frame analytics config.
Explain data frame analytics config.
flushjob
Force buffered data to be processed.
Force buffered data to be processed.
forecast
Predict future behavior of a time series.
Predict future behavior of a time series.
getbuckets
Get anomaly detection job results for buckets.
Get anomaly detection job results for buckets.
getcalendarevents
Get info about events in calendars.
Get info about events in calendars.
getcalendars
Get calendar configuration info.
Get calendar configuration info.
getcategories
Get anomaly detection job results for categories.
Get anomaly detection job results for categories.
getdatafeeds
Get datafeeds configuration info.
Get datafeeds configuration info.
getdatafeedstats
Get datafeeds usage info.
Get datafeeds usage info.
getdataframeanalytics
Get data frame analytics job configuration info.
Get data frame analytics job configuration info.
getdataframeanalyticsstats
Get data frame analytics jobs usage info.
Get data frame analytics jobs usage info.
getfilters
Get filters.
Get filters.
getinfluencers
Get anomaly detection job results for influencers.
Get anomaly detection job results for influencers.
getjobs
Get anomaly detection jobs configuration info.
Get anomaly detection jobs configuration info.
getjobstats
Get anomaly detection jobs usage info.
Get anomaly detection jobs usage info.
getmemorystats
Get machine learning memory usage info.
Get machine learning memory usage info.
getmodelsnapshots
Get model snapshots info.
Get model snapshots info.
getmodelsnapshotupgradestats
Get anomaly detection job model snapshot upgrade usage info.
Get anomaly detection job model snapshot upgrade usage info.
getoverallbuckets
Get overall bucket results.
Get overall bucket results.
getrecords
Get anomaly records for an anomaly detection job.
Get anomaly records for an anomaly detection job.
gettrainedmodels
Get trained model configuration info.
Get trained model configuration info.
gettrainedmodelsstats
Get trained models usage info.
Get trained models usage info.
infertrainedmodel
Evaluate a trained model.
Evaluate a trained model.
info
Return ML defaults and limits.
Return ML defaults and limits.
openjob
Open anomaly detection jobs.
Open anomaly detection jobs.
postcalendarevents
Add scheduled events to the calendar.
Add scheduled events to the calendar.
postdata
Send data to an anomaly detection job for analysis.
Send data to an anomaly detection job for analysis.
previewdatafeed
Preview a datafeed.
Preview a datafeed.
previewdataframeanalytics
Preview features used by data frame analytics.
Preview features used by data frame analytics.
putcalendar
Create a calendar.
Create a calendar.
putcalendarjob
Add anomaly detection job to calendar.
Add anomaly detection job to calendar.
putdatafeed
Create a datafeed.
Create a datafeed.
putdataframeanalytics
Create a data frame analytics job.
Create a data frame analytics job.
putfilter
Create a filter.
Create a filter.
putjob
Create an anomaly detection job.
Create an anomaly detection job.
puttrainedmodel
Create a trained model.
Create a trained model.
puttrainedmodelalias
Create or update a trained model alias.
Create or update a trained model alias.
puttrainedmodeldefinitionpart
Create part of a trained model definition.
Create part of a trained model definition.
puttrainedmodelvocabulary
Create a trained model vocabulary.
Create a trained model vocabulary.
resetjob
Reset an anomaly detection job.
Reset an anomaly detection job.
revertmodelsnapshot
Revert to a snapshot.
Revert to a snapshot.
setupgrademode
Set upgrade_mode for ML indices.
Set upgrade_mode for ML indices.
startdatafeed
Start datafeeds.
Start datafeeds.
startdataframeanalytics
Start a data frame analytics job.
Start a data frame analytics job.
starttrainedmodeldeployment
Start a trained model deployment.
Start a trained model deployment.
stopdatafeed
Stop datafeeds.
Stop datafeeds.
stopdataframeanalytics
Stop data frame analytics jobs.
Stop data frame analytics jobs.
stoptrainedmodeldeployment
Stop a trained model deployment.
Stop a trained model deployment.
updatedatafeed
Update a datafeed.
Update a datafeed.
updatedataframeanalytics
Update a data frame analytics job.
Update a data frame analytics job.
updatefilter
Update a filter.
Update a filter.
updatejob
Update an anomaly detection job.
Update an anomaly detection job.
updatemodelsnapshot
Update a snapshot.
Update a snapshot.
updatetrainedmodeldeployment
Update a trained model deployment.
Update a trained model deployment.
upgradejobsnapshot
Upgrade a snapshot.
Upgrade a snapshot.
validate
Validates an anomaly detection job.
Validates an anomaly detection job.
validatedetector
Validates an anomaly detection detector.
Validates an anomaly detection detector.
monitoring
bulk
Used by the monitoring features to send monitoring data.
Used by the monitoring features to send monitoring data.
nodes
clearrepositoriesmeteringarchive
You can use this API to clear the archived repositories metering information in the cluster.
You can use this API to clear the archived repositories metering information in the cluster.
getrepositoriesmeteringinfo
You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
hotthreads
This API yields a breakdown of the hot threads on each selected node in the cluster.
This API yields a breakdown of the hot threads on each selected node in the cluster.
info
Returns cluster nodes information.
Returns cluster nodes information.
reloadsecuresettings
Reloads the keystore on nodes in the cluster.
Reloads the keystore on nodes in the cluster.
stats
Returns cluster nodes statistics.
Returns cluster nodes statistics.
usage
Returns information on the usage of features.
Returns information on the usage of features.
profiling
flamegraph
Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.
Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.
stacktraces
Extracts raw stacktrace information from Universal Profiling.
Extracts raw stacktrace information from Universal Profiling.
status
Returns basic information about the status of Universal Profiling.
Returns basic information about the status of Universal Profiling.
topnfunctions
Extracts a list of topN functions from Universal Profiling.
Extracts a list of topN functions from Universal Profiling.
queryrules
deleterule
Deletes a query rule within a query ruleset.
Deletes a query rule within a query ruleset.
deleteruleset
Deletes a query ruleset.
Deletes a query ruleset.
getrule
Returns the details about a query rule within a query ruleset
Returns the details about a query rule within a query ruleset
getruleset
Returns the details about a query ruleset
Returns the details about a query ruleset
listrulesets
Returns summarized information about existing query rulesets.
Returns summarized information about existing query rulesets.
putrule
Creates or updates a query rule within a query ruleset.
Creates or updates a query rule within a query ruleset.
putruleset
Creates or updates a query ruleset.
Creates or updates a query ruleset.
test
Creates or updates a query ruleset.
Creates or updates a query ruleset.
rollup
deletejob
Deletes an existing rollup job.
Deletes an existing rollup job.
getjobs
Retrieves the configuration, stats, and status of rollup jobs.
Retrieves the configuration, stats, and status of rollup jobs.
getrollupcaps
Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
getrollupindexcaps
Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).
Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).
putjob
Creates a rollup job.
Creates a rollup job.
rollupsearch
Enables searching rolled-up data using the standard Query DSL.
Enables searching rolled-up data using the standard Query DSL.
startjob
Starts an existing, stopped rollup job.
Starts an existing, stopped rollup job.
stopjob
Stops an existing, started rollup job.
Stops an existing, started rollup job.
searchablesnapshots
cachestats
Retrieve node-level cache statistics about searchable snapshots.
Retrieve node-level cache statistics about searchable snapshots.
clearcache
Clear the cache of searchable snapshots.
Clear the cache of searchable snapshots.
mount
Mount a snapshot as a searchable index.
Mount a snapshot as a searchable index.
stats
Retrieve shard-level statistics about searchable snapshots.
Retrieve shard-level statistics about searchable snapshots.
searchapplication
delete
Delete a search application.
Delete a search application.
deletebehavioralanalytics
Delete a behavioral analytics collection.
Delete a behavioral analytics collection.
get
Get search application details.
Get search application details.
getbehavioralanalytics
Get behavioral analytics collections.
Get behavioral analytics collections.
list
Returns the existing search applications.
Returns the existing search applications.
put
Create or update a search application.
Create or update a search application.
putbehavioralanalytics
Create a behavioral analytics collection.
Create a behavioral analytics collection.
search
Run a search application search.
Run a search application search.
security
activateuserprofile
Activate a user profile.
Activate a user profile.
authenticate
Authenticate a user.
Authenticate a user.
bulkdeleterole
Bulk delete roles.
Bulk delete roles.
bulkputrole
Bulk create or update roles.
Bulk create or update roles.
bulkupdateapikeys
Updates the attributes of multiple existing API keys.
Updates the attributes of multiple existing API keys.
changepassword
Change passwords.
Change passwords.
clearapikeycache
Clear the API key cache.
Clear the API key cache.
clearcachedprivileges
Clear the privileges cache.
Clear the privileges cache.
clearcachedrealms
Clear the user cache.
Clear the user cache.
clearcachedroles
Clear the roles cache.
Clear the roles cache.
clearcachedservicetokens
Clear service account token caches.
Clear service account token caches.
createapikey
Create an API key.
Create an API key.
createcrossclusterapikey
Creates a cross-cluster API key for API key based remote cluster access.
Creates a cross-cluster API key for API key based remote cluster access.
createservicetoken
Create a service account token.
Create a service account token.
deleteprivileges
Delete application privileges.
Delete application privileges.
deleterole
Delete roles.
Delete roles.
deleterolemapping
Delete role mappings.
Delete role mappings.
deleteservicetoken
Delete service account tokens.
Delete service account tokens.
deleteuser
Delete users.
Delete users.
disableuser
Disable users.
Disable users.
disableuserprofile
Disable a user profile.
Disable a user profile.
enableuser
Enable users.
Enable users.
enableuserprofile
Enable a user profile.
Enable a user profile.
enrollkibana
Enroll Kibana.
Enroll Kibana.
enrollnode
Enroll a node.
Enroll a node.
getapikey
Get API key information.
Get API key information.
getbuiltinprivileges
Get builtin privileges.
Get builtin privileges.
getprivileges
Get application privileges.
Get application privileges.
getrole
Get roles.
Get roles.
getrolemapping
Get role mappings.
Get role mappings.
getserviceaccounts
Get service accounts.
Get service accounts.
getservicecredentials
Get service account credentials.
Get service account credentials.
getsettings
Retrieve settings for the security system indices
Retrieve settings for the security system indices
gettoken
Get a token.
Get a token.
getuser
Get users.
Get users.
getuserprivileges
Get user privileges.
Get user privileges.
getuserprofile
Get a user profile.
Get a user profile.
grantapikey
Grant an API key.
Grant an API key.
hasprivileges
Check user privileges.
Check user privileges.
hasprivilegesuserprofile
Check user profile privileges.
Check user profile privileges.
invalidateapikey
Invalidate API keys.
Invalidate API keys.
invalidatetoken
Invalidate a token.
Invalidate a token.
oidcauthenticate
Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair
Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair
oidclogout
Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API
Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API
oidcprepareauthentication
Creates an OAuth 2.0 authentication request as a URL string
Creates an OAuth 2.0 authentication request as a URL string
putprivileges
Create or update application privileges.
Create or update application privileges.
putrole
Create or update roles.
Create or update roles.
putrolemapping
Create or update role mappings.
Create or update role mappings.
putuser
Create or update users.
Create or update users.
queryapikeys
Find API keys with a query.
Find API keys with a query.
queryrole
Find roles with a query.
Find roles with a query.
queryuser
Find users with a query.
Find users with a query.
samlauthenticate
Authenticate SAML.
Authenticate SAML.
samlcompletelogout
Logout of SAML completely.
Logout of SAML completely.
samlinvalidate
Invalidate SAML.
Invalidate SAML.
samllogout
Logout of SAML.
Logout of SAML.
samlprepareauthentication
Prepare SAML authentication.
Prepare SAML authentication.
samlserviceprovidermetadata
Create SAML service provider metadata.
Create SAML service provider metadata.
suggestuserprofiles
Suggest a user profile.
Suggest a user profile.
updateapikey
Update an API key.
Update an API key.
updatesettings
Update settings for the security system index
Update settings for the security system index
updateuserprofiledata
Update user profile data.
Update user profile data.
shutdown
deletenode
Removes a node from the shutdown list.
Removes a node from the shutdown list.
getnode
Retrieve status of a node or nodes that are currently marked as shutting down.
Retrieve status of a node or nodes that are currently marked as shutting down.
putnode
Adds a node to be shut down.
Adds a node to be shut down.
slm
deletelifecycle
Deletes an existing snapshot lifecycle policy.
Deletes an existing snapshot lifecycle policy.
executelifecycle
Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time.
executeretention
Deletes any snapshots that are expired according to the policy's retention rules.
Deletes any snapshots that are expired according to the policy's retention rules.
getlifecycle
Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts.
getstats
Returns global and policy-level statistics about actions taken by snapshot lifecycle management.
Returns global and policy-level statistics about actions taken by snapshot lifecycle management.
getstatus
Retrieves the status of snapshot lifecycle management (SLM).
Retrieves the status of snapshot lifecycle management (SLM).
putlifecycle
Creates or updates a snapshot lifecycle policy.
Creates or updates a snapshot lifecycle policy.
start
Turns on snapshot lifecycle management (SLM).
Turns on snapshot lifecycle management (SLM).
stop
Turns off snapshot lifecycle management (SLM).
Turns off snapshot lifecycle management (SLM).
snapshot
cleanuprepository
Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots.
Triggers the review of a snapshot repository’s contents and deletes any stale data not referenced by existing snapshots.
clone
Clones indices from one snapshot into another snapshot in the same repository.
Clones indices from one snapshot into another snapshot in the same repository.
create
Creates a snapshot in a repository.
Creates a snapshot in a repository.
createrepository
Creates a repository.
Creates a repository.
delete
Deletes one or more snapshots.
Deletes one or more snapshots.
deleterepository
Deletes a repository.
Deletes a repository.
get
Returns information about a snapshot.
Returns information about a snapshot.
getrepository
Returns information about a repository.
Returns information about a repository.
repositoryverifyintegrity
Verifies the integrity of the contents of a snapshot repository
Verifies the integrity of the contents of a snapshot repository
restore
Restores a snapshot.
Restores a snapshot.
status
Returns information about the status of a snapshot.
Returns information about the status of a snapshot.
verifyrepository
Verifies a repository.
Verifies a repository.
Package some provides helpers to allow users to user inline pointers on primitive types for the TypedAPI.
Package some provides helpers to allow users to user inline pointers on primitive types for the TypedAPI.
sql
clearcursor
Clears the SQL cursor
Clears the SQL cursor
deleteasync
Deletes an async SQL search or a stored synchronous SQL search.
Deletes an async SQL search or a stored synchronous SQL search.
getasync
Returns the current status and available results for an async SQL search or stored synchronous SQL search
Returns the current status and available results for an async SQL search or stored synchronous SQL search
getasyncstatus
Returns the current status of an async SQL search or a stored synchronous SQL search
Returns the current status of an async SQL search or a stored synchronous SQL search
query
Executes a SQL request
Executes a SQL request
translate
Translates SQL into Elasticsearch queries
Translates SQL into Elasticsearch queries
ssl
certificates
Get SSL certificates.
Get SSL certificates.
synonyms
deletesynonym
Deletes a synonym set
Deletes a synonym set
deletesynonymrule
Deletes a synonym rule in a synonym set
Deletes a synonym rule in a synonym set
getsynonym
Retrieves a synonym set
Retrieves a synonym set
getsynonymrule
Retrieves a synonym rule from a synonym set
Retrieves a synonym rule from a synonym set
getsynonymssets
Retrieves a summary of all defined synonym sets
Retrieves a summary of all defined synonym sets
putsynonym
Creates or updates a synonym set.
Creates or updates a synonym set.
putsynonymrule
Creates or updates a synonym rule in a synonym set
Creates or updates a synonym rule in a synonym set
tasks
cancel
Cancels a task, if it can be cancelled through an API.
Cancels a task, if it can be cancelled through an API.
get
Get task information.
Get task information.
list
The task management API returns information about tasks currently executing on one or more nodes in the cluster.
The task management API returns information about tasks currently executing on one or more nodes in the cluster.
textstructure
findfieldstructure
Finds the structure of a text field in an index.
Finds the structure of a text field in an index.
findmessagestructure
Finds the structure of a list of messages.
Finds the structure of a list of messages.
findstructure
Finds the structure of a text file.
Finds the structure of a text file.
testgrokpattern
Tests a Grok pattern on some text.
Tests a Grok pattern on some text.
transform
deletetransform
Delete a transform.
Delete a transform.
getnodestats
Retrieves transform usage information for transform nodes.
Retrieves transform usage information for transform nodes.
gettransform
Get transforms.
Get transforms.
gettransformstats
Get transform stats.
Get transform stats.
previewtransform
Preview a transform.
Preview a transform.
puttransform
Create a transform.
Create a transform.
resettransform
Reset a transform.
Reset a transform.
schedulenowtransform
Schedule a transform to start now.
Schedule a transform to start now.
starttransform
Start a transform.
Start a transform.
stoptransform
Stop transforms.
Stop transforms.
updatetransform
Update a transform.
Update a transform.
upgradetransforms
Upgrades all transforms.
Upgrades all transforms.
enums/accesstokengranttype
Package accesstokengranttype
Package accesstokengranttype
enums/acknowledgementoptions
Package acknowledgementoptions
Package acknowledgementoptions
enums/actionexecutionmode
Package actionexecutionmode
Package actionexecutionmode
enums/actionstatusoptions
Package actionstatusoptions
Package actionstatusoptions
enums/actiontype
Package actiontype
Package actiontype
enums/allocationexplaindecision
Package allocationexplaindecision
Package allocationexplaindecision
enums/apikeygranttype
Package apikeygranttype
Package apikeygranttype
enums/appliesto
Package appliesto
Package appliesto
enums/boundaryscanner
Package boundaryscanner
Package boundaryscanner
enums/bytes
Package bytes
Package bytes
enums/calendarinterval
Package calendarinterval
Package calendarinterval
enums/cardinalityexecutionmode
Package cardinalityexecutionmode
Package cardinalityexecutionmode
enums/catanomalydetectorcolumn
Package catanomalydetectorcolumn
Package catanomalydetectorcolumn
enums/catdatafeedcolumn
Package catdatafeedcolumn
Package catdatafeedcolumn
enums/catdfacolumn
Package catdfacolumn
Package catdfacolumn
enums/categorizationstatus
Package categorizationstatus
Package categorizationstatus
enums/cattrainedmodelscolumn
Package cattrainedmodelscolumn
Package cattrainedmodelscolumn
enums/cattransformcolumn
Package cattransformcolumn
Package cattransformcolumn
enums/childscoremode
Package childscoremode
Package childscoremode
enums/chunkingmode
Package chunkingmode
Package chunkingmode
enums/clusterinfotarget
Package clusterinfotarget
Package clusterinfotarget
enums/clusterprivilege
Package clusterprivilege
Package clusterprivilege
enums/clustersearchstatus
Package clustersearchstatus
Package clustersearchstatus
enums/combinedfieldsoperator
Package combinedfieldsoperator
Package combinedfieldsoperator
enums/combinedfieldszeroterms
Package combinedfieldszeroterms
Package combinedfieldszeroterms
enums/conditionop
Package conditionop
Package conditionop
enums/conditionoperator
Package conditionoperator
Package conditionoperator
enums/conditiontype
Package conditiontype
Package conditiontype
enums/conflicts
Package conflicts
Package conflicts
enums/connectionscheme
Package connectionscheme
Package connectionscheme
enums/connectorfieldtype
Package connectorfieldtype
Package connectorfieldtype
enums/connectorstatus
Package connectorstatus
Package connectorstatus
enums/converttype
Package converttype
Package converttype
enums/dataattachmentformat
Package dataattachmentformat
Package dataattachmentformat
enums/datafeedstate
Package datafeedstate
Package datafeedstate
enums/dataframestate
Package dataframestate
Package dataframestate
enums/day
Package day
Package day
enums/decision
Package decision
Package decision
enums/delimitedpayloadencoding
Package delimitedpayloadencoding
Package delimitedpayloadencoding
enums/deploymentallocationstate
Package deploymentallocationstate
Package deploymentallocationstate
enums/deploymentassignmentstate
Package deploymentassignmentstate
Package deploymentassignmentstate
enums/deprecationlevel
Package deprecationlevel
Package deprecationlevel
enums/dfiindependencemeasure
Package dfiindependencemeasure
Package dfiindependencemeasure
enums/dfraftereffect
Package dfraftereffect
Package dfraftereffect
enums/dfrbasicmodel
Package dfrbasicmodel
Package dfrbasicmodel
enums/displaytype
Package displaytype
Package displaytype
enums/distanceunit
Package distanceunit
Package distanceunit
enums/dynamicmapping
Package dynamicmapping
Package dynamicmapping
enums/edgengramside
Package edgengramside
Package edgengramside
enums/emailpriority
Package emailpriority
Package emailpriority
enums/enrichpolicyphase
Package enrichpolicyphase
Package enrichpolicyphase
enums/esqlformat
Package esqlformat
Package esqlformat
enums/excludefrequent
Package excludefrequent
Package excludefrequent
enums/executionphase
Package executionphase
Package executionphase
enums/executionstatus
Package executionstatus
Package executionstatus
enums/expandwildcard
Package expandwildcard
Package expandwildcard
enums/feature
Package feature
Package feature
enums/fieldsortnumerictype
Package fieldsortnumerictype
Package fieldsortnumerictype
enums/fieldtype
Package fieldtype
Package fieldtype
enums/fieldvaluefactormodifier
Package fieldvaluefactormodifier
Package fieldvaluefactormodifier
enums/filteringpolicy
Package filteringpolicy
Package filteringpolicy
enums/filteringrulerule
Package filteringrulerule
Package filteringrulerule
enums/filteringvalidationstate
Package filteringvalidationstate
Package filteringvalidationstate
enums/filtertype
Package filtertype
Package filtertype
enums/fingerprintdigest
Package fingerprintdigest
Package fingerprintdigest
enums/followerindexstatus
Package followerindexstatus
Package followerindexstatus
enums/functionboostmode
Package functionboostmode
Package functionboostmode
enums/functionscoremode
Package functionscoremode
Package functionscoremode
enums/gappolicy
Package gappolicy
Package gappolicy
enums/geodistancetype
Package geodistancetype
Package geodistancetype
enums/geoexecution
Package geoexecution
Package geoexecution
enums/geogridtargetformat
Package geogridtargetformat
Package geogridtargetformat
enums/geogridtiletype
Package geogridtiletype
Package geogridtiletype
enums/geoorientation
Package geoorientation
Package geoorientation
enums/geoshaperelation
Package geoshaperelation
Package geoshaperelation
enums/geostrategy
Package geostrategy
Package geostrategy
enums/geovalidationmethod
Package geovalidationmethod
Package geovalidationmethod
enums/granttype
Package granttype
Package granttype
enums/gridaggregationtype
Package gridaggregationtype
Package gridaggregationtype
enums/gridtype
Package gridtype
Package gridtype
enums/groupby
Package groupby
Package groupby
enums/healthstatus
Package healthstatus
Package healthstatus
enums/highlighterencoder
Package highlighterencoder
Package highlighterencoder
enums/highlighterfragmenter
Package highlighterfragmenter
Package highlighterfragmenter
enums/highlighterorder
Package highlighterorder
Package highlighterorder
enums/highlightertagsschema
Package highlightertagsschema
Package highlightertagsschema
enums/highlightertype
Package highlightertype
Package highlightertype
enums/holtwinterstype
Package holtwinterstype
Package holtwinterstype
enums/httpinputmethod
Package httpinputmethod
Package httpinputmethod
enums/ibdistribution
Package ibdistribution
Package ibdistribution
enums/iblambda
Package iblambda
Package iblambda
enums/icucollationalternate
Package icucollationalternate
Package icucollationalternate
enums/icucollationcasefirst
Package icucollationcasefirst
Package icucollationcasefirst
enums/icucollationdecomposition
Package icucollationdecomposition
Package icucollationdecomposition
enums/icucollationstrength
Package icucollationstrength
Package icucollationstrength
enums/icunormalizationmode
Package icunormalizationmode
Package icunormalizationmode
enums/icunormalizationtype
Package icunormalizationtype
Package icunormalizationtype
enums/icutransformdirection
Package icutransformdirection
Package icutransformdirection
enums/impactarea
Package impactarea
Package impactarea
enums/include
Package include
Package include
enums/indexcheckonstartup
Package indexcheckonstartup
Package indexcheckonstartup
enums/indexingjobstate
Package indexingjobstate
Package indexingjobstate
enums/indexmetadatastate
Package indexmetadatastate
Package indexmetadatastate
enums/indexoptions
Package indexoptions
Package indexoptions
enums/indexprivilege
Package indexprivilege
Package indexprivilege
enums/indexroutingallocationoptions
Package indexroutingallocationoptions
Package indexroutingallocationoptions
enums/indexroutingrebalanceoptions
Package indexroutingrebalanceoptions
Package indexroutingrebalanceoptions
enums/indicatorhealthstatus
Package indicatorhealthstatus
Package indicatorhealthstatus
enums/indicesblockoptions
Package indicesblockoptions
Package indicesblockoptions
enums/inputtype
Package inputtype
Package inputtype
enums/jobblockedreason
Package jobblockedreason
Package jobblockedreason
enums/jobstate
Package jobstate
Package jobstate
enums/jsonprocessorconflictstrategy
Package jsonprocessorconflictstrategy
Package jsonprocessorconflictstrategy
enums/keeptypesmode
Package keeptypesmode
Package keeptypesmode
enums/kuromojitokenizationmode
Package kuromojitokenizationmode
Package kuromojitokenizationmode
enums/language
Package language
Package language
enums/level
Package level
Package level
enums/licensestatus
Package licensestatus
Package licensestatus
enums/licensetype
Package licensetype
Package licensetype
enums/lifecycleoperationmode
Package lifecycleoperationmode
Package lifecycleoperationmode
enums/managedby
Package managedby
Package managedby
enums/matchtype
Package matchtype
Package matchtype
enums/memorystatus
Package memorystatus
Package memorystatus
enums/metric
Package metric
Package metric
enums/migrationstatus
Package migrationstatus
Package migrationstatus
enums/minimuminterval
Package minimuminterval
Package minimuminterval
enums/missingorder
Package missingorder
Package missingorder
enums/month
Package month
Package month
enums/multivaluemode
Package multivaluemode
Package multivaluemode
enums/noderole
Package noderole
Package noderole
enums/noridecompoundmode
Package noridecompoundmode
Package noridecompoundmode
enums/normalization
Package normalization
Package normalization
enums/normalizemethod
Package normalizemethod
Package normalizemethod
enums/numericfielddataformat
Package numericfielddataformat
Package numericfielddataformat
enums/onscripterror
Package onscripterror
Package onscripterror
enums/operationtype
Package operationtype
Package operationtype
enums/operator
Package operator
Package operator
enums/optype
Package optype
Package optype
enums/pagerdutycontexttype
Package pagerdutycontexttype
Package pagerdutycontexttype
enums/pagerdutyeventtype
Package pagerdutyeventtype
Package pagerdutyeventtype
enums/phoneticencoder
Package phoneticencoder
Package phoneticencoder
enums/phoneticlanguage
Package phoneticlanguage
Package phoneticlanguage
enums/phoneticnametype
Package phoneticnametype
Package phoneticnametype
enums/phoneticruletype
Package phoneticruletype
Package phoneticruletype
enums/policytype
Package policytype
Package policytype
enums/quantifier
Package quantifier
Package quantifier
enums/queryrulecriteriatype
Package queryrulecriteriatype
Package queryrulecriteriatype
enums/queryruletype
Package queryruletype
Package queryruletype
enums/rangerelation
Package rangerelation
Package rangerelation
enums/ratemode
Package ratemode
Package ratemode
enums/refresh
Package refresh
Package refresh
enums/responsecontenttype
Package responsecontenttype
Package responsecontenttype
enums/result
Package result
Package result
enums/resultposition
Package resultposition
Package resultposition
enums/routingstate
Package routingstate
Package routingstate
enums/ruleaction
Package ruleaction
Package ruleaction
enums/runtimefieldtype
Package runtimefieldtype
Package runtimefieldtype
enums/sampleraggregationexecutionhint
Package sampleraggregationexecutionhint
Package sampleraggregationexecutionhint
enums/scoremode
Package scoremode
Package scoremode
enums/scriptlanguage
Package scriptlanguage
Package scriptlanguage
enums/scriptsorttype
Package scriptsorttype
Package scriptsorttype
enums/searchtype
Package searchtype
Package searchtype
enums/segmentsortmissing
Package segmentsortmissing
Package segmentsortmissing
enums/segmentsortmode
Package segmentsortmode
Package segmentsortmode
enums/segmentsortorder
Package segmentsortorder
Package segmentsortorder
enums/shapetype
Package shapetype
Package shapetype
enums/shardroutingstate
Package shardroutingstate
Package shardroutingstate
enums/shardsstatsstage
Package shardsstatsstage
Package shardsstatsstage
enums/shardstoreallocation
Package shardstoreallocation
Package shardstoreallocation
enums/shardstorestatus
Package shardstorestatus
Package shardstorestatus
enums/shutdownstatus
Package shutdownstatus
Package shutdownstatus
enums/shutdowntype
Package shutdowntype
Package shutdowntype
enums/simplequerystringflag
Package simplequerystringflag
Package simplequerystringflag
enums/slicescalculation
Package slicescalculation
Package slicescalculation
enums/snapshotsort
Package snapshotsort
Package snapshotsort
enums/snapshotupgradestate
Package snapshotupgradestate
Package snapshotupgradestate
enums/snowballlanguage
Package snowballlanguage
Package snowballlanguage
enums/sortmode
Package sortmode
Package sortmode
enums/sortorder
Package sortorder
Package sortorder
enums/sourcefieldmode
Package sourcefieldmode
Package sourcefieldmode
enums/sqlformat
Package sqlformat
Package sqlformat
enums/statslevel
Package statslevel
Package statslevel
enums/storagetype
Package storagetype
Package storagetype
enums/stringdistance
Package stringdistance
Package stringdistance
enums/suggestmode
Package suggestmode
Package suggestmode
enums/suggestsort
Package suggestsort
Package suggestsort
enums/syncjobtriggermethod
Package syncjobtriggermethod
Package syncjobtriggermethod
enums/syncjobtype
Package syncjobtype
Package syncjobtype
enums/syncstatus
Package syncstatus
Package syncstatus
enums/synonymformat
Package synonymformat
Package synonymformat
enums/tasktype
Package tasktype
Package tasktype
enums/templateformat
Package templateformat
Package templateformat
enums/termsaggregationcollectmode
Package termsaggregationcollectmode
Package termsaggregationcollectmode
enums/termsaggregationexecutionhint
Package termsaggregationexecutionhint
Package termsaggregationexecutionhint
enums/termvectoroption
Package termvectoroption
Package termvectoroption
enums/textquerytype
Package textquerytype
Package textquerytype
enums/threadtype
Package threadtype
Package threadtype
enums/timeseriesmetrictype
Package timeseriesmetrictype
Package timeseriesmetrictype
enums/timeunit
Package timeunit
Package timeunit
enums/tokenchar
Package tokenchar
Package tokenchar
enums/tokenizationtruncate
Package tokenizationtruncate
Package tokenizationtruncate
enums/totalhitsrelation
Package totalhitsrelation
Package totalhitsrelation
enums/trainedmodeltype
Package trainedmodeltype
Package trainedmodeltype
enums/trainingpriority
Package trainingpriority
Package trainingpriority
enums/translogdurability
Package translogdurability
Package translogdurability
enums/ttesttype
Package ttesttype
Package ttesttype
enums/type_
Package type_
Package type_
enums/unassignedinformationreason
Package unassignedinformationreason
Package unassignedinformationreason
enums/useragentproperty
Package useragentproperty
Package useragentproperty
enums/valuetype
Package valuetype
Package valuetype
enums/versiontype
Package versiontype
Package versiontype
enums/waitforactiveshardoptions
Package waitforactiveshardoptions
Package waitforactiveshardoptions
enums/waitforevents
Package waitforevents
Package waitforevents
enums/watchermetric
Package watchermetric
Package watchermetric
enums/watcherstate
Package watcherstate
Package watcherstate
enums/xpackcategory
Package xpackcategory
Package xpackcategory
enums/zerotermsquery
Package zerotermsquery
Package zerotermsquery
watcher
ackwatch
Acknowledges a watch, manually throttling the execution of the watch's actions.
Acknowledges a watch, manually throttling the execution of the watch's actions.
activatewatch
Activates a currently inactive watch.
Activates a currently inactive watch.
deactivatewatch
Deactivates a currently active watch.
Deactivates a currently active watch.
deletewatch
Removes a watch from Watcher.
Removes a watch from Watcher.
executewatch
This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.
This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.
getsettings
Retrieve settings for the watcher system index
Retrieve settings for the watcher system index
getwatch
Retrieves a watch by its ID.
Retrieves a watch by its ID.
putwatch
Creates a new watch, or updates an existing one.
Creates a new watch, or updates an existing one.
querywatches
Retrieves stored watches.
Retrieves stored watches.
start
Starts Watcher if it is not already running.
Starts Watcher if it is not already running.
stats
Retrieves the current Watcher metrics.
Retrieves the current Watcher metrics.
stop
Stops Watcher if it is running.
Stops Watcher if it is running.
updatesettings
Update settings for the watcher system index
Update settings for the watcher system index
xpack
info
Provides general information about the installed X-Pack features.
Provides general information about the installed X-Pack features.
usage
This API provides information about which features are currently enabled and available under the current license and some usage statistics.
This API provides information about which features are currently enabled and available under the current license and some usage statistics.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL