Documentation ¶
Index ¶
- type API
- type AsyncSearch
- type Autoscaling
- type Cat
- type Ccr
- type Cluster
- type Core
- type DanglingIndices
- type Enrich
- type Eql
- type Features
- type Fleet
- type Graph
- type Ilm
- type Indices
- type Ingest
- type License
- type Logstash
- type Migration
- type Ml
- type Monitoring
- type Nodes
- type QueryRuleset
- type Request
- type Rollup
- type SearchApplication
- type SearchableSnapshots
- type Security
- type Shutdown
- type Slm
- type Snapshot
- type Sql
- type Ssl
- type Synonyms
- type Tasks
- type TextStructure
- type Transform
- type Watcher
- type Xpack
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 Cat Cat Ccr Ccr Cluster Cluster Core Core DanglingIndices DanglingIndices Enrich Enrich Eql Eql Features Features Fleet Fleet Graph Graph Ilm Ilm Indices Indices Ingest Ingest License License Logstash Logstash Migration Migration Ml Ml Monitoring Monitoring Nodes Nodes QueryRuleset QueryRuleset 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 // Allows to perform multiple index/update/delete operations in a single // request. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html Bulk core_bulk.NewBulk // Explicitly clears the search context for a scroll. // https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html ClearScroll core_clear_scroll.NewClearScroll // Close a point in time // 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 // Creates a new document in the index. // // Returns a 409 response when a document with a same ID already exists in the // index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html Create core_create.NewCreate // Removes a document from the index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html Delete core_delete.NewDelete // Deletes documents matching the provided query. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html DeleteByQuery core_delete_by_query.NewDeleteByQuery // Changes the number of requests per second for a particular Delete By Query // operation. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html DeleteByQueryRethrottle core_delete_by_query_rethrottle.NewDeleteByQueryRethrottle // Deletes a script. // https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html DeleteScript core_delete_script.NewDeleteScript // Returns information about whether a document exists in an index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html Exists core_exists.NewExists // Returns information about whether a document source exists in an index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html ExistsSource core_exists_source.NewExistsSource // Returns information about why a specific matches (or doesn't match) a query. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html Explain core_explain.NewExplain // Returns the information about the capabilities of fields among multiple // indices. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html FieldCaps core_field_caps.NewFieldCaps // Returns a document. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html Get core_get.NewGet // Returns a script. // https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html GetScript core_get_script.NewGetScript // Returns all script contexts. // https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-contexts.html GetScriptContext core_get_script_context.NewGetScriptContext // Returns available script types, languages and contexts // https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html GetScriptLanguages core_get_script_languages.NewGetScriptLanguages // 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 // Creates or updates a document in an index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html Index core_index.NewIndex // Returns basic information about the cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html Info core_info.NewInfo // Performs a kNN search. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html KnnSearch core_knn_search.NewKnnSearch // Allows to get multiple documents in one request. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html Mget core_mget.NewMget // Allows to execute several search operations in one request. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html Msearch core_msearch.NewMsearch // Allows to execute several search template operations in one request. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html MsearchTemplate core_msearch_template.NewMsearchTemplate // Returns multiple termvectors in one request. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html Mtermvectors core_mtermvectors.NewMtermvectors // Open a point in time that can be used in subsequent searches // https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html OpenPointInTime core_open_point_in_time.NewOpenPointInTime // Returns whether the cluster is running. // https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html Ping core_ping.NewPing // Creates or updates a script. // https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html PutScript core_put_script.NewPutScript // Allows to 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 // Allows to copy documents from one index to another, optionally filtering the // source // documents by a query, changing the destination index settings, or fetching // the // documents from a remote cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html Reindex core_reindex.NewReindex // Changes 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 // Allows to use the Mustache language to pre-render a search definition. // https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html RenderSearchTemplate core_render_search_template.NewRenderSearchTemplate // Allows an arbitrary script to be executed and a result to be returned // https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html ScriptsPainlessExecute core_scripts_painless_execute.NewScriptsPainlessExecute // Allows to retrieve a large numbers of results from a single search request. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-scroll Scroll core_scroll.NewScroll // Returns results matching a query. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html Search core_search.NewSearch // Searches a vector tile for geospatial values. Returns results as a binary // Mapbox vector tile. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-vector-tile-api.html SearchMvt core_search_mvt.NewSearchMvt // Returns information about the indices and shards that a search request would // be executed against. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html SearchShards core_search_shards.NewSearchShards // Allows to use the Mustache language to pre-render a search definition. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html SearchTemplate core_search_template.NewSearchTemplate // The terms enum API can be used to discover terms in the index that begin // with the provided string. It is designed for low-latency look-ups used in // auto-complete scenarios. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html TermsEnum core_terms_enum.NewTermsEnum // Returns 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 // Updates a document with a script or partial document. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html Update core_update.NewUpdate // Performs an update on every document in the index without changing the // source, // for example to pick up a mapping change. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html UpdateByQuery core_update_by_query.NewUpdateByQuery // Changes the number of requests per second for a particular Update By Query // operation. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html UpdateByQueryRethrottle core_update_by_query_rethrottle.NewUpdateByQueryRethrottle }
func New ¶
func New(tp elastictransport.Interface) *API
type AsyncSearch ¶ added in v8.7.1
type AsyncSearch struct { // Deletes an async search by ID. If the search is still running, the search // request will be cancelled. Otherwise, the saved search results are deleted. // https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html Delete async_search_delete.NewDelete // Retrieves the results of a previously submitted async search request given // its ID. // https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html Get async_search_get.NewGet // Retrieves the status of a previously submitted async search request given its // ID. // https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html Status async_search_status.NewStatus // Executes a search request asynchronously. // https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html Submit async_search_submit.NewSubmit }
type Autoscaling ¶
type Autoscaling struct { // Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. // 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 // Gets the current autoscaling capacity based on the configured autoscaling // policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not // supported. // https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html GetAutoscalingCapacity autoscaling_get_autoscaling_capacity.NewGetAutoscalingCapacity // Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and // ECK. 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 // Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and // ECK. 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 Cat ¶
type Cat struct { // Shows information about currently configured aliases to indices including // filter and routing infos. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html Aliases cat_aliases.NewAliases // Provides a snapshot of how many shards are allocated to each data node and // how much disk space they are using. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-allocation.html Allocation cat_allocation.NewAllocation // Returns information about existing component_templates templates. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-component-templates.html ComponentTemplates cat_component_templates.NewComponentTemplates // Provides quick access to the document count of the entire cluster, or // individual indices. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html Count cat_count.NewCount // Shows how much heap memory is currently being used by fielddata on every data // node in the cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html Fielddata cat_fielddata.NewFielddata // Returns a concise representation of the cluster health. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html Health cat_health.NewHealth // Returns help for the Cat APIs. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html Help cat_help.NewHelp // Returns information about indices: number of primaries and replicas, document // counts, disk size, ... // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html Indices cat_indices.NewIndices // Returns information about the master node. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-master.html Master cat_master.NewMaster // Gets configuration and usage information about data frame analytics jobs. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html MlDataFrameAnalytics cat_ml_data_frame_analytics.NewMlDataFrameAnalytics // Gets configuration and usage information about datafeeds. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html MlDatafeeds cat_ml_datafeeds.NewMlDatafeeds // Gets configuration and usage information about anomaly detection jobs. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html MlJobs cat_ml_jobs.NewMlJobs // Gets configuration and usage information about inference trained models. // 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. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodeattrs.html Nodeattrs cat_nodeattrs.NewNodeattrs // Returns basic statistics about performance of cluster nodes. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html Nodes cat_nodes.NewNodes // Returns a concise representation of the cluster pending tasks. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-pending-tasks.html PendingTasks cat_pending_tasks.NewPendingTasks // Returns information about installed plugins across nodes node. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html Plugins cat_plugins.NewPlugins // Returns information about index shard recoveries, both on-going completed. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html Recovery cat_recovery.NewRecovery // Returns information about snapshot repositories registered in the cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html Repositories cat_repositories.NewRepositories // Provides low-level information about the segments in the shards of an index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html Segments cat_segments.NewSegments // Provides a detailed view of shard allocation on nodes. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html Shards cat_shards.NewShards // Returns all snapshots in a specific repository. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html Snapshots cat_snapshots.NewSnapshots // Returns information about the tasks currently executing on one or more nodes // in the cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html Tasks cat_tasks.NewTasks // Returns information about existing templates. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-templates.html Templates cat_templates.NewTemplates // Returns cluster-wide thread pool statistics per node. // By default the active, queue and rejected statistics are returned for all // thread pools. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html ThreadPool cat_thread_pool.NewThreadPool // Gets configuration and usage information about transforms. // 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 // Deletes a component template // 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 // Returns information about whether a particular component template exist // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html ExistsComponentTemplate cluster_exists_component_template.NewExistsComponentTemplate // Returns one or more component templates // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html GetComponentTemplate cluster_get_component_template.NewGetComponentTemplate // Returns cluster settings. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-get-settings.html GetSettings cluster_get_settings.NewGetSettings // Returns basic information about the health of the cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html Health cluster_health.NewHealth // Returns different information about the cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-info.html Info cluster_info.NewInfo // Returns a list of any cluster-level changes (e.g. create index, update // mapping, // allocate or fail shard) which have not yet been executed. // 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 // Creates or updates a component template // 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 // Returns the information about configured remote clusters. // 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 high-level overview of cluster statistics. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html Stats cluster_stats.NewStats }
type Core ¶
type Core struct { // Allows to perform multiple index/update/delete operations in a single // request. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html Bulk core_bulk.NewBulk // Explicitly clears the search context for a scroll. // https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html ClearScroll core_clear_scroll.NewClearScroll // Close a point in time // 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 // Creates a new document in the index. // // Returns a 409 response when a document with a same ID already exists in the // index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html Create core_create.NewCreate // Removes a document from the index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html Delete core_delete.NewDelete // Deletes documents matching the provided query. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html DeleteByQuery core_delete_by_query.NewDeleteByQuery // Changes the number of requests per second for a particular Delete By Query // operation. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html DeleteByQueryRethrottle core_delete_by_query_rethrottle.NewDeleteByQueryRethrottle // Deletes a script. // https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html DeleteScript core_delete_script.NewDeleteScript // Returns information about whether a document exists in an index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html Exists core_exists.NewExists // Returns information about whether a document source exists in an index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html ExistsSource core_exists_source.NewExistsSource // Returns information about why a specific matches (or doesn't match) a query. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html Explain core_explain.NewExplain // Returns the information about the capabilities of fields among multiple // indices. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html FieldCaps core_field_caps.NewFieldCaps // Returns a document. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html Get core_get.NewGet // Returns a script. // https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html GetScript core_get_script.NewGetScript // Returns all script contexts. // https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-contexts.html GetScriptContext core_get_script_context.NewGetScriptContext // Returns available script types, languages and contexts // https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html GetScriptLanguages core_get_script_languages.NewGetScriptLanguages // 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 // Creates or updates a document in an index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html Index core_index.NewIndex // Returns basic information about the cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html Info core_info.NewInfo // Performs a kNN search. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html KnnSearch core_knn_search.NewKnnSearch // Allows to get multiple documents in one request. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html Mget core_mget.NewMget // Allows to execute several search operations in one request. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html Msearch core_msearch.NewMsearch // Allows to execute several search template operations in one request. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html MsearchTemplate core_msearch_template.NewMsearchTemplate // Returns multiple termvectors in one request. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html Mtermvectors core_mtermvectors.NewMtermvectors // Open a point in time that can be used in subsequent searches // https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html OpenPointInTime core_open_point_in_time.NewOpenPointInTime // Returns whether the cluster is running. // https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html Ping core_ping.NewPing // Creates or updates a script. // https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html PutScript core_put_script.NewPutScript // Allows to 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 // Allows to copy documents from one index to another, optionally filtering the // source // documents by a query, changing the destination index settings, or fetching // the // documents from a remote cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html Reindex core_reindex.NewReindex // Changes 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 // Allows to use the Mustache language to pre-render a search definition. // https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html RenderSearchTemplate core_render_search_template.NewRenderSearchTemplate // Allows an arbitrary script to be executed and a result to be returned // https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html ScriptsPainlessExecute core_scripts_painless_execute.NewScriptsPainlessExecute // Allows to retrieve a large numbers of results from a single search request. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-scroll Scroll core_scroll.NewScroll // Returns results matching a query. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html Search core_search.NewSearch // Searches a vector tile for geospatial values. Returns results as a binary // Mapbox vector tile. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-vector-tile-api.html SearchMvt core_search_mvt.NewSearchMvt // Returns information about the indices and shards that a search request would // be executed against. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html SearchShards core_search_shards.NewSearchShards // Allows to use the Mustache language to pre-render a search definition. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html SearchTemplate core_search_template.NewSearchTemplate // The terms enum API can be used to discover terms in the index that begin // with the provided string. It is designed for low-latency look-ups used in // auto-complete scenarios. // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html TermsEnum core_terms_enum.NewTermsEnum // Returns 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 // Updates a document with a script or partial document. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html Update core_update.NewUpdate // Performs an update on every document in the index without changing the // source, // for example to pick up a mapping change. // https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html UpdateByQuery core_update_by_query.NewUpdateByQuery // Changes the number of requests per second for a particular Update By Query // operation. // 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 { // Deletes the specified dangling index // https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html DeleteDanglingIndex dangling_indices_delete_dangling_index.NewDeleteDanglingIndex // Imports the specified dangling index // https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html ImportDanglingIndex dangling_indices_import_dangling_index.NewImportDanglingIndex // Returns all dangling indices. // 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 { // 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 // Gets information about an enrich policy. // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html GetPolicy enrich_get_policy.NewGetPolicy // Creates a new enrich policy. // https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html PutPolicy enrich_put_policy.NewPutPolicy // Gets 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 by ID. If the search is still running, the search // request will be cancelled. Otherwise, the saved search results are deleted. // https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html Delete eql_delete.NewDelete // Returns async results from previously executed Event Query Language (EQL) // search // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-eql-search-api.html Get eql_get.NewGet // Returns the status of a previously submitted async or stored Event Query // Language (EQL) search // 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 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 // Multi Search API where the search will only be executed after specified // checkpoints are available due to a refresh. This API is designed for internal // use by the fleet server project. // Msearch fleet_msearch.NewMsearch // Search API where the search will only be executed after specified checkpoints // are available due to a refresh. This API is designed for internal use by the // fleet server project. // Search fleet_search.NewSearch }
type Graph ¶
type Graph struct { // Explore extracted and summarized information about the documents and terms in // an 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. A currently used policy // cannot be deleted. // 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. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html ExplainLifecycle ilm_explain_lifecycle.NewExplainLifecycle // Returns the specified policy definition. Includes the policy version and last // modified date. // 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 // Migrates the indices and ILM policies away from custom node attribute // allocation routing to data tiers routing // 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 // 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 { // Adds a block to an index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html AddBlock indices_add_block.NewAddBlock // Performs the analysis process on a text and return the tokens breakdown of // the text. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html Analyze indices_analyze.NewAnalyze // Clears all or specific caches for one or more indices. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html ClearCache indices_clear_cache.NewClearCache // Clones an 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 // Creates an index with optional settings and mappings. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html Create indices_create.NewCreate // Creates a data stream // https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html CreateDataStream indices_create_data_stream.NewCreateDataStream // Provides statistics on operations happening in a data stream. // https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html DataStreamsStats indices_data_streams_stats.NewDataStreamsStats // Deletes an index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html Delete indices_delete.NewDelete // Deletes an alias. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html DeleteAlias indices_delete_alias.NewDeleteAlias // Deletes the data stream lifecycle of the selected data streams. // https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-delete-lifecycle.html DeleteDataLifecycle indices_delete_data_lifecycle.NewDeleteDataLifecycle // Deletes a data stream. // https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html DeleteDataStream indices_delete_data_stream.NewDeleteDataStream // Deletes an index template. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html DeleteIndexTemplate indices_delete_index_template.NewDeleteIndexTemplate // Deletes an index template. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.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 // Downsample an index // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-downsample-data-stream.html Downsample indices_downsample.NewDownsample // Returns information about whether a particular index exists. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html Exists indices_exists.NewExists // Returns information about whether a particular alias exists. // 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/indices-templates.html ExistsIndexTemplate indices_exists_index_template.NewExistsIndexTemplate // Returns information about whether a particular index template exists. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html ExistsTemplate indices_exists_template.NewExistsTemplate // Retrieves information about the index's current data stream lifecycle, such // as any potential encountered error, time since creation etc. // https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html ExplainDataLifecycle indices_explain_data_lifecycle.NewExplainDataLifecycle // Returns the field usage stats for each field of an index // https://www.elastic.co/guide/en/elasticsearch/reference/current/field-usage-stats.html FieldUsageStats indices_field_usage_stats.NewFieldUsageStats // Performs the flush operation on one or more 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 // Returns information about one or more indices. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html Get indices_get.NewGet // Returns an alias. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html GetAlias indices_get_alias.NewGetAlias // Returns the data stream lifecycle of the selected data streams. // https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-get-lifecycle.html GetDataLifecycle indices_get_data_lifecycle.NewGetDataLifecycle // Returns data streams. // https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html GetDataStream indices_get_data_stream.NewGetDataStream // Returns mapping for one or more fields. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html GetFieldMapping indices_get_field_mapping.NewGetFieldMapping // Returns an index template. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html GetIndexTemplate indices_get_index_template.NewGetIndexTemplate // Returns mappings for one or more indices. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-mapping.html GetMapping indices_get_mapping.NewGetMapping // Returns settings for one or more indices. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html GetSettings indices_get_settings.NewGetSettings // Returns an index template. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html GetTemplate indices_get_template.NewGetTemplate // Migrates an alias to a data stream // https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html MigrateToDataStream indices_migrate_to_data_stream.NewMigrateToDataStream // Modifies a data stream // https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html ModifyDataStream indices_modify_data_stream.NewModifyDataStream // Opens an index. // 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 // Creates or updates an alias. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html PutAlias indices_put_alias.NewPutAlias // Updates the data stream lifecycle of the selected data streams. // https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-put-lifecycle.html PutDataLifecycle indices_put_data_lifecycle.NewPutDataLifecycle // Creates or updates an index template. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html PutIndexTemplate indices_put_index_template.NewPutIndexTemplate // Updates the index mappings. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html PutMapping indices_put_mapping.NewPutMapping // Updates the index settings. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html PutSettings indices_put_settings.NewPutSettings // Creates or updates an index template. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html PutTemplate indices_put_template.NewPutTemplate // Returns information about ongoing index shard recoveries. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-recovery.html Recovery indices_recovery.NewRecovery // Performs the refresh operation in one or more 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 // Returns information about any matching indices, aliases, and data streams // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-resolve-index-api.html ResolveIndex indices_resolve_index.NewResolveIndex // Updates an alias to point to a new index when the existing index // is considered to be too large or too old. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html Rollover indices_rollover.NewRollover // Provides low-level information about segments in a Lucene index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-segments.html Segments indices_segments.NewSegments // Provides store information for shard copies of indices. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shards-stores.html ShardStores indices_shard_stores.NewShardStores // Allow to shrink 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 matching the given index name against the index templates in the // system // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html SimulateIndexTemplate indices_simulate_index_template.NewSimulateIndexTemplate // Simulate resolving the given template name or body // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html SimulateTemplate indices_simulate_template.NewSimulateTemplate // Allows you to split 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 // Provides statistics on operations happening in an index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html Stats indices_stats.NewStats // Unfreezes an index. When a frozen index is unfrozen, the index goes through // the normal recovery process and becomes writeable again. // https://www.elastic.co/guide/en/elasticsearch/reference/current/unfreeze-index-api.html Unfreeze indices_unfreeze.NewUnfreeze // Updates index aliases. // https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html UpdateAliases indices_update_aliases.NewUpdateAliases // Allows a user to validate a potentially expensive query without executing 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 pipeline. // https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-pipeline-api.html DeletePipeline ingest_delete_pipeline.NewDeletePipeline // Returns statistical information about geoip databases // https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html GeoIpStats ingest_geo_ip_stats.NewGeoIpStats // Returns a pipeline. // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-pipeline-api.html GetPipeline ingest_get_pipeline.NewGetPipeline // Returns a list of the built-in patterns. // https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html ProcessorGrok ingest_processor_grok.NewProcessorGrok // Creates or updates a pipeline. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html PutPipeline ingest_put_pipeline.NewPutPipeline // Allows to simulate a pipeline with example 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 // Retrieves licensing information for the cluster // 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 // Starts an indefinite basic license. // https://www.elastic.co/guide/en/elasticsearch/reference/current/start-basic.html PostStartBasic license_post_start_basic.NewPostStartBasic // starts a limited time trial license. // https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trial.html PostStartTrial license_post_start_trial.NewPostStartTrial }
type Logstash ¶
type Logstash struct { // Deletes Logstash Pipelines used by Central Management // https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html DeletePipeline logstash_delete_pipeline.NewDeletePipeline // Retrieves Logstash Pipelines used by Central Management // https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html GetPipeline logstash_get_pipeline.NewGetPipeline // Adds and updates Logstash Pipelines used for 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 the cached results from a trained model deployment // https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-trained-model-deployment-cache.html ClearTrainedModelDeploymentCache ml_clear_trained_model_deployment_cache.NewClearTrainedModelDeploymentCache // Closes one or more anomaly detection jobs. A job can be opened and closed // multiple times throughout its lifecycle. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html CloseJob ml_close_job.NewCloseJob // Deletes a calendar. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html DeleteCalendar ml_delete_calendar.NewDeleteCalendar // Deletes scheduled events from a calendar. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html DeleteCalendarEvent ml_delete_calendar_event.NewDeleteCalendarEvent // Deletes anomaly detection jobs from a calendar. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html DeleteCalendarJob ml_delete_calendar_job.NewDeleteCalendarJob // Deletes an existing data frame analytics job. // https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html DeleteDataFrameAnalytics ml_delete_data_frame_analytics.NewDeleteDataFrameAnalytics // Deletes an existing datafeed. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html DeleteDatafeed ml_delete_datafeed.NewDeleteDatafeed // Deletes expired and unused machine learning data. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html DeleteExpiredData ml_delete_expired_data.NewDeleteExpiredData // Deletes a filter. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html DeleteFilter ml_delete_filter.NewDeleteFilter // Deletes forecasts from a machine learning job. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html DeleteForecast ml_delete_forecast.NewDeleteForecast // Deletes an existing anomaly detection job. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html DeleteJob ml_delete_job.NewDeleteJob // Deletes an existing model snapshot. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html DeleteModelSnapshot ml_delete_model_snapshot.NewDeleteModelSnapshot // Deletes an existing trained inference model that is currently 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 // Deletes a model alias that refers to the trained model // https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html DeleteTrainedModelAlias ml_delete_trained_model_alias.NewDeleteTrainedModelAlias // Estimates the model memory // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html EstimateModelMemory ml_estimate_model_memory.NewEstimateModelMemory // Evaluates the data frame analytics for an annotated index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html EvaluateDataFrame ml_evaluate_data_frame.NewEvaluateDataFrame // Explains a data frame analytics config. // http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html ExplainDataFrameAnalytics ml_explain_data_frame_analytics.NewExplainDataFrameAnalytics // Forces any buffered data to be processed by the job. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html FlushJob ml_flush_job.NewFlushJob // Predicts the future behavior of a time series by using its historical // behavior. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html Forecast ml_forecast.NewForecast // Retrieves anomaly detection job results for one or more buckets. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html GetBuckets ml_get_buckets.NewGetBuckets // Retrieves information about the scheduled events in calendars. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html GetCalendarEvents ml_get_calendar_events.NewGetCalendarEvents // Retrieves configuration information for calendars. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html GetCalendars ml_get_calendars.NewGetCalendars // Retrieves anomaly detection job results for one or more categories. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html GetCategories ml_get_categories.NewGetCategories // Retrieves configuration information for data frame analytics jobs. // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html GetDataFrameAnalytics ml_get_data_frame_analytics.NewGetDataFrameAnalytics // Retrieves usage information for data frame analytics jobs. // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html GetDataFrameAnalyticsStats ml_get_data_frame_analytics_stats.NewGetDataFrameAnalyticsStats // Retrieves usage information for datafeeds. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html GetDatafeedStats ml_get_datafeed_stats.NewGetDatafeedStats // Retrieves configuration information for datafeeds. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html GetDatafeeds ml_get_datafeeds.NewGetDatafeeds // Retrieves filters. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html GetFilters ml_get_filters.NewGetFilters // Retrieves anomaly detection job results for one or more influencers. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html GetInfluencers ml_get_influencers.NewGetInfluencers // Retrieves usage information for anomaly detection jobs. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html GetJobStats ml_get_job_stats.NewGetJobStats // Retrieves configuration information for anomaly detection jobs. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html GetJobs ml_get_jobs.NewGetJobs // Returns information on how ML is using memory. // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html GetMemoryStats ml_get_memory_stats.NewGetMemoryStats // Gets stats for anomaly detection job model snapshot upgrades that are in // progress. // 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 // Retrieves information about model snapshots. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html GetModelSnapshots ml_get_model_snapshots.NewGetModelSnapshots // Retrieves overall bucket results that summarize the bucket results of // multiple anomaly detection jobs. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html GetOverallBuckets ml_get_overall_buckets.NewGetOverallBuckets // Retrieves anomaly records for an anomaly detection job. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html GetRecords ml_get_records.NewGetRecords // Retrieves configuration information for a trained inference model. // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html GetTrainedModels ml_get_trained_models.NewGetTrainedModels // Retrieves usage information for trained inference models. // 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 // Returns defaults and limits used by machine learning. // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html Info ml_info.NewInfo // Opens one or more anomaly detection jobs. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html OpenJob ml_open_job.NewOpenJob // Posts scheduled events in a calendar. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html PostCalendarEvents ml_post_calendar_events.NewPostCalendarEvents // Sends data to an anomaly detection job for analysis. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html PostData ml_post_data.NewPostData // Previews that will be analyzed given a data frame analytics config. // http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html PreviewDataFrameAnalytics ml_preview_data_frame_analytics.NewPreviewDataFrameAnalytics // Previews a datafeed. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html PreviewDatafeed ml_preview_datafeed.NewPreviewDatafeed // Instantiates a calendar. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html PutCalendar ml_put_calendar.NewPutCalendar // Adds an anomaly detection job to a calendar. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html PutCalendarJob ml_put_calendar_job.NewPutCalendarJob // Instantiates a data frame analytics job. // https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html PutDataFrameAnalytics ml_put_data_frame_analytics.NewPutDataFrameAnalytics // Instantiates a datafeed. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html PutDatafeed ml_put_datafeed.NewPutDatafeed // Instantiates a filter. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html PutFilter ml_put_filter.NewPutFilter // Instantiates an anomaly detection job. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html PutJob ml_put_job.NewPutJob // Creates an inference trained model. // https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html PutTrainedModel ml_put_trained_model.NewPutTrainedModel // Creates a new model alias (or reassigns an existing one) to refer to the // trained model // https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html PutTrainedModelAlias ml_put_trained_model_alias.NewPutTrainedModelAlias // Creates 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 // Creates a trained model vocabulary // https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html PutTrainedModelVocabulary ml_put_trained_model_vocabulary.NewPutTrainedModelVocabulary // Resets an existing anomaly detection job. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html ResetJob ml_reset_job.NewResetJob // Reverts to a specific snapshot. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html RevertModelSnapshot ml_revert_model_snapshot.NewRevertModelSnapshot // Sets a cluster wide upgrade_mode setting that prepares machine learning // indices for an upgrade. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html SetUpgradeMode ml_set_upgrade_mode.NewSetUpgradeMode // Starts a data frame analytics job. // https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html StartDataFrameAnalytics ml_start_data_frame_analytics.NewStartDataFrameAnalytics // Starts one or more datafeeds. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html StartDatafeed ml_start_datafeed.NewStartDatafeed // Start a trained model deployment. // https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trained-model-deployment.html StartTrainedModelDeployment ml_start_trained_model_deployment.NewStartTrainedModelDeployment // Stops one or more data frame analytics jobs. // https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html StopDataFrameAnalytics ml_stop_data_frame_analytics.NewStopDataFrameAnalytics // Stops one or more datafeeds. // 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 // Updates certain properties of a data frame analytics job. // https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html UpdateDataFrameAnalytics ml_update_data_frame_analytics.NewUpdateDataFrameAnalytics // Updates certain properties of a datafeed. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html UpdateDatafeed ml_update_datafeed.NewUpdateDatafeed // Updates the description of a filter, adds items, or removes items. // https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html UpdateFilter ml_update_filter.NewUpdateFilter // 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 // 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 // Upgrades a given job snapshot to the current major version. // 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 { // Removes the archived repositories metering information present 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 // Returns cluster repositories metering information. // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html GetRepositoriesMeteringInfo nodes_get_repositories_metering_info.NewGetRepositoriesMeteringInfo // Returns information about hot threads on each node in the cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html HotThreads nodes_hot_threads.NewHotThreads // Returns information about nodes in the cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html Info nodes_info.NewInfo // Reloads secure settings. // https://www.elastic.co/guide/en/elasticsearch/reference/current/secure-settings.html#reloadable-secure-settings ReloadSecureSettings nodes_reload_secure_settings.NewReloadSecureSettings // Returns statistical information about nodes in the cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html Stats nodes_stats.NewStats // Returns low-level information about REST actions usage on nodes. // https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-usage.html Usage nodes_usage.NewUsage }
type QueryRuleset ¶ added in v8.10.0
type QueryRuleset struct { // Deletes a query ruleset. // https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-query-ruleset.html Delete query_ruleset_delete.NewDelete // Returns the details about a query ruleset. // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-query-ruleset.html Get query_ruleset_get.NewGet // Lists query rulesets. // https://www.elastic.co/guide/en/elasticsearch/reference/current/list-query-rulesets.html List query_ruleset_list.NewList // Creates or updates a query ruleset. // https://www.elastic.co/guide/en/elasticsearch/reference/current/put-query-ruleset.html Put query_ruleset_put.NewPut }
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 (e.g. // 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 { // Deletes a search application. // https://www.elastic.co/guide/en/elasticsearch/reference/current/put-search-application.html Delete search_application_delete.NewDelete // Delete a behavioral analytics collection. // https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-analytics-collection.html DeleteBehavioralAnalytics search_application_delete_behavioral_analytics.NewDeleteBehavioralAnalytics // Returns the details about a search application. // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-search-application.html Get search_application_get.NewGet // Returns the existing 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 // Creates or updates a search application. // https://www.elastic.co/guide/en/elasticsearch/reference/current/put-search-application.html Put search_application_put.NewPut // Creates a behavioral analytics collection. // https://www.elastic.co/guide/en/elasticsearch/reference/current/put-analytics-collection.html PutBehavioralAnalytics search_application_put_behavioral_analytics.NewPutBehavioralAnalytics // Perform a search against a search application // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-application-search.html Search search_application_search.NewSearch }
type SearchableSnapshots ¶ added in v8.7.1
type SearchableSnapshots struct { // Retrieve node-level cache statistics about searchable snapshots. // https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html CacheStats searchable_snapshots_cache_stats.NewCacheStats // Clear the cache of searchable snapshots. // https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html ClearCache searchable_snapshots_clear_cache.NewClearCache // Mount a snapshot as a searchable index. // https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-mount-snapshot.html Mount searchable_snapshots_mount.NewMount // Retrieve shard-level statistics about searchable snapshots. // https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html Stats searchable_snapshots_stats.NewStats }
type Security ¶
type Security struct { // Creates or updates the 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 // Enables authentication as a user and retrieve information about the // authenticated user. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html Authenticate security_authenticate.NewAuthenticate // 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 // Changes 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 a subset or all entries from the API key cache. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html ClearApiKeyCache security_clear_api_key_cache.NewClearApiKeyCache // Evicts application privileges from the native application privileges cache. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html ClearCachedPrivileges security_clear_cached_privileges.NewClearCachedPrivileges // Evicts users from the user cache. 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 // Evicts 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 // Evicts tokens 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 // Creates an API key for access without requiring basic authentication. // 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 // Creates a service account 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 // Removes application privileges. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html DeletePrivileges security_delete_privileges.NewDeletePrivileges // Removes roles in the native realm. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html DeleteRole security_delete_role.NewDeleteRole // Removes role mappings. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html DeleteRoleMapping security_delete_role_mapping.NewDeleteRoleMapping // Deletes a service account token. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html DeleteServiceToken security_delete_service_token.NewDeleteServiceToken // Deletes users from the native realm. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html DeleteUser security_delete_user.NewDeleteUser // Disables users in the native realm. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html DisableUser security_disable_user.NewDisableUser // Disables a user profile so it's 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 // Enables users in the native realm. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html EnableUser security_enable_user.NewEnableUser // Enables a user profile so it's 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 // Allows a kibana instance to configure itself to communicate with a secured // elasticsearch cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-kibana-enrollment.html EnrollKibana security_enroll_kibana.NewEnrollKibana // Allows a new node to enroll to an existing cluster with security enabled. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-node-enrollment.html EnrollNode security_enroll_node.NewEnrollNode // Retrieves information for one or more API keys. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html GetApiKey security_get_api_key.NewGetApiKey // Retrieves 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 // Retrieves application privileges. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html GetPrivileges security_get_privileges.NewGetPrivileges // Retrieves roles in the native realm. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html GetRole security_get_role.NewGetRole // Retrieves role mappings. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html GetRoleMapping security_get_role_mapping.NewGetRoleMapping // Retrieves information about service accounts. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html GetServiceAccounts security_get_service_accounts.NewGetServiceAccounts // Retrieves information of all service credentials for a service account. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html GetServiceCredentials security_get_service_credentials.NewGetServiceCredentials // Creates 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 // Retrieves 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 // Retrieves security privileges for the logged in user. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html GetUserPrivileges security_get_user_privileges.NewGetUserPrivileges // Retrieves user profiles for the given unique ID(s). // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html GetUserProfile security_get_user_profile.NewGetUserProfile // Creates an API key on behalf of another user. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html GrantApiKey security_grant_api_key.NewGrantApiKey // Determines 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 // Determines whether the users associated with the specified 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 // Invalidates one or more API keys. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html InvalidateApiKey security_invalidate_api_key.NewInvalidateApiKey // Invalidates one or more access tokens or refresh tokens. // 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 // Adds or updates application privileges. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html PutPrivileges security_put_privileges.NewPutPrivileges // Adds and updates roles in the native realm. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html PutRole security_put_role.NewPutRole // Creates and updates role mappings. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html PutRoleMapping security_put_role_mapping.NewPutRoleMapping // Adds and updates users in the native realm. These users are commonly referred // to as native users. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html PutUser security_put_user.NewPutUser // Retrieves information for API keys using a subset of query DSL // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html QueryApiKeys security_query_api_keys.NewQueryApiKeys // Exchanges a SAML Response message for an Elasticsearch access token and // refresh token pair // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html SamlAuthenticate security_saml_authenticate.NewSamlAuthenticate // 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 // Consumes a SAML LogoutRequest // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html SamlInvalidate security_saml_invalidate.NewSamlInvalidate // Invalidates an access token and a refresh token that were generated via the // SAML Authenticate API // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html SamlLogout security_saml_logout.NewSamlLogout // Creates a SAML authentication request // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html SamlPrepareAuthentication security_saml_prepare_authentication.NewSamlPrepareAuthentication // Generates SAML metadata for the Elastic stack 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 // 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 // Updates attributes of an existing API key. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html UpdateApiKey security_update_api_key.NewUpdateApiKey // Update application specific data for the user profile of the given 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 { // Removes stale data from repository. // 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 // 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 { // Retrieves information about the X.509 certificates used to encrypt // communications in the cluster. // https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html Certificates ssl_certificates.NewCertificates }
type Synonyms ¶ added in v8.10.0
type Synonyms struct { // Deletes a synonym set // https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-synonyms-set.html DeleteSynonym synonyms_delete_synonym.NewDeleteSynonym // Deletes a synonym rule in a synonym set // https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-synonym-rule.html DeleteSynonymRule synonyms_delete_synonym_rule.NewDeleteSynonymRule // Retrieves a synonym set // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-synonyms-set.html GetSynonym synonyms_get_synonym.NewGetSynonym // Retrieves a synonym rule from a synonym set // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-synonym-rule.html GetSynonymRule synonyms_get_synonym_rule.NewGetSynonymRule // Retrieves a summary of all defined synonym sets // https://www.elastic.co/guide/en/elasticsearch/reference/current/list-synonyms-sets.html GetSynonymsSets synonyms_get_synonyms_sets.NewGetSynonymsSets // Creates or updates a synonyms set // https://www.elastic.co/guide/en/elasticsearch/reference/current/put-synonyms-set.html PutSynonym synonyms_put_synonym.NewPutSynonym // Creates or updates a synonym rule in a synonym set // https://www.elastic.co/guide/en/elasticsearch/reference/current/put-synonym-rule.html PutSynonymRule synonyms_put_synonym_rule.NewPutSynonymRule }
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 // Returns information about a task. // https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html Get tasks_get.NewGet // Returns a list of tasks. // 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 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 }
type Transform ¶
type Transform struct { // Deletes an existing transform. // https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html DeleteTransform transform_delete_transform.NewDeleteTransform // Retrieves configuration information for transforms. // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html GetTransform transform_get_transform.NewGetTransform // Retrieves usage information for transforms. // https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html GetTransformStats transform_get_transform_stats.NewGetTransformStats // Previews a transform. // https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html PreviewTransform transform_preview_transform.NewPreviewTransform // Instantiates a transform. // https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html PutTransform transform_put_transform.NewPutTransform // Resets an existing transform. // https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html ResetTransform transform_reset_transform.NewResetTransform // Schedules now a transform. // https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html ScheduleNowTransform transform_schedule_now_transform.NewScheduleNowTransform // Starts one or more transforms. // https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html StartTransform transform_start_transform.NewStartTransform // Stops one or more transforms. // https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html StopTransform transform_stop_transform.NewStopTransform // Updates certain properties of a transform. // https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html UpdateTransform transform_update_transform.NewUpdateTransform // Upgrades all transforms. // 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 // Forces the execution of a stored watch. // 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 { // Retrieves information about the installed X-Pack features. // https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html Info xpack_info.NewInfo // Retrieves usage information about the installed X-Pack features. // https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html Usage xpack_usage.NewUsage }
Directories ¶
Path | Synopsis |
---|---|
asyncsearch
|
|
delete
Deletes an async search by ID.
|
Deletes an async search by ID. |
get
Retrieves the results of a previously submitted async search request given its ID.
|
Retrieves the results of a previously submitted async search request given its ID. |
status
Retrieves the status of a previously submitted async search request given its ID.
|
Retrieves the status of a previously submitted async search request given its ID. |
submit
Executes a search request asynchronously.
|
Executes a search request asynchronously. |
autoscaling
|
|
deleteautoscalingpolicy
Deletes an autoscaling policy.
|
Deletes an autoscaling policy. |
getautoscalingcapacity
Gets the current autoscaling capacity based on the configured autoscaling policy.
|
Gets the current autoscaling capacity based on the configured autoscaling policy. |
getautoscalingpolicy
Retrieves an autoscaling policy.
|
Retrieves an autoscaling policy. |
putautoscalingpolicy
Creates a new autoscaling policy.
|
Creates a new autoscaling policy. |
cat
|
|
aliases
Shows information about currently configured aliases to indices including filter and routing infos.
|
Shows information about currently configured aliases to indices including filter and routing infos. |
allocation
Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
|
Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. |
componenttemplates
Returns information about existing component_templates templates.
|
Returns information about existing component_templates templates. |
count
Provides quick access to the document count of the entire cluster, or individual indices.
|
Provides quick access to the document count of the entire cluster, or individual indices. |
fielddata
Shows how much heap memory is currently being used by fielddata on every data node in the cluster.
|
Shows how much heap memory is currently being used by fielddata on every data node in the cluster. |
health
Returns a concise representation of the cluster health.
|
Returns a concise representation of the cluster health. |
help
Returns help for the Cat APIs.
|
Returns help for the Cat APIs. |
indices
Returns information about indices: number of primaries and replicas, document counts, disk size, ...
|
Returns information about indices: number of primaries and replicas, document counts, disk size, ... |
master
Returns information about the master node.
|
Returns information about the master node. |
mldatafeeds
Gets configuration and usage information about datafeeds.
|
Gets configuration and usage information about datafeeds. |
mldataframeanalytics
Gets configuration and usage information about data frame analytics jobs.
|
Gets configuration and usage information about data frame analytics jobs. |
mljobs
Gets configuration and usage information about anomaly detection jobs.
|
Gets configuration and usage information about anomaly detection jobs. |
mltrainedmodels
Gets configuration and usage information about inference trained models.
|
Gets configuration and usage information about inference trained models. |
nodeattrs
Returns information about custom node attributes.
|
Returns information about custom node attributes. |
nodes
Returns basic statistics about performance of cluster nodes.
|
Returns basic statistics about performance of cluster nodes. |
pendingtasks
Returns a concise representation of the cluster pending tasks.
|
Returns a concise representation of the cluster pending tasks. |
plugins
Returns information about installed plugins across nodes node.
|
Returns information about installed plugins across nodes node. |
recovery
Returns information about index shard recoveries, both on-going completed.
|
Returns information about index shard recoveries, both on-going completed. |
repositories
Returns information about snapshot repositories registered in the cluster.
|
Returns information about snapshot repositories registered in the cluster. |
segments
Provides low-level information about the segments in the shards of an index.
|
Provides low-level information about the segments in the shards of an index. |
shards
Provides a detailed view of shard allocation on nodes.
|
Provides a detailed view of shard allocation on nodes. |
snapshots
Returns all snapshots in a specific repository.
|
Returns all snapshots in a specific repository. |
tasks
Returns information about the tasks currently executing on one or more nodes in the cluster.
|
Returns information about the tasks currently executing on one or more nodes in the cluster. |
templates
Returns information about existing templates.
|
Returns information about existing templates. |
threadpool
Returns cluster-wide thread pool statistics per node.
|
Returns cluster-wide thread pool statistics per node. |
transforms
Gets configuration and usage information about transforms.
|
Gets configuration and usage information about 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
Deletes a component template
|
Deletes a component template |
deletevotingconfigexclusions
Clears cluster voting config exclusions.
|
Clears cluster voting config exclusions. |
existscomponenttemplate
Returns information about whether a particular component template exist
|
Returns information about whether a particular component template exist |
getcomponenttemplate
Returns one or more component templates
|
Returns one or more component templates |
getsettings
Returns cluster settings.
|
Returns cluster settings. |
health
Returns basic information about the health of the cluster.
|
Returns basic information about the health of the cluster. |
info
Returns different information about the cluster.
|
Returns different information about the cluster. |
pendingtasks
Returns a list of any cluster-level changes (e.g.
|
Returns a list of any cluster-level changes (e.g. |
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
Creates or updates a component template
|
Creates or updates a component template |
putsettings
Updates the cluster settings.
|
Updates the cluster settings. |
remoteinfo
Returns the information about configured remote clusters.
|
Returns the information about configured remote clusters. |
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 high-level overview of cluster statistics.
|
Returns high-level overview of cluster statistics. |
core
|
|
bulk
Allows to perform multiple index/update/delete operations in a single request.
|
Allows to perform multiple index/update/delete operations in a single request. |
clearscroll
Explicitly clears the search context for a scroll.
|
Explicitly clears the search context for a scroll. |
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
Creates a new document in the index.
|
Creates a new document in the index. |
delete
Removes a document from the index.
|
Removes a document from the index. |
deletebyquery
Deletes documents matching the provided query.
|
Deletes documents matching the provided query. |
deletebyqueryrethrottle
Changes the number of requests per second for a particular Delete By Query operation.
|
Changes the number of requests per second for a particular Delete By Query operation. |
deletescript
Deletes a script.
|
Deletes a script. |
exists
Returns information about whether a document exists in an index.
|
Returns information about whether a document exists in an index. |
existssource
Returns information about whether a document source exists in an index.
|
Returns information about whether a document source exists in an index. |
explain
Returns information about why a specific matches (or doesn't match) a query.
|
Returns information about why a specific matches (or doesn't match) a query. |
fieldcaps
Returns the information about the capabilities of fields among multiple indices.
|
Returns the information about the capabilities of fields among multiple indices. |
get
Returns a document.
|
Returns a document. |
getscript
Returns a script.
|
Returns a script. |
getscriptcontext
Returns all script contexts.
|
Returns all script contexts. |
getscriptlanguages
Returns available script types, languages and contexts
|
Returns available script types, languages and contexts |
getsource
Returns the source of a document.
|
Returns the source of a document. |
healthreport
Returns the health of the cluster.
|
Returns the health of the cluster. |
index
Creates or updates a document in an index.
|
Creates or updates a document in an index. |
info
Returns basic information about the cluster.
|
Returns basic information about the cluster. |
knnsearch
Performs a kNN search.
|
Performs a kNN search. |
mget
Allows to get multiple documents in one request.
|
Allows to get multiple documents in one request. |
msearch
Allows to execute several search operations in one request.
|
Allows to execute several search operations in one request. |
msearchtemplate
Allows to execute several search template operations in one request.
|
Allows to execute several search template operations in one request. |
mtermvectors
Returns multiple termvectors in one request.
|
Returns multiple termvectors in one request. |
openpointintime
Open a point in time that can be used in subsequent searches
|
Open a point in time that can be used in subsequent searches |
ping
Returns whether the cluster is running.
|
Returns whether the cluster is running. |
putscript
Creates or updates a script.
|
Creates or updates a script. |
rankeval
Allows to evaluate the quality of ranked search results over a set of typical search queries
|
Allows to evaluate the quality of ranked search results over a set of typical search queries |
reindex
Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
|
Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster. |
reindexrethrottle
Changes the number of requests per second for a particular Reindex operation.
|
Changes the number of requests per second for a particular Reindex operation. |
rendersearchtemplate
Allows to use the Mustache language to pre-render a search definition.
|
Allows to use the Mustache language to pre-render a search definition. |
scriptspainlessexecute
Allows an arbitrary script to be executed and a result to be returned
|
Allows an arbitrary script to be executed and a result to be returned |
scroll
Allows to retrieve a large numbers of results from a single search request.
|
Allows to retrieve a large numbers of results from a single search request. |
search
Returns results matching a query.
|
Returns results matching a query. |
searchmvt
Searches a vector tile for geospatial values.
|
Searches a vector tile for geospatial values. |
searchshards
Returns information about the indices and shards that a search request would be executed against.
|
Returns information about the indices and shards that a search request would be executed against. |
searchtemplate
Allows to use the Mustache language to pre-render a search definition.
|
Allows to use the Mustache language to pre-render a search definition. |
termsenum
The terms enum API can be used to discover terms in the index that begin with the provided string.
|
The terms enum API can be used to discover terms in the index that begin with the provided string. |
termvectors
Returns information and statistics about terms in the fields of a particular document.
|
Returns information and statistics about terms in the fields of a particular document. |
update
Updates a document with a script or partial document.
|
Updates a document with a script or partial document. |
updatebyquery
Performs an update on every document in the index without changing the source, for example to pick up a mapping change.
|
Performs an update on every document in the index without changing the source, for example to pick up a mapping change. |
updatebyqueryrethrottle
Changes the number of requests per second for a particular Update By Query operation.
|
Changes the number of requests per second for a particular Update By Query operation. |
danglingindices
|
|
deletedanglingindex
Deletes the specified dangling index
|
Deletes the specified dangling index |
importdanglingindex
Imports the specified dangling index
|
Imports the specified dangling index |
listdanglingindices
Returns all dangling indices.
|
Returns all dangling indices. |
enrich
|
|
deletepolicy
Deletes an existing enrich policy and its enrich index.
|
Deletes an existing enrich policy and its enrich index. |
executepolicy
Creates the enrich index for an existing enrich policy.
|
Creates the enrich index for an existing enrich policy. |
getpolicy
Gets information about an enrich policy.
|
Gets information about an enrich policy. |
putpolicy
Creates a new enrich policy.
|
Creates a new enrich policy. |
stats
Gets enrich coordinator statistics and information about enrich policies that are currently executing.
|
Gets enrich coordinator statistics and information about enrich policies that are currently executing. |
eql
|
|
delete
Deletes an async EQL search by ID.
|
Deletes an async EQL search by ID. |
get
Returns async results from previously executed Event Query Language (EQL) search
|
Returns async results from previously executed Event Query Language (EQL) search |
getstatus
Returns the status of a previously submitted async or stored Event Query Language (EQL) search
|
Returns the status of a previously submitted async or stored Event Query Language (EQL) search |
search
Returns results matching a query expressed in Event Query Language (EQL)
|
Returns results matching a query expressed in Event Query Language (EQL) |
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
Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh.
|
Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. |
search
Search API where the search will only be executed after specified checkpoints are available due to a refresh.
|
Search API where the search will only be executed after specified checkpoints are available due to a refresh. |
graph
|
|
explore
Explore extracted and summarized information about the documents and terms in an index.
|
Explore extracted and summarized information about the documents and terms in an 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
Returns the specified policy definition.
|
Returns the specified policy definition. |
getstatus
Retrieves the current index lifecycle management (ILM) status.
|
Retrieves the current index lifecycle management (ILM) status. |
migratetodatatiers
Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing
|
Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing |
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
Adds a block to an index.
|
Adds a block to an index. |
analyze
Performs the analysis process on a text and return the tokens breakdown of the text.
|
Performs the analysis process on a text and return the tokens breakdown of the text. |
clearcache
Clears all or specific caches for one or more indices.
|
Clears all or specific caches for one or more indices. |
clone
Clones an index
|
Clones an index |
close
Closes an index.
|
Closes an index. |
create
Creates an index with optional settings and mappings.
|
Creates an index with optional settings and mappings. |
createdatastream
Creates a data stream
|
Creates a data stream |
datastreamsstats
Provides statistics on operations happening in a data stream.
|
Provides statistics on operations happening in a data stream. |
delete
Deletes an index.
|
Deletes an index. |
deletealias
Deletes an alias.
|
Deletes an alias. |
deletedatalifecycle
Deletes the data stream lifecycle of the selected data streams.
|
Deletes the data stream lifecycle of the selected data streams. |
deletedatastream
Deletes a data stream.
|
Deletes a data stream. |
deleteindextemplate
Deletes an index template.
|
Deletes an index template. |
deletetemplate
Deletes an index template.
|
Deletes an 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
Downsample an index
|
Downsample an index |
exists
Returns information about whether a particular index exists.
|
Returns information about whether a particular index exists. |
existsalias
Returns information about whether a particular alias exists.
|
Returns information about whether a particular alias exists. |
existsindextemplate
Returns information about whether a particular index template exists.
|
Returns information about whether a particular index template exists. |
existstemplate
Returns information about whether a particular index template exists.
|
Returns information about whether a particular index template exists. |
explaindatalifecycle
Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc.
|
Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc. |
fieldusagestats
Returns the field usage stats for each field of an index
|
Returns the field usage stats for each field of an index |
flush
Performs the flush operation on one or more indices.
|
Performs the flush operation on one or more indices. |
forcemerge
Performs the force merge operation on one or more indices.
|
Performs the force merge operation on one or more indices. |
get
Returns information about one or more indices.
|
Returns information about one or more indices. |
getalias
Returns an alias.
|
Returns an alias. |
getdatalifecycle
Returns the data stream lifecycle of the selected data streams.
|
Returns the data stream lifecycle of the selected data streams. |
getdatastream
Returns data streams.
|
Returns data streams. |
getfieldmapping
Returns mapping for one or more fields.
|
Returns mapping for one or more fields. |
getindextemplate
Returns an index template.
|
Returns an index template. |
getmapping
Returns mappings for one or more indices.
|
Returns mappings for one or more indices. |
getsettings
Returns settings for one or more indices.
|
Returns settings for one or more indices. |
gettemplate
Returns an index template.
|
Returns an index template. |
migratetodatastream
Migrates an alias to a data stream
|
Migrates an alias to a data stream |
modifydatastream
Modifies a data stream
|
Modifies a data stream |
open
Opens an index.
|
Opens an 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
Creates or updates an alias.
|
Creates or updates an alias. |
putdatalifecycle
Updates the data stream lifecycle of the selected data streams.
|
Updates the data stream lifecycle of the selected data streams. |
putindextemplate
Creates or updates an index template.
|
Creates or updates an index template. |
putmapping
Updates the index mappings.
|
Updates the index mappings. |
putsettings
Updates the index settings.
|
Updates the index settings. |
puttemplate
Creates or updates an index template.
|
Creates or updates an index template. |
recovery
Returns information about ongoing index shard recoveries.
|
Returns information about ongoing index shard recoveries. |
refresh
Performs the refresh operation in one or more indices.
|
Performs the refresh operation in one or more indices. |
reloadsearchanalyzers
Reloads an index's search analyzers and their resources.
|
Reloads an index's search analyzers and their resources. |
resolveindex
Returns information about any matching indices, aliases, and data streams
|
Returns information about any matching indices, aliases, and data streams |
rollover
Updates an alias to point to a new index when the existing index is considered to be too large or too old.
|
Updates an alias to point to a new index when the existing index is considered to be too large or too old. |
segments
Provides low-level information about segments in a Lucene index.
|
Provides low-level information about segments in a Lucene index. |
shardstores
Provides store information for shard copies of indices.
|
Provides store information for shard copies of indices. |
shrink
Allow to shrink an existing index into a new index with fewer primary shards.
|
Allow to shrink an existing index into a new index with fewer primary shards. |
simulateindextemplate
Simulate matching the given index name against the index templates in the system
|
Simulate matching the given index name against the index templates in the system |
simulatetemplate
Simulate resolving the given template name or body
|
Simulate resolving the given template name or body |
split
Allows you to split an existing index into a new index with more primary shards.
|
Allows you to split an existing index into a new index with more primary shards. |
stats
Provides statistics on operations happening in an index.
|
Provides statistics on operations happening in an index. |
unfreeze
Unfreezes an index.
|
Unfreezes an index. |
updatealiases
Updates index aliases.
|
Updates index aliases. |
validatequery
Allows a user to validate a potentially expensive query without executing it.
|
Allows a user to validate a potentially expensive query without executing it. |
ingest
|
|
deletepipeline
Deletes a pipeline.
|
Deletes a pipeline. |
geoipstats
Returns statistical information about geoip databases
|
Returns statistical information about geoip databases |
getpipeline
Returns a pipeline.
|
Returns a pipeline. |
processorgrok
Returns a list of the built-in patterns.
|
Returns a list of the built-in patterns. |
putpipeline
Creates or updates a pipeline.
|
Creates or updates a pipeline. |
simulate
Allows to simulate a pipeline with example documents.
|
Allows to simulate a pipeline with example documents. |
license
|
|
delete
Deletes licensing information for the cluster
|
Deletes licensing information for the cluster |
get
Retrieves licensing information for the cluster
|
Retrieves licensing information for the cluster |
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
Starts an indefinite basic license.
|
Starts an indefinite basic license. |
poststarttrial
starts a limited time trial license.
|
starts a limited time trial license. |
logstash
|
|
deletepipeline
Deletes Logstash Pipelines used by Central Management
|
Deletes Logstash Pipelines used by Central Management |
getpipeline
Retrieves Logstash Pipelines used by Central Management
|
Retrieves Logstash Pipelines used by Central Management |
putpipeline
Adds and updates Logstash Pipelines used for Central Management
|
Adds and updates Logstash Pipelines used for 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 the cached results from a trained model deployment
|
Clear the cached results from a trained model deployment |
closejob
Closes one or more anomaly detection jobs.
|
Closes one or more anomaly detection jobs. |
deletecalendar
Deletes a calendar.
|
Deletes a calendar. |
deletecalendarevent
Deletes scheduled events from a calendar.
|
Deletes scheduled events from a calendar. |
deletecalendarjob
Deletes anomaly detection jobs from a calendar.
|
Deletes anomaly detection jobs from a calendar. |
deletedatafeed
Deletes an existing datafeed.
|
Deletes an existing datafeed. |
deletedataframeanalytics
Deletes an existing data frame analytics job.
|
Deletes an existing data frame analytics job. |
deleteexpireddata
Deletes expired and unused machine learning data.
|
Deletes expired and unused machine learning data. |
deletefilter
Deletes a filter.
|
Deletes a filter. |
deleteforecast
Deletes forecasts from a machine learning job.
|
Deletes forecasts from a machine learning job. |
deletejob
Deletes an existing anomaly detection job.
|
Deletes an existing anomaly detection job. |
deletemodelsnapshot
Deletes an existing model snapshot.
|
Deletes an existing model snapshot. |
deletetrainedmodel
Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
|
Deletes an existing trained inference model that is currently not referenced by an ingest pipeline. |
deletetrainedmodelalias
Deletes a model alias that refers to the trained model
|
Deletes a model alias that refers to the trained model |
estimatemodelmemory
Estimates the model memory
|
Estimates the model memory |
evaluatedataframe
Evaluates the data frame analytics for an annotated index.
|
Evaluates the data frame analytics for an annotated index. |
explaindataframeanalytics
Explains a data frame analytics config.
|
Explains a data frame analytics config. |
flushjob
Forces any buffered data to be processed by the job.
|
Forces any buffered data to be processed by the job. |
forecast
Predicts the future behavior of a time series by using its historical behavior.
|
Predicts the future behavior of a time series by using its historical behavior. |
getbuckets
Retrieves anomaly detection job results for one or more buckets.
|
Retrieves anomaly detection job results for one or more buckets. |
getcalendarevents
Retrieves information about the scheduled events in calendars.
|
Retrieves information about the scheduled events in calendars. |
getcalendars
Retrieves configuration information for calendars.
|
Retrieves configuration information for calendars. |
getcategories
Retrieves anomaly detection job results for one or more categories.
|
Retrieves anomaly detection job results for one or more categories. |
getdatafeeds
Retrieves configuration information for datafeeds.
|
Retrieves configuration information for datafeeds. |
getdatafeedstats
Retrieves usage information for datafeeds.
|
Retrieves usage information for datafeeds. |
getdataframeanalytics
Retrieves configuration information for data frame analytics jobs.
|
Retrieves configuration information for data frame analytics jobs. |
getdataframeanalyticsstats
Retrieves usage information for data frame analytics jobs.
|
Retrieves usage information for data frame analytics jobs. |
getfilters
Retrieves filters.
|
Retrieves filters. |
getinfluencers
Retrieves anomaly detection job results for one or more influencers.
|
Retrieves anomaly detection job results for one or more influencers. |
getjobs
Retrieves configuration information for anomaly detection jobs.
|
Retrieves configuration information for anomaly detection jobs. |
getjobstats
Retrieves usage information for anomaly detection jobs.
|
Retrieves usage information for anomaly detection jobs. |
getmemorystats
Returns information on how ML is using memory.
|
Returns information on how ML is using memory. |
getmodelsnapshots
Retrieves information about model snapshots.
|
Retrieves information about model snapshots. |
getmodelsnapshotupgradestats
Gets stats for anomaly detection job model snapshot upgrades that are in progress.
|
Gets stats for anomaly detection job model snapshot upgrades that are in progress. |
getoverallbuckets
Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
|
Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. |
getrecords
Retrieves anomaly records for an anomaly detection job.
|
Retrieves anomaly records for an anomaly detection job. |
gettrainedmodels
Retrieves configuration information for a trained inference model.
|
Retrieves configuration information for a trained inference model. |
gettrainedmodelsstats
Retrieves usage information for trained inference models.
|
Retrieves usage information for trained inference models. |
infertrainedmodel
Evaluate a trained model.
|
Evaluate a trained model. |
info
Returns defaults and limits used by machine learning.
|
Returns defaults and limits used by machine learning. |
openjob
Opens one or more anomaly detection jobs.
|
Opens one or more anomaly detection jobs. |
postcalendarevents
Posts scheduled events in a calendar.
|
Posts scheduled events in a calendar. |
postdata
Sends data to an anomaly detection job for analysis.
|
Sends data to an anomaly detection job for analysis. |
previewdatafeed
Previews a datafeed.
|
Previews a datafeed. |
previewdataframeanalytics
Previews that will be analyzed given a data frame analytics config.
|
Previews that will be analyzed given a data frame analytics config. |
putcalendar
Instantiates a calendar.
|
Instantiates a calendar. |
putcalendarjob
Adds an anomaly detection job to a calendar.
|
Adds an anomaly detection job to a calendar. |
putdatafeed
Instantiates a datafeed.
|
Instantiates a datafeed. |
putdataframeanalytics
Instantiates a data frame analytics job.
|
Instantiates a data frame analytics job. |
putfilter
Instantiates a filter.
|
Instantiates a filter. |
putjob
Instantiates an anomaly detection job.
|
Instantiates an anomaly detection job. |
puttrainedmodel
Creates an inference trained model.
|
Creates an inference trained model. |
puttrainedmodelalias
Creates a new model alias (or reassigns an existing one) to refer to the trained model
|
Creates a new model alias (or reassigns an existing one) to refer to the trained model |
puttrainedmodeldefinitionpart
Creates part of a trained model definition
|
Creates part of a trained model definition |
puttrainedmodelvocabulary
Creates a trained model vocabulary
|
Creates a trained model vocabulary |
resetjob
Resets an existing anomaly detection job.
|
Resets an existing anomaly detection job. |
revertmodelsnapshot
Reverts to a specific snapshot.
|
Reverts to a specific snapshot. |
setupgrademode
Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.
|
Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. |
startdatafeed
Starts one or more datafeeds.
|
Starts one or more datafeeds. |
startdataframeanalytics
Starts a data frame analytics job.
|
Starts a data frame analytics job. |
starttrainedmodeldeployment
Start a trained model deployment.
|
Start a trained model deployment. |
stopdatafeed
Stops one or more datafeeds.
|
Stops one or more datafeeds. |
stopdataframeanalytics
Stops one or more data frame analytics jobs.
|
Stops one or more data frame analytics jobs. |
stoptrainedmodeldeployment
Stop a trained model deployment.
|
Stop a trained model deployment. |
updatedatafeed
Updates certain properties of a datafeed.
|
Updates certain properties of a datafeed. |
updatedataframeanalytics
Updates certain properties of a data frame analytics job.
|
Updates certain properties of a data frame analytics job. |
updatefilter
Updates the description of a filter, adds items, or removes items.
|
Updates the description of a filter, adds items, or removes items. |
updatejob
Updates certain properties of an anomaly detection job.
|
Updates certain properties of an anomaly detection job. |
updatemodelsnapshot
Updates certain properties of a snapshot.
|
Updates certain properties of a snapshot. |
upgradejobsnapshot
Upgrades a given job snapshot to the current major version.
|
Upgrades a given job snapshot to the current major version. |
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
Removes the archived repositories metering information present in the cluster.
|
Removes the archived repositories metering information present in the cluster. |
getrepositoriesmeteringinfo
Returns cluster repositories metering information.
|
Returns cluster repositories metering information. |
hotthreads
Returns information about hot threads on each node in the cluster.
|
Returns information about hot threads on each node in the cluster. |
info
Returns information about nodes in the cluster.
|
Returns information about nodes in the cluster. |
reloadsecuresettings
Reloads secure settings.
|
Reloads secure settings. |
stats
Returns statistical information about nodes in the cluster.
|
Returns statistical information about nodes in the cluster. |
usage
Returns low-level information about REST actions usage on nodes.
|
Returns low-level information about REST actions usage on nodes. |
queryruleset
|
|
delete
Deletes a query ruleset.
|
Deletes a query ruleset. |
get
Returns the details about a query ruleset.
|
Returns the details about a query ruleset. |
list
Lists query rulesets.
|
Lists query rulesets. |
put
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 (e.g.
|
Returns the rollup capabilities of all jobs inside of a rollup index (e.g. |
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
Deletes a search application.
|
Deletes a search application. |
deletebehavioralanalytics
Delete a behavioral analytics collection.
|
Delete a behavioral analytics collection. |
get
Returns the details about a search application.
|
Returns the details about a search application. |
getbehavioralanalytics
Returns the existing behavioral analytics collections.
|
Returns the existing behavioral analytics collections. |
list
Returns the existing search applications.
|
Returns the existing search applications. |
put
Creates or updates a search application.
|
Creates or updates a search application. |
putbehavioralanalytics
Creates a behavioral analytics collection.
|
Creates a behavioral analytics collection. |
search
Perform a search against a search application
|
Perform a search against a search application |
security
|
|
activateuserprofile
Creates or updates the user profile on behalf of another user.
|
Creates or updates the user profile on behalf of another user. |
authenticate
Enables authentication as a user and retrieve information about the authenticated user.
|
Enables authentication as a user and retrieve information about the authenticated user. |
bulkupdateapikeys
Updates the attributes of multiple existing API keys.
|
Updates the attributes of multiple existing API keys. |
changepassword
Changes the passwords of users in the native realm and built-in users.
|
Changes the passwords of users in the native realm and built-in users. |
clearapikeycache
Clear a subset or all entries from the API key cache.
|
Clear a subset or all entries from the API key cache. |
clearcachedprivileges
Evicts application privileges from the native application privileges cache.
|
Evicts application privileges from the native application privileges cache. |
clearcachedrealms
Evicts users from the user cache.
|
Evicts users from the user cache. |
clearcachedroles
Evicts roles from the native role cache.
|
Evicts roles from the native role cache. |
clearcachedservicetokens
Evicts tokens from the service account token caches.
|
Evicts tokens from the service account token caches. |
createapikey
Creates an API key for access without requiring basic authentication.
|
Creates an API key for access without requiring basic authentication. |
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
Creates a service account token for access without requiring basic authentication.
|
Creates a service account token for access without requiring basic authentication. |
deleteprivileges
Removes application privileges.
|
Removes application privileges. |
deleterole
Removes roles in the native realm.
|
Removes roles in the native realm. |
deleterolemapping
Removes role mappings.
|
Removes role mappings. |
deleteservicetoken
Deletes a service account token.
|
Deletes a service account token. |
deleteuser
Deletes users from the native realm.
|
Deletes users from the native realm. |
disableuser
Disables users in the native realm.
|
Disables users in the native realm. |
disableuserprofile
Disables a user profile so it's not visible in user profile searches.
|
Disables a user profile so it's not visible in user profile searches. |
enableuser
Enables users in the native realm.
|
Enables users in the native realm. |
enableuserprofile
Enables a user profile so it's visible in user profile searches.
|
Enables a user profile so it's visible in user profile searches. |
enrollkibana
Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.
|
Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster. |
enrollnode
Allows a new node to enroll to an existing cluster with security enabled.
|
Allows a new node to enroll to an existing cluster with security enabled. |
getapikey
Retrieves information for one or more API keys.
|
Retrieves information for one or more API keys. |
getbuiltinprivileges
Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
|
Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. |
getprivileges
Retrieves application privileges.
|
Retrieves application privileges. |
getrole
Retrieves roles in the native realm.
|
Retrieves roles in the native realm. |
getrolemapping
Retrieves role mappings.
|
Retrieves role mappings. |
getserviceaccounts
Retrieves information about service accounts.
|
Retrieves information about service accounts. |
getservicecredentials
Retrieves information of all service credentials for a service account.
|
Retrieves information of all service credentials for a service account. |
gettoken
Creates a bearer token for access without requiring basic authentication.
|
Creates a bearer token for access without requiring basic authentication. |
getuser
Retrieves information about users in the native realm and built-in users.
|
Retrieves information about users in the native realm and built-in users. |
getuserprivileges
Retrieves security privileges for the logged in user.
|
Retrieves security privileges for the logged in user. |
getuserprofile
Retrieves user profiles for the given unique ID(s).
|
Retrieves user profiles for the given unique ID(s). |
grantapikey
Creates an API key on behalf of another user.
|
Creates an API key on behalf of another user. |
hasprivileges
Determines whether the specified user has a specified list of privileges.
|
Determines whether the specified user has a specified list of privileges. |
hasprivilegesuserprofile
Determines whether the users associated with the specified profile IDs have all the requested privileges.
|
Determines whether the users associated with the specified profile IDs have all the requested privileges. |
invalidateapikey
Invalidates one or more API keys.
|
Invalidates one or more API keys. |
invalidatetoken
Invalidates one or more access tokens or refresh tokens.
|
Invalidates one or more access tokens or refresh tokens. |
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
Adds or updates application privileges.
|
Adds or updates application privileges. |
putrole
Adds and updates roles in the native realm.
|
Adds and updates roles in the native realm. |
putrolemapping
Creates and updates role mappings.
|
Creates and updates role mappings. |
putuser
Adds and updates users in the native realm.
|
Adds and updates users in the native realm. |
queryapikeys
Retrieves information for API keys using a subset of query DSL
|
Retrieves information for API keys using a subset of query DSL |
samlauthenticate
Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair
|
Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair |
samlcompletelogout
Verifies the logout response sent from the SAML IdP
|
Verifies the logout response sent from the SAML IdP |
samlinvalidate
Consumes a SAML LogoutRequest
|
Consumes a SAML LogoutRequest |
samllogout
Invalidates an access token and a refresh token that were generated via the SAML Authenticate API
|
Invalidates an access token and a refresh token that were generated via the SAML Authenticate API |
samlprepareauthentication
Creates a SAML authentication request
|
Creates a SAML authentication request |
samlserviceprovidermetadata
Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider
|
Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider |
suggestuserprofiles
Get suggestions for user profiles that match specified search criteria.
|
Get suggestions for user profiles that match specified search criteria. |
updateapikey
Updates attributes of an existing API key.
|
Updates attributes of an existing API key. |
updateuserprofiledata
Update application specific data for the user profile of the given unique ID.
|
Update application specific data for the user profile of the given unique ID. |
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
Removes stale data from repository.
|
Removes stale data from repository. |
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. |
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
Retrieves information about the X.509 certificates used to encrypt communications in the cluster.
|
Retrieves information about the X.509 certificates used to encrypt communications in the cluster. |
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 synonyms set
|
Creates or updates a synonyms 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
Returns information about a task.
|
Returns information about a task. |
list
Returns a list of tasks.
|
Returns a list of tasks. |
textstructure
|
|
findstructure
Finds the structure of a text file.
|
Finds the structure of a text file. |
transform
|
|
deletetransform
Deletes an existing transform.
|
Deletes an existing transform. |
gettransform
Retrieves configuration information for transforms.
|
Retrieves configuration information for transforms. |
gettransformstats
Retrieves usage information for transforms.
|
Retrieves usage information for transforms. |
previewtransform
Previews a transform.
|
Previews a transform. |
puttransform
Instantiates a transform.
|
Instantiates a transform. |
resettransform
Resets an existing transform.
|
Resets an existing transform. |
schedulenowtransform
Schedules now a transform.
|
Schedules now a transform. |
starttransform
Starts one or more transforms.
|
Starts one or more transforms. |
stoptransform
Stops one or more transforms.
|
Stops one or more transforms. |
updatetransform
Updates certain properties of a transform.
|
Updates certain properties of 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/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/deploymentstate
Package deploymentstate
|
Package deploymentstate |
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/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/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/filtertype
Package filtertype
|
Package filtertype |
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/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/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/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/synonymformat
Package synonymformat
|
Package synonymformat |
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/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
Forces the execution of a stored watch.
|
Forces the execution of a stored watch. |
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
Retrieves information about the installed X-Pack features.
|
Retrieves information about the installed X-Pack features. |
usage
Retrieves usage information about the installed X-Pack features.
|
Retrieves usage information about the installed X-Pack features. |
Click to show internal directories.
Click to hide internal directories.