typedapi

package
v9.1.0 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2025 License: Apache-2.0 Imports: 558 Imported by: 0

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶ 

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

	Bulk                    core_bulk.NewBulk
	ClearScroll             core_clear_scroll.NewClearScroll
	ClosePointInTime        core_close_point_in_time.NewClosePointInTime
	Count                   core_count.NewCount
	Create                  core_create.NewCreate
	Delete                  core_delete.NewDelete
	DeleteByQuery           core_delete_by_query.NewDeleteByQuery
	DeleteByQueryRethrottle core_delete_by_query_rethrottle.NewDeleteByQueryRethrottle
	DeleteScript            core_delete_script.NewDeleteScript
	Exists                  core_exists.NewExists
	ExistsSource            core_exists_source.NewExistsSource
	Explain                 core_explain.NewExplain
	FieldCaps               core_field_caps.NewFieldCaps
	Get                     core_get.NewGet
	GetScript               core_get_script.NewGetScript
	GetScriptContext        core_get_script_context.NewGetScriptContext
	GetScriptLanguages      core_get_script_languages.NewGetScriptLanguages
	GetSource               core_get_source.NewGetSource
	HealthReport            core_health_report.NewHealthReport
	Index                   core_index.NewIndex
	Info                    core_info.NewInfo
	Mget                    core_mget.NewMget
	Msearch                 core_msearch.NewMsearch
	MsearchTemplate         core_msearch_template.NewMsearchTemplate
	Mtermvectors            core_mtermvectors.NewMtermvectors
	OpenPointInTime         core_open_point_in_time.NewOpenPointInTime
	Ping                    core_ping.NewPing
	PutScript               core_put_script.NewPutScript
	RankEval                core_rank_eval.NewRankEval
	Reindex                 core_reindex.NewReindex
	ReindexRethrottle       core_reindex_rethrottle.NewReindexRethrottle
	RenderSearchTemplate    core_render_search_template.NewRenderSearchTemplate
	ScriptsPainlessExecute  core_scripts_painless_execute.NewScriptsPainlessExecute
	Scroll                  core_scroll.NewScroll
	Search                  core_search.NewSearch
	SearchMvt               core_search_mvt.NewSearchMvt
	SearchShards            core_search_shards.NewSearchShards
	SearchTemplate          core_search_template.NewSearchTemplate
	TermsEnum               core_terms_enum.NewTermsEnum
	Termvectors             core_termvectors.NewTermvectors
	Update                  core_update.NewUpdate
	UpdateByQuery           core_update_by_query.NewUpdateByQuery
	UpdateByQueryRethrottle core_update_by_query_rethrottle.NewUpdateByQueryRethrottle
}

func New ¶ 

func New(tp elastictransport.Interface) *API

type AsyncSearch ¶ 

type AsyncSearch struct {
	Delete async_search_delete.NewDelete
	Get    async_search_get.NewGet
	Status async_search_status.NewStatus
	Submit async_search_submit.NewSubmit
}

type Autoscaling ¶ 

type Autoscaling struct {
	DeleteAutoscalingPolicy autoscaling_delete_autoscaling_policy.NewDeleteAutoscalingPolicy
	GetAutoscalingCapacity  autoscaling_get_autoscaling_capacity.NewGetAutoscalingCapacity
	GetAutoscalingPolicy    autoscaling_get_autoscaling_policy.NewGetAutoscalingPolicy
	PutAutoscalingPolicy    autoscaling_put_autoscaling_policy.NewPutAutoscalingPolicy
}

type Capabilities ¶ 

type Capabilities struct {
	Capabilities capabilities.NewCapabilities
}

type Cat ¶ 

type Cat struct {
	Aliases              cat_aliases.NewAliases
	Allocation           cat_allocation.NewAllocation
	ComponentTemplates   cat_component_templates.NewComponentTemplates
	Count                cat_count.NewCount
	Fielddata            cat_fielddata.NewFielddata
	Health               cat_health.NewHealth
	Help                 cat_help.NewHelp
	Indices              cat_indices.NewIndices
	Master               cat_master.NewMaster
	MlDataFrameAnalytics cat_ml_data_frame_analytics.NewMlDataFrameAnalytics
	MlDatafeeds          cat_ml_datafeeds.NewMlDatafeeds
	MlJobs               cat_ml_jobs.NewMlJobs
	MlTrainedModels      cat_ml_trained_models.NewMlTrainedModels
	Nodeattrs            cat_nodeattrs.NewNodeattrs
	Nodes                cat_nodes.NewNodes
	PendingTasks         cat_pending_tasks.NewPendingTasks
	Plugins              cat_plugins.NewPlugins
	Recovery             cat_recovery.NewRecovery
	Repositories         cat_repositories.NewRepositories
	Segments             cat_segments.NewSegments
	Shards               cat_shards.NewShards
	Snapshots            cat_snapshots.NewSnapshots
	Tasks                cat_tasks.NewTasks
	Templates            cat_templates.NewTemplates
	ThreadPool           cat_thread_pool.NewThreadPool
	Transforms           cat_transforms.NewTransforms
}

type Ccr ¶ 

type Ccr struct {
	DeleteAutoFollowPattern ccr_delete_auto_follow_pattern.NewDeleteAutoFollowPattern
	Follow                  ccr_follow.NewFollow
	FollowInfo              ccr_follow_info.NewFollowInfo
	FollowStats             ccr_follow_stats.NewFollowStats
	ForgetFollower          ccr_forget_follower.NewForgetFollower
	GetAutoFollowPattern    ccr_get_auto_follow_pattern.NewGetAutoFollowPattern
	PauseAutoFollowPattern  ccr_pause_auto_follow_pattern.NewPauseAutoFollowPattern
	PauseFollow             ccr_pause_follow.NewPauseFollow
	PutAutoFollowPattern    ccr_put_auto_follow_pattern.NewPutAutoFollowPattern
	ResumeAutoFollowPattern ccr_resume_auto_follow_pattern.NewResumeAutoFollowPattern
	ResumeFollow            ccr_resume_follow.NewResumeFollow
	Stats                   ccr_stats.NewStats
	Unfollow                ccr_unfollow.NewUnfollow
}

type Cluster ¶ 

type Cluster struct {
	AllocationExplain            cluster_allocation_explain.NewAllocationExplain
	DeleteComponentTemplate      cluster_delete_component_template.NewDeleteComponentTemplate
	DeleteVotingConfigExclusions cluster_delete_voting_config_exclusions.NewDeleteVotingConfigExclusions
	ExistsComponentTemplate      cluster_exists_component_template.NewExistsComponentTemplate
	GetComponentTemplate         cluster_get_component_template.NewGetComponentTemplate
	GetSettings                  cluster_get_settings.NewGetSettings
	Health                       cluster_health.NewHealth
	Info                         cluster_info.NewInfo
	PendingTasks                 cluster_pending_tasks.NewPendingTasks
	PostVotingConfigExclusions   cluster_post_voting_config_exclusions.NewPostVotingConfigExclusions
	PutComponentTemplate         cluster_put_component_template.NewPutComponentTemplate
	PutSettings                  cluster_put_settings.NewPutSettings
	RemoteInfo                   cluster_remote_info.NewRemoteInfo
	Reroute                      cluster_reroute.NewReroute
	State                        cluster_state.NewState
	Stats                        cluster_stats.NewStats
}

type Connector ¶ 

type Connector struct {
	CheckIn                   connector_check_in.NewCheckIn
	Delete                    connector_delete.NewDelete
	Get                       connector_get.NewGet
	LastSync                  connector_last_sync.NewLastSync
	List                      connector_list.NewList
	Post                      connector_post.NewPost
	Put                       connector_put.NewPut
	SecretPost                connector_secret_post.NewSecretPost
	SyncJobCancel             connector_sync_job_cancel.NewSyncJobCancel
	SyncJobCheckIn            connector_sync_job_check_in.NewSyncJobCheckIn
	SyncJobClaim              connector_sync_job_claim.NewSyncJobClaim
	SyncJobDelete             connector_sync_job_delete.NewSyncJobDelete
	SyncJobError              connector_sync_job_error.NewSyncJobError
	SyncJobGet                connector_sync_job_get.NewSyncJobGet
	SyncJobList               connector_sync_job_list.NewSyncJobList
	SyncJobPost               connector_sync_job_post.NewSyncJobPost
	SyncJobUpdateStats        connector_sync_job_update_stats.NewSyncJobUpdateStats
	UpdateActiveFiltering     connector_update_active_filtering.NewUpdateActiveFiltering
	UpdateApiKeyId            connector_update_api_key_id.NewUpdateApiKeyId
	UpdateConfiguration       connector_update_configuration.NewUpdateConfiguration
	UpdateError               connector_update_error.NewUpdateError
	UpdateFeatures            connector_update_features.NewUpdateFeatures
	UpdateFiltering           connector_update_filtering.NewUpdateFiltering
	UpdateFilteringValidation connector_update_filtering_validation.NewUpdateFilteringValidation
	UpdateIndexName           connector_update_index_name.NewUpdateIndexName
	UpdateName                connector_update_name.NewUpdateName
	UpdateNative              connector_update_native.NewUpdateNative
	UpdatePipeline            connector_update_pipeline.NewUpdatePipeline
	UpdateScheduling          connector_update_scheduling.NewUpdateScheduling
	UpdateServiceType         connector_update_service_type.NewUpdateServiceType
	UpdateStatus              connector_update_status.NewUpdateStatus
}

type Core ¶ 

type Core struct {
	Bulk                    core_bulk.NewBulk
	ClearScroll             core_clear_scroll.NewClearScroll
	ClosePointInTime        core_close_point_in_time.NewClosePointInTime
	Count                   core_count.NewCount
	Create                  core_create.NewCreate
	Delete                  core_delete.NewDelete
	DeleteByQuery           core_delete_by_query.NewDeleteByQuery
	DeleteByQueryRethrottle core_delete_by_query_rethrottle.NewDeleteByQueryRethrottle
	DeleteScript            core_delete_script.NewDeleteScript
	Exists                  core_exists.NewExists
	ExistsSource            core_exists_source.NewExistsSource
	Explain                 core_explain.NewExplain
	FieldCaps               core_field_caps.NewFieldCaps
	Get                     core_get.NewGet
	GetScript               core_get_script.NewGetScript
	GetScriptContext        core_get_script_context.NewGetScriptContext
	GetScriptLanguages      core_get_script_languages.NewGetScriptLanguages
	GetSource               core_get_source.NewGetSource
	HealthReport            core_health_report.NewHealthReport
	Index                   core_index.NewIndex
	Info                    core_info.NewInfo
	Mget                    core_mget.NewMget
	Msearch                 core_msearch.NewMsearch
	MsearchTemplate         core_msearch_template.NewMsearchTemplate
	Mtermvectors            core_mtermvectors.NewMtermvectors
	OpenPointInTime         core_open_point_in_time.NewOpenPointInTime
	Ping                    core_ping.NewPing
	PutScript               core_put_script.NewPutScript
	RankEval                core_rank_eval.NewRankEval
	Reindex                 core_reindex.NewReindex
	ReindexRethrottle       core_reindex_rethrottle.NewReindexRethrottle
	RenderSearchTemplate    core_render_search_template.NewRenderSearchTemplate
	ScriptsPainlessExecute  core_scripts_painless_execute.NewScriptsPainlessExecute
	Scroll                  core_scroll.NewScroll
	Search                  core_search.NewSearch
	SearchMvt               core_search_mvt.NewSearchMvt
	SearchShards            core_search_shards.NewSearchShards
	SearchTemplate          core_search_template.NewSearchTemplate
	TermsEnum               core_terms_enum.NewTermsEnum
	Termvectors             core_termvectors.NewTermvectors
	Update                  core_update.NewUpdate
	UpdateByQuery           core_update_by_query.NewUpdateByQuery
	UpdateByQueryRethrottle core_update_by_query_rethrottle.NewUpdateByQueryRethrottle
}

type DanglingIndices ¶ 

type DanglingIndices struct {
	DeleteDanglingIndex dangling_indices_delete_dangling_index.NewDeleteDanglingIndex
	ImportDanglingIndex dangling_indices_import_dangling_index.NewImportDanglingIndex
	ListDanglingIndices dangling_indices_list_dangling_indices.NewListDanglingIndices
}

type Enrich ¶ 

type Enrich struct {
	DeletePolicy  enrich_delete_policy.NewDeletePolicy
	ExecutePolicy enrich_execute_policy.NewExecutePolicy
	GetPolicy     enrich_get_policy.NewGetPolicy
	PutPolicy     enrich_put_policy.NewPutPolicy
	Stats         enrich_stats.NewStats
}

type Eql ¶ 

type Eql struct {
	Delete    eql_delete.NewDelete
	Get       eql_get.NewGet
	GetStatus eql_get_status.NewGetStatus
	Search    eql_search.NewSearch
}

type Esql ¶ 

type Esql struct {
	AsyncQuery       esql_async_query.NewAsyncQuery
	AsyncQueryDelete esql_async_query_delete.NewAsyncQueryDelete
	AsyncQueryGet    esql_async_query_get.NewAsyncQueryGet
	AsyncQueryStop   esql_async_query_stop.NewAsyncQueryStop
	GetQuery         esql_get_query.NewGetQuery
	ListQueries      esql_list_queries.NewListQueries
	Query            esql_query.NewQuery
}

type Features ¶ 

type Features struct {
	GetFeatures   features_get_features.NewGetFeatures
	ResetFeatures features_reset_features.NewResetFeatures
}

type Fleet ¶ 

type Fleet struct {
	GlobalCheckpoints fleet_global_checkpoints.NewGlobalCheckpoints
	Msearch           fleet_msearch.NewMsearch
	PostSecret        fleet_post_secret.NewPostSecret
	Search            fleet_search.NewSearch
}

type Graph ¶ 

type Graph struct {
	Explore graph_explore.NewExplore
}

type Ilm ¶ 

type Ilm struct {
	DeleteLifecycle    ilm_delete_lifecycle.NewDeleteLifecycle
	ExplainLifecycle   ilm_explain_lifecycle.NewExplainLifecycle
	GetLifecycle       ilm_get_lifecycle.NewGetLifecycle
	GetStatus          ilm_get_status.NewGetStatus
	MigrateToDataTiers ilm_migrate_to_data_tiers.NewMigrateToDataTiers
	MoveToStep         ilm_move_to_step.NewMoveToStep
	PutLifecycle       ilm_put_lifecycle.NewPutLifecycle
	RemovePolicy       ilm_remove_policy.NewRemovePolicy
	Retry              ilm_retry.NewRetry
	Start              ilm_start.NewStart
	Stop               ilm_stop.NewStop
}

type Indices ¶ 

type Indices struct {
	AddBlock                indices_add_block.NewAddBlock
	Analyze                 indices_analyze.NewAnalyze
	CancelMigrateReindex    indices_cancel_migrate_reindex.NewCancelMigrateReindex
	ClearCache              indices_clear_cache.NewClearCache
	Clone                   indices_clone.NewClone
	Close                   indices_close.NewClose
	Create                  indices_create.NewCreate
	CreateDataStream        indices_create_data_stream.NewCreateDataStream
	CreateFrom              indices_create_from.NewCreateFrom
	DataStreamsStats        indices_data_streams_stats.NewDataStreamsStats
	Delete                  indices_delete.NewDelete
	DeleteAlias             indices_delete_alias.NewDeleteAlias
	DeleteDataLifecycle     indices_delete_data_lifecycle.NewDeleteDataLifecycle
	DeleteDataStream        indices_delete_data_stream.NewDeleteDataStream
	DeleteDataStreamOptions indices_delete_data_stream_options.NewDeleteDataStreamOptions
	DeleteIndexTemplate     indices_delete_index_template.NewDeleteIndexTemplate
	DeleteTemplate          indices_delete_template.NewDeleteTemplate
	DiskUsage               indices_disk_usage.NewDiskUsage
	Downsample              indices_downsample.NewDownsample
	Exists                  indices_exists.NewExists
	ExistsAlias             indices_exists_alias.NewExistsAlias
	ExistsIndexTemplate     indices_exists_index_template.NewExistsIndexTemplate
	ExistsTemplate          indices_exists_template.NewExistsTemplate
	ExplainDataLifecycle    indices_explain_data_lifecycle.NewExplainDataLifecycle
	FieldUsageStats         indices_field_usage_stats.NewFieldUsageStats
	Flush                   indices_flush.NewFlush
	Forcemerge              indices_forcemerge.NewForcemerge
	Get                     indices_get.NewGet
	GetAlias                indices_get_alias.NewGetAlias
	GetDataLifecycle        indices_get_data_lifecycle.NewGetDataLifecycle
	GetDataLifecycleStats   indices_get_data_lifecycle_stats.NewGetDataLifecycleStats
	GetDataStream           indices_get_data_stream.NewGetDataStream
	GetDataStreamOptions    indices_get_data_stream_options.NewGetDataStreamOptions
	GetDataStreamSettings   indices_get_data_stream_settings.NewGetDataStreamSettings
	GetFieldMapping         indices_get_field_mapping.NewGetFieldMapping
	GetIndexTemplate        indices_get_index_template.NewGetIndexTemplate
	GetMapping              indices_get_mapping.NewGetMapping
	GetMigrateReindexStatus indices_get_migrate_reindex_status.NewGetMigrateReindexStatus
	GetSettings             indices_get_settings.NewGetSettings
	GetTemplate             indices_get_template.NewGetTemplate
	MigrateReindex          indices_migrate_reindex.NewMigrateReindex
	MigrateToDataStream     indices_migrate_to_data_stream.NewMigrateToDataStream
	ModifyDataStream        indices_modify_data_stream.NewModifyDataStream
	Open                    indices_open.NewOpen
	PromoteDataStream       indices_promote_data_stream.NewPromoteDataStream
	PutAlias                indices_put_alias.NewPutAlias
	PutDataLifecycle        indices_put_data_lifecycle.NewPutDataLifecycle
	PutDataStreamOptions    indices_put_data_stream_options.NewPutDataStreamOptions
	PutDataStreamSettings   indices_put_data_stream_settings.NewPutDataStreamSettings
	PutIndexTemplate        indices_put_index_template.NewPutIndexTemplate
	PutMapping              indices_put_mapping.NewPutMapping
	PutSettings             indices_put_settings.NewPutSettings
	PutTemplate             indices_put_template.NewPutTemplate
	Recovery                indices_recovery.NewRecovery
	Refresh                 indices_refresh.NewRefresh
	ReloadSearchAnalyzers   indices_reload_search_analyzers.NewReloadSearchAnalyzers
	RemoveBlock             indices_remove_block.NewRemoveBlock
	ResolveCluster          indices_resolve_cluster.NewResolveCluster
	ResolveIndex            indices_resolve_index.NewResolveIndex
	Rollover                indices_rollover.NewRollover
	Segments                indices_segments.NewSegments
	ShardStores             indices_shard_stores.NewShardStores
	Shrink                  indices_shrink.NewShrink
	SimulateIndexTemplate   indices_simulate_index_template.NewSimulateIndexTemplate
	SimulateTemplate        indices_simulate_template.NewSimulateTemplate
	Split                   indices_split.NewSplit
	Stats                   indices_stats.NewStats
	UpdateAliases           indices_update_aliases.NewUpdateAliases
	ValidateQuery           indices_validate_query.NewValidateQuery
}

type Inference ¶ 

type Inference struct {
	ChatCompletionUnified inference_chat_completion_unified.NewChatCompletionUnified
	Completion            inference_completion.NewCompletion
	Delete                inference_delete.NewDelete
	Get                   inference_get.NewGet
	Inference             inference_inference.NewInference
	Put                   inference_put.NewPut
	PutAlibabacloud       inference_put_alibabacloud.NewPutAlibabacloud
	PutAmazonbedrock      inference_put_amazonbedrock.NewPutAmazonbedrock
	PutAmazonsagemaker    inference_put_amazonsagemaker.NewPutAmazonsagemaker
	PutAnthropic          inference_put_anthropic.NewPutAnthropic
	PutAzureaistudio      inference_put_azureaistudio.NewPutAzureaistudio
	PutAzureopenai        inference_put_azureopenai.NewPutAzureopenai
	PutCohere             inference_put_cohere.NewPutCohere
	PutCustom             inference_put_custom.NewPutCustom
	PutDeepseek           inference_put_deepseek.NewPutDeepseek
	PutElasticsearch      inference_put_elasticsearch.NewPutElasticsearch
	PutElser              inference_put_elser.NewPutElser
	PutGoogleaistudio     inference_put_googleaistudio.NewPutGoogleaistudio
	PutGooglevertexai     inference_put_googlevertexai.NewPutGooglevertexai
	PutHuggingFace        inference_put_hugging_face.NewPutHuggingFace
	PutJinaai             inference_put_jinaai.NewPutJinaai
	PutMistral            inference_put_mistral.NewPutMistral
	PutOpenai             inference_put_openai.NewPutOpenai
	PutVoyageai           inference_put_voyageai.NewPutVoyageai
	PutWatsonx            inference_put_watsonx.NewPutWatsonx
	Rerank                inference_rerank.NewRerank
	SparseEmbedding       inference_sparse_embedding.NewSparseEmbedding
	StreamCompletion      inference_stream_completion.NewStreamCompletion
	TextEmbedding         inference_text_embedding.NewTextEmbedding
	Update                inference_update.NewUpdate
}

type Ingest ¶ 

type Ingest struct {
	DeleteGeoipDatabase      ingest_delete_geoip_database.NewDeleteGeoipDatabase
	DeleteIpLocationDatabase ingest_delete_ip_location_database.NewDeleteIpLocationDatabase
	DeletePipeline           ingest_delete_pipeline.NewDeletePipeline
	GeoIpStats               ingest_geo_ip_stats.NewGeoIpStats
	GetGeoipDatabase         ingest_get_geoip_database.NewGetGeoipDatabase
	GetIpLocationDatabase    ingest_get_ip_location_database.NewGetIpLocationDatabase
	GetPipeline              ingest_get_pipeline.NewGetPipeline
	ProcessorGrok            ingest_processor_grok.NewProcessorGrok
	PutGeoipDatabase         ingest_put_geoip_database.NewPutGeoipDatabase
	PutIpLocationDatabase    ingest_put_ip_location_database.NewPutIpLocationDatabase
	PutPipeline              ingest_put_pipeline.NewPutPipeline
	Simulate                 ingest_simulate.NewSimulate
}

type License ¶ 

type License struct {
	Delete         license_delete.NewDelete
	Get            license_get.NewGet
	GetBasicStatus license_get_basic_status.NewGetBasicStatus
	GetTrialStatus license_get_trial_status.NewGetTrialStatus
	Post           license_post.NewPost
	PostStartBasic license_post_start_basic.NewPostStartBasic
	PostStartTrial license_post_start_trial.NewPostStartTrial
}

type Logstash ¶ 

type Logstash struct {
	DeletePipeline logstash_delete_pipeline.NewDeletePipeline
	GetPipeline    logstash_get_pipeline.NewGetPipeline
	PutPipeline    logstash_put_pipeline.NewPutPipeline
}

type MethodAPI ¶ added in v9.1.0 

type MethodAPI struct {
	AsyncSearch         MethodAsyncSearch
	Autoscaling         MethodAutoscaling
	Capabilities        MethodCapabilities
	Cat                 MethodCat
	Ccr                 MethodCcr
	Cluster             MethodCluster
	Connector           MethodConnector
	Core                MethodCore
	DanglingIndices     MethodDanglingIndices
	Enrich              MethodEnrich
	Eql                 MethodEql
	Esql                MethodEsql
	Features            MethodFeatures
	Fleet               MethodFleet
	Graph               MethodGraph
	Ilm                 MethodIlm
	Indices             MethodIndices
	Inference           MethodInference
	Ingest              MethodIngest
	License             MethodLicense
	Logstash            MethodLogstash
	Migration           MethodMigration
	Ml                  MethodMl
	Monitoring          MethodMonitoring
	Nodes               MethodNodes
	Profiling           MethodProfiling
	QueryRules          MethodQueryRules
	Rollup              MethodRollup
	SearchApplication   MethodSearchApplication
	SearchableSnapshots MethodSearchableSnapshots
	Security            MethodSecurity
	Shutdown            MethodShutdown
	Simulate            MethodSimulate
	Slm                 MethodSlm
	Snapshot            MethodSnapshot
	Sql                 MethodSql
	Ssl                 MethodSsl
	Streams             MethodStreams
	Synonyms            MethodSynonyms
	Tasks               MethodTasks
	TextStructure       MethodTextStructure
	Transform           MethodTransform
	Watcher             MethodWatcher
	Xpack               MethodXpack
	// contains filtered or unexported fields
}

func NewMethodAPI ¶ added in v9.1.0 

func NewMethodAPI(tp elastictransport.Interface) *MethodAPI

func (*MethodAPI) Bulk ¶ added in v9.1.0 

func (p *MethodAPI) Bulk() *core_bulk.Bulk

Bulk index or delete documents. Perform multiple `index`, `create`, `delete`, and `update` actions in a single request. This reduces overhead and can greatly increase indexing speed.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:

* To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action. * To use the `index` action, you must have the `create`, `index`, or `write` index privilege. * To use the `delete` action, you must have the `delete` or `write` index privilege. * To use the `update` action, you must have the `index` or `write` index privilege. * To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege. * To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.

Automatic data stream creation requires a matching index template with data stream enabled.

The actions are specified in the request body using a newline delimited JSON (NDJSON) structure:

``` action_and_meta_data\n optional_source\n action_and_meta_data\n optional_source\n .... action_and_meta_data\n optional_source\n ```

The `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API. A `create` action fails if a document with the same ID already exists in the target An `index` action adds or replaces a document as necessary.

NOTE: Data streams support only the `create` action. To update or delete a document in a data stream, you must target the backing index containing the document.

An `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.

A `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.

NOTE: The final line of data must end with a newline character (`\n`). Each newline character may be preceded by a carriage return (`\r`). When sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`. Because this format uses literal newline characters (`\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.

If you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.

A note on the format: the idea here is to make processing as fast as possible. As some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.

Client libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.

There is no "correct" number of actions to perform in a single bulk request. Experiment with different settings to find the optimal size for your particular workload. Note that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size. It is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch. For instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.

**Client suppport for bulk requests**

Some of the officially supported clients provide helpers to assist with bulk requests and reindexing:

* Go: Check out `esutil.BulkIndexer` * Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll` * Python: Check out `elasticsearch.helpers.*` * JavaScript: Check out `client.helpers.*` * .NET: Check out `BulkAllObservable` * PHP: Check out bulk indexing.

**Submitting bulk requests with cURL**

If you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`. The latter doesn't preserve newlines. For example:

``` $ cat requests { "index" : { "_index" : "test", "_id" : "1" } } { "field1" : "value1" } $ curl -s -H "Content-Type: application/x-ndjson" -XPOST localhost:9200/_bulk --data-binary "@requests"; echo {"took":7, "errors": false, "items":[{"index":{"_index":"test","_id":"1","_version":1,"result":"created","forced_refresh":false}}]} ```

**Optimistic concurrency control**

Each `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines. The `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.

**Versioning**

Each bulk item can include the version value using the `version` field. It automatically follows the behavior of the index or delete operation based on the `_version` mapping. It also support the `version_type`.

**Routing**

Each bulk item can include the routing value using the `routing` field. It automatically follows the behavior of the index or delete operation based on the `_routing` mapping.

NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.

**Wait for active shards**

When making bulk calls, you can set the `wait_for_active_shards` parameter to require a minimum number of shard copies to be active before starting to process the bulk request.

**Refresh**

Control when the changes made by this request are visible to search.

NOTE: Only the shards that receive the bulk request will be affected by refresh. Imagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards. The request will only wait for those three shards to refresh. The other two shards that make up the index do not participate in the `_bulk` request at all.

You might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests. Refer to the linked documentation for step-by-step instructions using the index settings API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk

func (*MethodAPI) ClearScroll ¶ added in v9.1.0 

func (p *MethodAPI) ClearScroll() *core_clear_scroll.ClearScroll

Clear a scrolling search. Clear the search context and results for a scrolling search. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll

func (*MethodAPI) ClosePointInTime ¶ added in v9.1.0 

func (p *MethodAPI) ClosePointInTime() *core_close_point_in_time.ClosePointInTime

Close a point in time. A point in time must be opened explicitly before being used in search requests. The `keep_alive` parameter tells Elasticsearch how long it should persist. A point in time is automatically closed when the `keep_alive` period has elapsed. However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time

func (*MethodAPI) Count ¶ added in v9.1.0 

func (p *MethodAPI) Count() *core_count.Count

Count search results. Get the number of documents matching a query.

The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body. The query is optional. When no query is provided, the API uses `match_all` to count all the documents.

The count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.

The operation is broadcast across all shards. For each shard ID group, a replica is chosen and the search is run against it. This means that replicas increase the scalability of the count. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-count

func (*MethodAPI) Create ¶ added in v9.1.0 

func (p *MethodAPI) Create(index, id string) *core_create.Create

Create a new document in the index.

You can index a new JSON document with the `/<target>/_doc/` or `/<target>/_create/<_id>` APIs Using `_create` guarantees that the document is indexed only if it does not already exist. It returns a 409 response when a document with a same ID already exists in the index. To update an existing document, you must use the `/<target>/_doc/` API.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:

* To add a document using the `PUT /<target>/_create/<_id>` or `POST /<target>/_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege. * To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.

Automatic data stream creation requires a matching index template with data stream enabled.

**Automatically create data streams and indices**

If the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.

If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.

NOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.

If no mapping exists, the index operation creates a dynamic mapping. By default, new fields and objects are automatically added to the mapping if needed.

Automatic index creation is controlled by the `action.auto_create_index` setting. If it is `true`, any index can be created automatically. You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely. Specify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked. When a list is specified, the default behaviour is to disallow.

NOTE: The `action.auto_create_index` setting affects the automatic creation of indices only. It does not affect the creation of data streams.

**Routing**

By default, shard placement — or routing — is controlled by using a hash of the document's ID value. For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.

When setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself. This does come at the (very minimal) cost of an additional document parsing pass. If the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.

NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.

**Distributed**

The index operation is directed to the primary shard based on its route and performed on the actual node containing this shard. After the primary shard completes the operation, if needed, the update is distributed to applicable replicas.

**Active shards**

To improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation. If the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs. By default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`). This default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`. To alter this behavior per operation, use the `wait_for_active_shards request` parameter.

Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1). Specifying a negative value or a number greater than the number of shard copies will throw an error.

For example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes). If you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding. This means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data. If `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding. This requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard. However, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index. The operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.

It is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts. After the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary. The `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create

func (*MethodAPI) Delete ¶ added in v9.1.0 

func (p *MethodAPI) Delete(index, id string) *core_delete.Delete

Delete a document.

Remove a JSON document from the specified index.

NOTE: You cannot send deletion requests directly to a data stream. To delete a document in a data stream, you must target the backing index containing the document.

**Optimistic concurrency control**

Delete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters. If a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.

**Versioning**

Each document indexed is versioned. When deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime. Every write operation run on a document, deletes included, causes its version to be incremented. The version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations. The length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.

**Routing**

If routing is used during indexing, the routing value also needs to be specified to delete a document.

If the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.

For example:

``` DELETE /my-index-000001/_doc/1?routing=shard-1 ```

This request deletes the document with ID 1, but it is routed based on the user. The document is not deleted if the correct routing is not specified.

**Distributed**

The delete operation gets hashed into a specific shard ID. It then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete

func (*MethodAPI) DeleteByQuery ¶ added in v9.1.0 

func (p *MethodAPI) DeleteByQuery(index string) *core_delete_by_query.DeleteByQuery

Delete documents.

Deletes documents that match the specified query.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:

* `read` * `delete` or `write`

You can specify the query criteria in the request URI or the request body using the same syntax as the search API. When you submit a delete by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and deletes matching documents using internal versioning. If a document changes between the time that the snapshot is taken and the delete operation is processed, it results in a version conflict and the delete operation fails.

NOTE: Documents with a version equal to 0 cannot be deleted using delete by query because internal versioning does not support 0 as a valid version number.

While processing a delete by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents to delete. A bulk delete request is performed for each batch of matching documents. If a search or bulk request is rejected, the requests are retried up to 10 times, with exponential back off. If the maximum retry limit is reached, processing halts and all failed requests are returned in the response. Any delete requests that completed successfully still stick, they are not rolled back.

You can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`. Note that if you opt to count version conflicts the operation could attempt to delete more documents from the source than `max_docs` until it has successfully deleted `max_docs documents`, or it has gone through every document in the source query.

**Throttling delete requests**

To control the rate at which delete by query issues batches of delete operations, you can set `requests_per_second` to any positive decimal number. This pads each batch with a wait time to throttle the rate. Set `requests_per_second` to `-1` to disable throttling.

Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account. The padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing. By default the batch size is `1000`, so if `requests_per_second` is set to `500`:

``` target_time = 1000 / 500 per second = 2 seconds wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds ```

Since the batch is issued as a single `_bulk` request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set. This is "bursty" instead of "smooth".

**Slicing**

Delete by query supports sliced scroll to parallelize the delete process. This can improve efficiency and provide a convenient way to break the request down into smaller parts.

Setting `slices` to `auto` lets Elasticsearch choose the number of slices to use. This setting will use one slice per shard, up to a certain limit. If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards. Adding slices to the delete by query operation creates sub-requests which means it has some quirks:

* You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices. * Fetching the status of the task for the request with slices only contains the status of completed slices. * These sub-requests are individually addressable for things like cancellation and rethrottling. * Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally. * Canceling the request with `slices` will cancel each sub-request. * Due to the nature of `slices` each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution. * Parameters like `requests_per_second` and `max_docs` on a request with `slices` are distributed proportionally to each sub-request. Combine that with the earlier point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being deleted. * Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.

If you're slicing manually or otherwise tuning automatic slicing, keep in mind that:

* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many `slices` hurts performance. Setting `slices` higher than the number of shards generally does not improve efficiency and adds overhead. * Delete performance scales linearly across available resources with the number of slices.

Whether query or delete performance dominates the runtime depends on the documents being reindexed and cluster resources.

**Cancel a delete by query operation**

Any delete by query can be canceled using the task cancel API. For example:

``` POST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel ```

The task ID can be found by using the get tasks API.

Cancellation should happen quickly but might take a few seconds. The get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query

func (*MethodAPI) DeleteByQueryRethrottle ¶ added in v9.1.0 

func (p *MethodAPI) DeleteByQueryRethrottle(taskid string) *core_delete_by_query_rethrottle.DeleteByQueryRethrottle

Throttle a delete by query operation.

Change the number of requests per second for a particular delete by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query-rethrottle

func (*MethodAPI) DeleteScript ¶ added in v9.1.0 

func (p *MethodAPI) DeleteScript(id string) *core_delete_script.DeleteScript

Delete a script or search template. Deletes a stored script or search template. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-script

func (*MethodAPI) Exists ¶ added in v9.1.0 

func (p *MethodAPI) Exists(index, id string) *core_exists.Exists

Check a document.

Verify that a document exists. For example, check to see if a document with the `_id` 0 exists:

``` HEAD my-index-000001/_doc/0 ```

If the document exists, the API returns a status code of `200 - OK`. If the document doesn’t exist, the API returns `404 - Not Found`.

**Versioning support**

You can use the `version` parameter to check the document only if its current version is equal to the specified one.

Internally, Elasticsearch has marked the old document as deleted and added an entirely new document. The old version of the document doesn't disappear immediately, although you won't be able to access it. Elasticsearch cleans up deleted documents in the background as you continue to index more data. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get

func (*MethodAPI) ExistsSource ¶ added in v9.1.0 

func (p *MethodAPI) ExistsSource(index, id string) *core_exists_source.ExistsSource

Check for a document source.

Check whether a document source exists in an index. For example:

``` HEAD my-index-000001/_source/1 ```

A document's source is not available if it is disabled in the mapping. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get

func (*MethodAPI) Explain ¶ added in v9.1.0 

func (p *MethodAPI) Explain(index, id string) *core_explain.Explain

Explain a document match result. Get information about why a specific document matches, or doesn't match, a query. It computes a score explanation for a query and a specific document. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-explain

func (*MethodAPI) FieldCaps ¶ added in v9.1.0 

func (p *MethodAPI) FieldCaps() *core_field_caps.FieldCaps

Get the field capabilities.

Get information about the capabilities of fields among multiple indices.

For data streams, the API returns field capabilities among the stream’s backing indices. It returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-field-caps

func (*MethodAPI) Get ¶ added in v9.1.0 

func (p *MethodAPI) Get(index, id string) *core_get.Get

Get a document by its ID.

Get a document and its source or stored fields from an index.

By default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search). In the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields. To turn off realtime behavior, set the `realtime` parameter to false.

**Source filtering**

By default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off. You can turn off `_source` retrieval by using the `_source` parameter:

``` GET my-index-000001/_doc/0?_source=false ```

If you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields. This can be helpful with large documents where partial retrieval can save on network overhead Both parameters take a comma separated list of fields or wildcard expressions. For example:

``` GET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities ```

If you only want to specify includes, you can use a shorter notation:

``` GET my-index-000001/_doc/0?_source=*.id ```

**Routing**

If routing is used during indexing, the routing value also needs to be specified to retrieve a document. For example:

``` GET my-index-000001/_doc/2?routing=user1 ```

This request gets the document with ID 2, but it is routed based on the user. The document is not fetched if the correct routing is not specified.

**Distributed**

The GET operation is hashed into a specific shard ID. It is then redirected to one of the replicas within that shard ID and returns the result. The replicas are the primary shard and its replicas within that shard ID group. This means that the more replicas you have, the better your GET scaling will be.

**Versioning support**

You can use the `version` parameter to retrieve the document only if its current version is equal to the specified one.

Internally, Elasticsearch has marked the old document as deleted and added an entirely new document. The old version of the document doesn't disappear immediately, although you won't be able to access it. Elasticsearch cleans up deleted documents in the background as you continue to index more data. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get

func (*MethodAPI) GetScript ¶ added in v9.1.0 

func (p *MethodAPI) GetScript(id string) *core_get_script.GetScript

Get a script or search template. Retrieves a stored script or search template. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script

func (*MethodAPI) GetScriptContext ¶ added in v9.1.0 

func (p *MethodAPI) GetScriptContext() *core_get_script_context.GetScriptContext

Get script contexts.

Get a list of supported script contexts and their methods. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-context

func (*MethodAPI) GetScriptLanguages ¶ added in v9.1.0 

func (p *MethodAPI) GetScriptLanguages() *core_get_script_languages.GetScriptLanguages

Get script languages.

Get a list of available script types, languages, and contexts. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-languages

func (*MethodAPI) GetSource ¶ added in v9.1.0 

func (p *MethodAPI) GetSource(index, id string) *core_get_source.GetSource

Get a document's source.

Get the source of a document. For example:

``` GET my-index-000001/_source/1 ```

You can use the source filtering parameters to control which parts of the `_source` are returned:

``` GET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities ``` https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get

func (*MethodAPI) HealthReport ¶ added in v9.1.0 

func (p *MethodAPI) HealthReport() *core_health_report.HealthReport

Get the cluster health. Get a report with the health status of an Elasticsearch cluster. The report contains a list of indicators that compose Elasticsearch functionality.

Each indicator has a health status of: green, unknown, yellow or red. The indicator will provide an explanation and metadata describing the reason for its current health status.

The cluster’s status is controlled by the worst indicator status.

In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.

Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. The root cause and remediation steps are encapsulated in a diagnosis. A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.

NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-health-report

func (*MethodAPI) Index ¶ added in v9.1.0 

func (p *MethodAPI) Index(index string) *core_index.Index

Create or update a document in an index.

Add a JSON document to the specified data stream or index and make it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.

NOTE: You cannot use this API to send update requests for existing documents in a data stream.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:

* To add or overwrite a document using the `PUT /<target>/_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege. * To add a document using the `POST /<target>/_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege. * To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.

Automatic data stream creation requires a matching index template with data stream enabled.

NOTE: Replica shards might not all be started when an indexing operation returns successfully. By default, only the primary is required. Set `wait_for_active_shards` to change this default behavior.

**Automatically create data streams and indices**

If the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.

If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.

NOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.

If no mapping exists, the index operation creates a dynamic mapping. By default, new fields and objects are automatically added to the mapping if needed.

Automatic index creation is controlled by the `action.auto_create_index` setting. If it is `true`, any index can be created automatically. You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely. Specify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked. When a list is specified, the default behaviour is to disallow.

NOTE: The `action.auto_create_index` setting affects the automatic creation of indices only. It does not affect the creation of data streams.

**Optimistic concurrency control**

Index operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters. If a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.

**Routing**

By default, shard placement — or routing — is controlled by using a hash of the document's ID value. For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.

When setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself. This does come at the (very minimal) cost of an additional document parsing pass. If the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.

NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.

**Distributed**

The index operation is directed to the primary shard based on its route and performed on the actual node containing this shard. After the primary shard completes the operation, if needed, the update is distributed to applicable replicas.

**Active shards**

To improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation. If the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs. By default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`). This default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`. To alter this behavior per operation, use the `wait_for_active_shards request` parameter.

Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1). Specifying a negative value or a number greater than the number of shard copies will throw an error.

For example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes). If you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding. This means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data. If `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding. This requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard. However, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index. The operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.

It is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts. After the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary. The `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.

**No operation (noop) updates**

When updating a document by using this API, a new version of the document is always created even if the document hasn't changed. If this isn't acceptable use the `_update` API with `detect_noop` set to `true`. The `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.

There isn't a definitive rule for when noop updates aren't acceptable. It's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.

**Versioning**

Each indexed document is given a version number. By default, internal versioning is used that starts at 1 and increments with each update, deletes included. Optionally, the version number can be set to an external value (for example, if maintained in a database). To enable this functionality, `version_type` should be set to `external`. The value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.

NOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations. If no version is provided, the operation runs without any version checks.

When using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document. If true, the document will be indexed and the new version number used. If the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:

``` PUT my-index-000001/_doc/1?version=2&version_type=external 

{
  "user": {
    "id": "elkbee"
  }
}

In this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1. If the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).

A nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used. Even the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create

func (*MethodAPI) Info ¶ added in v9.1.0 

func (p *MethodAPI) Info() *core_info.Info

Get cluster info. Get basic build, version, and cluster information. ::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-info

func (*MethodAPI) Mget ¶ added in v9.1.0 

func (p *MethodAPI) Mget() *core_mget.Mget

Get multiple documents.

Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.

**Filter source fields**

By default, the `_source` field is returned for every document (if stored). Use the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document. You can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.

**Get stored fields**

Use the `stored_fields` attribute to specify the set of stored fields you want to retrieve. Any requested fields that are not stored are ignored. You can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mget

func (*MethodAPI) Msearch ¶ added in v9.1.0 

func (p *MethodAPI) Msearch() *core_msearch.Msearch

Run multiple searches.

The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows:

``` header\n body\n header\n body\n ```

This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.

IMPORTANT: The final line of data must end with a newline character `\n`. Each newline character may be preceded by a carriage return `\r`. When sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch

func (*MethodAPI) MsearchTemplate ¶ added in v9.1.0 

func (p *MethodAPI) MsearchTemplate() *core_msearch_template.MsearchTemplate

Run multiple templated searches.

Run multiple templated searches with a single request. If you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines. For example:

``` $ cat requests { "index": "my-index" } { "id": "my-search-template", "params": { "query_string": "hello world", "from": 0, "size": 10 }} { "index": "my-other-index" } { "id": "my-other-search-template", "params": { "query_type": "match_all" }}

$ curl -H "Content-Type: application/x-ndjson" -XGET localhost:9200/_msearch/template --data-binary "@requests"; echo ``` https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template

func (*MethodAPI) Mtermvectors ¶ added in v9.1.0 

func (p *MethodAPI) Mtermvectors() *core_mtermvectors.Mtermvectors

Get multiple term vectors.

Get multiple term vectors with a single request. You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI. The response contains a `docs` array with all the fetched termvectors. Each element has the structure provided by the termvectors API.

**Artificial documents**

You can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request. The mapping used is determined by the specified `_index`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mtermvectors

func (*MethodAPI) OpenPointInTime ¶ added in v9.1.0 

func (p *MethodAPI) OpenPointInTime(index string) *core_open_point_in_time.OpenPointInTime

Open a point in time.

A search request by default runs against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between `search_after` requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time.

A point in time must be opened explicitly before being used in search requests.

A subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time.

Just like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits. If you want to retrieve more hits, use PIT with `search_after`.

IMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.

When a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception. To get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.

**Keeping point in time alive**

The `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time. The value does not need to be long enough to process all data — it just needs to be long enough for the next request.

Normally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments. Once the smaller segments are no longer needed they are deleted. However, open point-in-times prevent the old segments from being deleted since they are still in use.

TIP: Keeping older segments alive means that more disk space and file handles are needed. Ensure that you have configured your nodes to have ample free file handles.

Additionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request. Ensure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates. Note that a point-in-time doesn't prevent its associated indices from being deleted. You can check how many point-in-times (that is, search contexts) are open with the nodes stats API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time

func (*MethodAPI) Ping ¶ added in v9.1.0 

func (p *MethodAPI) Ping() *core_ping.Ping

Ping the cluster. Get information about whether the cluster is running. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster

func (*MethodAPI) PutScript ¶ added in v9.1.0 

func (p *MethodAPI) PutScript(id string) *core_put_script.PutScript

Create or update a script or search template. Creates or updates a stored script or search template. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-put-script

func (*MethodAPI) RankEval ¶ added in v9.1.0 

func (p *MethodAPI) RankEval() *core_rank_eval.RankEval

Evaluate ranked search results.

Evaluate the quality of ranked search results over a set of typical search queries. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval

func (*MethodAPI) Reindex ¶ added in v9.1.0 

func (p *MethodAPI) Reindex() *core_reindex.Reindex

Reindex documents.

Copy documents from a source to a destination. You can copy all documents to the destination index or reindex a subset of the documents. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.

IMPORTANT: Reindex requires `_source` to be enabled for all documents in the source. The destination should be configured as wanted before calling the reindex API. Reindex does not copy the settings from the source or its associated template. Mappings, shard counts, and replicas, for example, must be configured ahead of time.

If the Elasticsearch security features are enabled, you must have the following security privileges:

* The `read` index privilege for the source data stream, index, or alias. * The `write` index privilege for the destination data stream, index, or index alias. * To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias. * If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias.

If reindexing from a remote cluster, you must explicitly allow the remote host in the `reindex.remote.whitelist` setting. Automatic data stream creation requires a matching index template with data stream enabled.

The `dest` element can be configured like the index API to control optimistic concurrency control. Omitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID.

Setting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source.

Setting `op_type` to `create` causes the reindex API to create only missing documents in the destination. All existing documents will cause a version conflict.

IMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`. A reindex can only add new documents to a destination data stream. It cannot update existing documents in a destination data stream.

By default, version conflicts abort the reindex process. To continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`. In this case, the response includes a count of the version conflicts that were encountered. Note that the handling of other error types is unaffected by the `conflicts` property. Additionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.

Refer to the linked documentation for examples of how to reindex documents. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex

func (*MethodAPI) ReindexRethrottle ¶ added in v9.1.0 

func (p *MethodAPI) ReindexRethrottle(taskid string) *core_reindex_rethrottle.ReindexRethrottle

Throttle a reindex operation.

Change the number of requests per second for a particular reindex operation. For example:

``` POST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1 ```

Rethrottling that speeds up the query takes effect immediately. Rethrottling that slows down the query will take effect after completing the current batch. This behavior prevents scroll timeouts. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex

func (*MethodAPI) RenderSearchTemplate ¶ added in v9.1.0 

func (p *MethodAPI) RenderSearchTemplate() *core_render_search_template.RenderSearchTemplate

Render a search template.

Render a search template as a search request body. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-render-search-template

func (*MethodAPI) ScriptsPainlessExecute ¶ added in v9.1.0 

func (p *MethodAPI) ScriptsPainlessExecute() *core_scripts_painless_execute.ScriptsPainlessExecute

Run a script.

Runs a script and returns a result. Use this API to build and test scripts, such as when defining a script for a runtime field. This API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.

The API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.

Each context requires a script, but additional parameters depend on the context you're using for that script. https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples

func (*MethodAPI) Scroll ¶ added in v9.1.0 

func (p *MethodAPI) Scroll() *core_scroll.Scroll

Run a scrolling search.

IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).

The scroll API gets large sets of results from a single scrolling search request. To get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter. The `scroll` parameter indicates how long Elasticsearch should retain the search context for the request. The search response returns a scroll ID in the `_scroll_id` response body parameter. You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.

You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.

IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll

func (*MethodAPI) Search ¶ added in v9.1.0 

func (p *MethodAPI) Search() *core_search.Search

Run a search.

Get search hits that match the query defined in the request. You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.

If the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges. To search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.

**Search slicing**

When paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties. By default the splitting is done first on the shards, then locally on each shard. The local splitting partitions the shard into contiguous ranges based on Lucene document IDs.

For instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.

IMPORTANT: The same point-in-time ID should be used for all slices. If different PIT IDs are used, slices can overlap and miss documents. This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search

func (*MethodAPI) SearchMvt ¶ added in v9.1.0 

func (p *MethodAPI) SearchMvt(index, field, zoom, x, y string) *core_search_mvt.SearchMvt

Search a vector tile.

Search a vector tile for geospatial values. Before using this API, you should be familiar with the Mapbox vector tile specification. The API returns results as a binary mapbox vector tile.

Internally, Elasticsearch translates a vector tile search API request into a search containing:

* A `geo_bounding_box` query on the `<field>`. The query uses the `<zoom>/<x>/<y>` tile as a bounding box. * A `geotile_grid` or `geohex_grid` aggregation on the `<field>`. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `<zoom>/<x>/<y>` tile as a bounding box. * Optionally, a `geo_bounds` aggregation on the `<field>`. The search only includes this aggregation if the `exact_bounds` parameter is `true`. * If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.

The API returns results as a binary Mapbox vector tile. Mapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:

* A `hits` layer containing a feature for each `<field>` value matching the `geo_bounding_box` query. * An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data. * A meta layer containing:

  • A feature containing a bounding box. By default, this is the bounding box

of the tile.

  • Value ranges for any sub-aggregations on the `geotile_grid` or

`geohex_grid`.

  • Metadata for the search.

The API only returns features that can display at its zoom level. For example, if a polygon feature has no area at its zoom level, the API omits it. The API returns errors as UTF-8 encoded JSON.

IMPORTANT: You can specify several options for this API as either a query parameter or request body parameter. If you specify both parameters, the query parameter takes precedence.

**Grid precision for geotile**

For a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels. `grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: `<zoom> + grid_precision`. For example, if `<zoom>` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15. The maximum final precision is 29. The `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`. For example, a value of 8 divides the tile into a grid of 256 x 256 cells. The `aggs` layer only contains features for cells with matching data.

**Grid precision for geohex**

For a `grid_agg` of `geohex`, Elasticsearch uses `<zoom>` and `grid_precision` to calculate a final precision as follows: `<zoom> + grid_precision`.

This precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation. The following table maps the H3 resolution for each precision. For example, if `<zoom>` is 3 and `grid_precision` is 3, the precision is 6. At a precision of 6, hexagonal cells have an H3 resolution of 2. If `<zoom>` is 3 and `grid_precision` is 4, the precision is 7. At a precision of 7, hexagonal cells have an H3 resolution of 3.

| Precision | Unique tile bins | H3 resolution | Unique hex bins | Ratio | | --------- | ---------------- | ------------- | ----------------| ----- | | 1 | 4 | 0 | 122 | 30.5 | | 2 | 16 | 0 | 122 | 7.625 | | 3 | 64 | 1 | 842 | 13.15625 | | 4 | 256 | 1 | 842 | 3.2890625 | | 5 | 1024 | 2 | 5882 | 5.744140625 | | 6 | 4096 | 2 | 5882 | 1.436035156 | | 7 | 16384 | 3 | 41162 | 2.512329102 | | 8 | 65536 | 3 | 41162 | 0.6280822754 | | 9 | 262144 | 4 | 288122 | 1.099098206 | | 10 | 1048576 | 4 | 288122 | 0.2747745514 | | 11 | 4194304 | 5 | 2016842 | 0.4808526039 | | 12 | 16777216 | 6 | 14117882 | 0.8414913416 | | 13 | 67108864 | 6 | 14117882 | 0.2103728354 | | 14 | 268435456 | 7 | 98825162 | 0.3681524172 | | 15 | 1073741824 | 8 | 691776122 | 0.644266719 | | 16 | 4294967296 | 8 | 691776122 | 0.1610666797 | | 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 | | 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 | | 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 | | 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 | | 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 | | 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 | | 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 | | 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 | | 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 | | 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 | | 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 | | 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 | | 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |

Hexagonal cells don't align perfectly on a vector tile. Some cells may intersect more than one vector tile. To compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level. Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.

Learn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt

func (*MethodAPI) SearchShards ¶ added in v9.1.0 

func (p *MethodAPI) SearchShards() *core_search_shards.SearchShards

Get the search shards.

Get the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the `indices` section.

If the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-shards

func (*MethodAPI) SearchTemplate ¶ added in v9.1.0 

func (p *MethodAPI) SearchTemplate() *core_search_template.SearchTemplate

Run a search with a search template. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template

func (*MethodAPI) TermsEnum ¶ added in v9.1.0 

func (p *MethodAPI) TermsEnum(index string) *core_terms_enum.TermsEnum

Get terms in an index.

Discover terms that match a partial string in an index. This API is designed for low-latency look-ups used in auto-complete scenarios.

> info > The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum

func (*MethodAPI) Termvectors ¶ added in v9.1.0 

func (p *MethodAPI) Termvectors(index string) *core_termvectors.Termvectors

Get term vector information.

Get information and statistics about terms in the fields of a particular document.

You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request. You can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body. For example:

``` GET /my-index-000001/_termvectors/1?fields=message ```

Fields can be specified using wildcards, similar to the multi match query.

Term vectors are real-time by default, not near real-time. This can be changed by setting `realtime` parameter to `false`.

You can request three types of values: _term information_, _term statistics_, and _field statistics_. By default, all term information and field statistics are returned for all fields but term statistics are excluded.

**Term information**

* term frequency in the field (always returned) * term positions (`positions: true`) * start and end offsets (`offsets: true`) * term payloads (`payloads: true`), as base64 encoded bytes

If the requested information wasn't stored in the index, it will be computed on the fly if possible. Additionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.

> warn > Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.

**Behaviour**

The term and field statistics are not accurate. Deleted documents are not taken into account. The information is only retrieved for the shard the requested document resides in. The term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context. By default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected. Use `routing` only to hit a particular shard. Refer to the linked documentation for detailed examples of how to use this API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-termvectors

func (*MethodAPI) Update ¶ added in v9.1.0 

func (p *MethodAPI) Update(index, id string) *core_update.Update

Update a document.

Update a document by running a script or passing a partial document.

If the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.

The script can update, delete, or skip modifying the document. The API also supports passing a partial document, which is merged into the existing document. To fully replace an existing document, use the index API. This operation:

* Gets the document (collocated with the shard) from the index. * Runs the specified script. * Indexes the result.

The document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.

The `_source` field must be enabled to use this API. In addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp). For usage examples such as partial updates, upserts, and scripted updates, see the External documentation. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update

func (*MethodAPI) UpdateByQuery ¶ added in v9.1.0 

func (p *MethodAPI) UpdateByQuery(index string) *core_update_by_query.UpdateByQuery

Update documents. Updates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:

* `read` * `index` or `write`

You can specify the query criteria in the request URI or the request body using the same syntax as the search API.

When you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning. When the versions match, the document is updated and the version number is incremented. If a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails. You can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`. Note that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query.

NOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.

While processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents. A bulk update request is performed for each batch of matching documents. Any query or update failures cause the update by query request to fail and the failures are shown in the response. Any update requests that completed successfully still stick, they are not rolled back.

**Refreshing shards**

Specifying the `refresh` parameter refreshes all shards once the request completes. This is different to the update API's `refresh` parameter, which causes only the shard that received the request to be refreshed. Unlike the update API, it does not support `wait_for`.

**Running update by query asynchronously**

If the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a [task](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.

**Waiting for active shards**

`wait_for_active_shards` controls how many copies of a shard must be active before proceeding with the request. See [`wait_for_active_shards`](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create#operation-create-wait_for_active_shards) for details. `timeout` controls how long each write request waits for unavailable shards to become available. Both work exactly the way they work in the [Bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk). Update by query uses scrolled searches, so you can also specify the `scroll` parameter to control how long it keeps the search context alive, for example `?scroll=10m`. The default is 5 minutes.

**Throttling update requests**

To control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number. This pads each batch with a wait time to throttle the rate. Set `requests_per_second` to `-1` to turn off throttling.

Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account. The padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing. By default the batch size is 1000, so if `requests_per_second` is set to `500`:

``` target_time = 1000 / 500 per second = 2 seconds wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds ```

Since the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set. This is "bursty" instead of "smooth".

**Slicing**

Update by query supports sliced scroll to parallelize the update process. This can improve efficiency and provide a convenient way to break the request down into smaller parts.

Setting `slices` to `auto` chooses a reasonable number for most data streams and indices. This setting will use one slice per shard, up to a certain limit. If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.

Adding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks:

* You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices. * Fetching the status of the task for the request with `slices` only contains the status of completed slices. * These sub-requests are individually addressable for things like cancellation and rethrottling. * Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally. * Canceling the request with slices will cancel each sub-request. * Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution. * Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated. * Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.

If you're slicing manually or otherwise tuning automatic slicing, keep in mind that:

* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead. * Update performance scales linearly across available resources with the number of slices.

Whether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources. Refer to the linked documentation for examples of how to update documents using the `_update_by_query` API: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query

func (*MethodAPI) UpdateByQueryRethrottle ¶ added in v9.1.0 

func (p *MethodAPI) UpdateByQueryRethrottle(taskid string) *core_update_by_query_rethrottle.UpdateByQueryRethrottle

Throttle an update by query operation.

Change the number of requests per second for a particular update by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query-rethrottle

type MethodAsyncSearch ¶ added in v9.1.0 

type MethodAsyncSearch struct {
	// contains filtered or unexported fields
}

func (*MethodAsyncSearch) Delete ¶ added in v9.1.0 

func (p *MethodAsyncSearch) Delete(id string) *async_search_delete.Delete

Delete an async search.

If the asynchronous search is still running, it is cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit

func (*MethodAsyncSearch) Get ¶ added in v9.1.0 

func (p *MethodAsyncSearch) Get(id string) *async_search_get.Get

Get async search results.

Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit

func (*MethodAsyncSearch) Status ¶ added in v9.1.0 

func (p *MethodAsyncSearch) Status(id string) *async_search_status.Status

Get the async search status.

Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:

* The user or API key that submitted the original async search request. * Users that have the `monitor` cluster privilege or greater privileges. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit

func (*MethodAsyncSearch) Submit ¶ added in v9.1.0 

func (p *MethodAsyncSearch) Submit() *async_search_submit.Submit

Run an async search.

When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested.

Warning: Asynchronous search does not support scroll or search requests that include only the suggest section.

By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-async-search-submit

type MethodAutoscaling ¶ added in v9.1.0 

type MethodAutoscaling struct {
	// contains filtered or unexported fields
}

func (*MethodAutoscaling) DeleteAutoscalingPolicy ¶ added in v9.1.0 

func (p *MethodAutoscaling) DeleteAutoscalingPolicy(name string) *autoscaling_delete_autoscaling_policy.DeleteAutoscalingPolicy

Delete an autoscaling policy.

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-delete-autoscaling-policy

func (*MethodAutoscaling) GetAutoscalingCapacity ¶ added in v9.1.0 

func (p *MethodAutoscaling) GetAutoscalingCapacity() *autoscaling_get_autoscaling_capacity.GetAutoscalingCapacity

Get the autoscaling capacity.

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

This API gets the current autoscaling capacity based on the configured autoscaling policy. It will return information to size the cluster appropriately to the current workload.

The `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.

The operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.

The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. This information is provided for diagnosis only. Do not use this information to make autoscaling decisions. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity

func (*MethodAutoscaling) GetAutoscalingPolicy ¶ added in v9.1.0 

func (p *MethodAutoscaling) GetAutoscalingPolicy(name string) *autoscaling_get_autoscaling_policy.GetAutoscalingPolicy

Get an autoscaling policy.

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-get-autoscaling-capacity

func (*MethodAutoscaling) PutAutoscalingPolicy ¶ added in v9.1.0 

func (p *MethodAutoscaling) PutAutoscalingPolicy(name string) *autoscaling_put_autoscaling_policy.PutAutoscalingPolicy

Create or update an autoscaling policy.

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-autoscaling-put-autoscaling-policy

type MethodCapabilities ¶ added in v9.1.0 

type MethodCapabilities struct {
	// contains filtered or unexported fields
}

func (*MethodCapabilities) Capabilities ¶ added in v9.1.0 

func (p *MethodCapabilities) Capabilities() *capabilities.Capabilities

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

type MethodCat ¶ added in v9.1.0 

type MethodCat struct {
	// contains filtered or unexported fields
}

func (*MethodCat) Aliases ¶ added in v9.1.0 

func (p *MethodCat) Aliases() *cat_aliases.Aliases

Get aliases.

Get the cluster's index aliases, including filter and routing information. This API does not return data stream aliases.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases

func (*MethodCat) Allocation ¶ added in v9.1.0 

func (p *MethodCat) Allocation() *cat_allocation.Allocation

Get shard allocation information.

Get a snapshot of the number of shards allocated to each data node and their disk space.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation

func (*MethodCat) ComponentTemplates ¶ added in v9.1.0 

func (p *MethodCat) ComponentTemplates() *cat_component_templates.ComponentTemplates

Get component templates.

Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates

func (*MethodCat) Count ¶ added in v9.1.0 

func (p *MethodCat) Count() *cat_count.Count

Get a document count.

Get quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count

func (*MethodCat) Fielddata ¶ added in v9.1.0 

func (p *MethodCat) Fielddata() *cat_fielddata.Fielddata

Get field data cache information.

Get the amount of heap memory currently used by the field data cache on every data node in the cluster.

IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata

func (*MethodCat) Health ¶ added in v9.1.0 

func (p *MethodCat) Health() *cat_health.Health

Get the cluster health status.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health

func (*MethodCat) Help ¶ added in v9.1.0 

func (p *MethodCat) Help() *cat_help.Help

Get CAT help.

Get help for the CAT APIs. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat

func (*MethodCat) Indices ¶ added in v9.1.0 

func (p *MethodCat) Indices() *cat_indices.Indices

Get index information.

Get high-level information about indices in a cluster, including backing indices for data streams.

Use this request to get the following information for each index in a cluster: - shard count - document count - deleted document count - primary store size - total store size of all shards, including shard replicas

These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.

CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices

func (*MethodCat) Master ¶ added in v9.1.0 

func (p *MethodCat) Master() *cat_master.Master

Get master node information.

Get information about the master node, including the ID, bound IP address, and name.

IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master

func (*MethodCat) MlDataFrameAnalytics ¶ added in v9.1.0 

func (p *MethodCat) MlDataFrameAnalytics() *cat_ml_data_frame_analytics.MlDataFrameAnalytics

Get data frame analytics jobs.

Get configuration and usage information about data frame analytics jobs.

IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics

func (*MethodCat) MlDatafeeds ¶ added in v9.1.0 

func (p *MethodCat) MlDatafeeds() *cat_ml_datafeeds.MlDatafeeds

Get datafeeds.

Get configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.

IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds

func (*MethodCat) MlJobs ¶ added in v9.1.0 

func (p *MethodCat) MlJobs() *cat_ml_jobs.MlJobs

Get anomaly detection jobs.

Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.

IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs

func (*MethodCat) MlTrainedModels ¶ added in v9.1.0 

func (p *MethodCat) MlTrainedModels() *cat_ml_trained_models.MlTrainedModels

Get trained models.

Get configuration and usage information about inference trained models.

IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models

func (*MethodCat) Nodeattrs ¶ added in v9.1.0 

func (p *MethodCat) Nodeattrs() *cat_nodeattrs.Nodeattrs

Get node attribute information.

Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodeattrs

func (*MethodCat) Nodes ¶ added in v9.1.0 

func (p *MethodCat) Nodes() *cat_nodes.Nodes

Get node information.

Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-nodes

func (*MethodCat) PendingTasks ¶ added in v9.1.0 

func (p *MethodCat) PendingTasks() *cat_pending_tasks.PendingTasks

Get pending task information.

Get information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-pending-tasks

func (*MethodCat) Plugins ¶ added in v9.1.0 

func (p *MethodCat) Plugins() *cat_plugins.Plugins

Get plugin information.

Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-plugins

func (*MethodCat) Recovery ¶ added in v9.1.0 

func (p *MethodCat) Recovery() *cat_recovery.Recovery

Get shard recovery information.

Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-recovery

func (*MethodCat) Repositories ¶ added in v9.1.0 

func (p *MethodCat) Repositories() *cat_repositories.Repositories

Get snapshot repository information.

Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-repositories

func (*MethodCat) Segments ¶ added in v9.1.0 

func (p *MethodCat) Segments() *cat_segments.Segments

Get segment information.

Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-segments

func (*MethodCat) Shards ¶ added in v9.1.0 

func (p *MethodCat) Shards() *cat_shards.Shards

Get shard information.

Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards

func (*MethodCat) Snapshots ¶ added in v9.1.0 

func (p *MethodCat) Snapshots() *cat_snapshots.Snapshots

Get snapshot information.

Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-snapshots

func (*MethodCat) Tasks ¶ added in v9.1.0 

func (p *MethodCat) Tasks() *cat_tasks.Tasks

Get task information.

Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-tasks

func (*MethodCat) Templates ¶ added in v9.1.0 

func (p *MethodCat) Templates() *cat_templates.Templates

Get index template information.

Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates

func (*MethodCat) ThreadPool ¶ added in v9.1.0 

func (p *MethodCat) ThreadPool() *cat_thread_pool.ThreadPool

Get thread pool statistics.

Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-thread-pool

func (*MethodCat) Transforms ¶ added in v9.1.0 

func (p *MethodCat) Transforms() *cat_transforms.Transforms

Get transform information.

Get configuration and usage information about transforms.

CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-transforms

type MethodCcr ¶ added in v9.1.0 

type MethodCcr struct {
	// contains filtered or unexported fields
}

func (*MethodCcr) DeleteAutoFollowPattern ¶ added in v9.1.0 

func (p *MethodCcr) DeleteAutoFollowPattern(name string) *ccr_delete_auto_follow_pattern.DeleteAutoFollowPattern

Delete auto-follow patterns.

Delete a collection of cross-cluster replication auto-follow patterns. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-delete-auto-follow-pattern

func (*MethodCcr) Follow ¶ added in v9.1.0 

func (p *MethodCcr) Follow(index string) *ccr_follow.Follow

Create a follower. Create a cross-cluster replication follower index that follows a specific leader index. When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow

func (*MethodCcr) FollowInfo ¶ added in v9.1.0 

func (p *MethodCcr) FollowInfo(index string) *ccr_follow_info.FollowInfo

Get follower information.

Get information about all cross-cluster replication follower indices. For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-info

func (*MethodCcr) FollowStats ¶ added in v9.1.0 

func (p *MethodCcr) FollowStats(index string) *ccr_follow_stats.FollowStats

Get follower stats.

Get cross-cluster replication follower stats. The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow-stats

func (*MethodCcr) ForgetFollower ¶ added in v9.1.0 

func (p *MethodCcr) ForgetFollower(index string) *ccr_forget_follower.ForgetFollower

Forget a follower. Remove the cross-cluster replication follower retention leases from the leader.

A following index takes out retention leases on its leader index. These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. This API exists to enable manually removing the leases when the unfollow API is unable to do so.

NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-forget-follower

func (*MethodCcr) GetAutoFollowPattern ¶ added in v9.1.0 

func (p *MethodCcr) GetAutoFollowPattern() *ccr_get_auto_follow_pattern.GetAutoFollowPattern

Get auto-follow patterns.

Get cross-cluster replication auto-follow patterns. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-get-auto-follow-pattern-1

func (*MethodCcr) PauseAutoFollowPattern ¶ added in v9.1.0 

func (p *MethodCcr) PauseAutoFollowPattern(name string) *ccr_pause_auto_follow_pattern.PauseAutoFollowPattern

Pause an auto-follow pattern.

Pause a cross-cluster replication auto-follow pattern. When the API returns, the auto-follow pattern is inactive. New indices that are created on the remote cluster and match the auto-follow patterns are ignored.

You can resume auto-following with the resume auto-follow pattern API. When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-auto-follow-pattern

func (*MethodCcr) PauseFollow ¶ added in v9.1.0 

func (p *MethodCcr) PauseFollow(index string) *ccr_pause_follow.PauseFollow

Pause a follower.

Pause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API. You can pause and resume a follower index to change the configuration of the following task. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-pause-follow

func (*MethodCcr) PutAutoFollowPattern ¶ added in v9.1.0 

func (p *MethodCcr) PutAutoFollowPattern(name string) *ccr_put_auto_follow_pattern.PutAutoFollowPattern

Create or update auto-follow patterns. Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.

This API can also be used to update auto-follow patterns. NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-put-auto-follow-pattern

func (*MethodCcr) ResumeAutoFollowPattern ¶ added in v9.1.0 

func (p *MethodCcr) ResumeAutoFollowPattern(name string) *ccr_resume_auto_follow_pattern.ResumeAutoFollowPattern

Resume an auto-follow pattern.

Resume a cross-cluster replication auto-follow pattern that was paused. The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-auto-follow-pattern

func (*MethodCcr) ResumeFollow ¶ added in v9.1.0 

func (p *MethodCcr) ResumeFollow(index string) *ccr_resume_follow.ResumeFollow

Resume a follower. Resume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API. Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. When this API returns, the follower index will resume fetching operations from the leader index. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-resume-follow

func (*MethodCcr) Stats ¶ added in v9.1.0 

func (p *MethodCcr) Stats() *ccr_stats.Stats

Get cross-cluster replication stats.

This API returns stats about auto-following and the same shard-level stats as the get follower stats API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-stats

func (*MethodCcr) Unfollow ¶ added in v9.1.0 

func (p *MethodCcr) Unfollow(index string) *ccr_unfollow.Unfollow

Unfollow an index.

Convert a cross-cluster replication follower index to a regular index. The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. The follower index must be paused and closed before you call the unfollow API.

> info > Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-unfollow

type MethodCluster ¶ added in v9.1.0 

type MethodCluster struct {
	// contains filtered or unexported fields
}

func (*MethodCluster) AllocationExplain ¶ added in v9.1.0 

func (p *MethodCluster) AllocationExplain() *cluster_allocation_explain.AllocationExplain

Explain the shard allocations. Get explanations for shard allocations in the cluster. For unassigned shards, it provides an explanation for why the shard is unassigned. For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. Refer to the linked documentation for examples of how to troubleshoot allocation issues using this API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain

func (*MethodCluster) DeleteComponentTemplate ¶ added in v9.1.0 

func (p *MethodCluster) DeleteComponentTemplate(name string) *cluster_delete_component_template.DeleteComponentTemplate

Delete component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template

func (*MethodCluster) DeleteVotingConfigExclusions ¶ added in v9.1.0 

func (p *MethodCluster) DeleteVotingConfigExclusions() *cluster_delete_voting_config_exclusions.DeleteVotingConfigExclusions

Clear cluster voting config exclusions. Remove master-eligible nodes from the voting configuration exclusion list. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions

func (*MethodCluster) ExistsComponentTemplate ¶ added in v9.1.0 

func (p *MethodCluster) ExistsComponentTemplate(name string) *cluster_exists_component_template.ExistsComponentTemplate

Check component templates. Returns information about whether a particular component template exists. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template

func (*MethodCluster) GetComponentTemplate ¶ added in v9.1.0 

func (p *MethodCluster) GetComponentTemplate() *cluster_get_component_template.GetComponentTemplate

Get component templates. Get information about component templates. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template

func (*MethodCluster) GetSettings ¶ added in v9.1.0 

func (p *MethodCluster) GetSettings() *cluster_get_settings.GetSettings

Get cluster-wide settings.

By default, it returns only settings that have been explicitly defined. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings

func (*MethodCluster) Health ¶ added in v9.1.0 

func (p *MethodCluster) Health() *cluster_health.Health

Get the cluster health status.

You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.

The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated. The index level status is controlled by the worst shard status.

One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. The cluster status is controlled by the worst index status. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health

func (*MethodCluster) Info ¶ added in v9.1.0 

func (p *MethodCluster) Info(target string) *cluster_info.Info

Get cluster info. Returns basic information about the cluster. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info

func (*MethodCluster) PendingTasks ¶ added in v9.1.0 

func (p *MethodCluster) PendingTasks() *cluster_pending_tasks.PendingTasks

Get the pending cluster tasks. Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.

NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-pending-tasks

func (*MethodCluster) PostVotingConfigExclusions ¶ added in v9.1.0 

func (p *MethodCluster) PostVotingConfigExclusions() *cluster_post_voting_config_exclusions.PostVotingConfigExclusions

Update voting configuration exclusions. Update the cluster voting config exclusions by node IDs or node names. By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes.

Clusters should have no voting configuration exclusions in normal operation. Once the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`. This API waits for the nodes to be fully removed from the cluster before it returns. If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster.

A response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`. If the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. In that case, you may safely retry the call.

NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions

func (*MethodCluster) PutComponentTemplate ¶ added in v9.1.0 

func (p *MethodCluster) PutComponentTemplate(name string) *cluster_put_component_template.PutComponentTemplate

Create or update a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template.

Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.

Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices.

You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.

**Applying component templates**

You cannot directly apply a component template to a data stream or index. To be applied, a component template must be included in an index template's `composed_of` list. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template

func (*MethodCluster) PutSettings ¶ added in v9.1.0 

func (p *MethodCluster) PutSettings() *cluster_put_settings.PutSettings

Update the cluster settings.

Configure and update dynamic settings on a running cluster. You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.

Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. You can also reset transient or persistent settings by assigning them a null value.

If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value. For example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting. However, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.

TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster. If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings. Only use `elasticsearch.yml` for static cluster settings and node settings. The API doesn’t require a restart and ensures a setting’s value is the same on all nodes.

WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead. If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings

func (*MethodCluster) RemoteInfo ¶ added in v9.1.0 

func (p *MethodCluster) RemoteInfo() *cluster_remote_info.RemoteInfo

Get remote cluster information.

Get information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias.

> info > This API returns information that reflects current state on the local cluster. > The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it. > Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. > To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the [resolve cluster endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster). https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-remote-info

func (*MethodCluster) Reroute ¶ added in v9.1.0 

func (p *MethodCluster) Reroute() *cluster_reroute.Reroute

Reroute the cluster. Manually change the allocation of individual shards in the cluster. For example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node.

It is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state. For example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out.

The cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting. If allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing.

The cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated. This scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes.

Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-reroute

func (*MethodCluster) State ¶ added in v9.1.0 

func (p *MethodCluster) State() *cluster_state.State

Get the cluster state. Get comprehensive information about the state of the cluster.

The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.

The elected master node ensures that every node in the cluster has a copy of the same cluster state. This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes. You may need to consult the Elasticsearch source code to determine the precise meaning of the response.

By default the API will route requests to the elected master node since this node is the authoritative source of cluster states. You can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter.

Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data. If you use this API repeatedly, your cluster may become unstable.

WARNING: The response is a representation of an internal data structure. Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version. Do not query this API using external monitoring tools. Instead, obtain the information you require using other more stable cluster APIs. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-state

func (*MethodCluster) Stats ¶ added in v9.1.0 

func (p *MethodCluster) Stats() *cluster_stats.Stats

Get cluster statistics. Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats

type MethodConnector ¶ added in v9.1.0 

type MethodConnector struct {
	// contains filtered or unexported fields
}

func (*MethodConnector) CheckIn ¶ added in v9.1.0 

func (p *MethodConnector) CheckIn(connectorid string) *connector_check_in.CheckIn

Check in a connector.

Update the `last_seen` field in the connector and set it to the current timestamp. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in

func (*MethodConnector) Delete ¶ added in v9.1.0 

func (p *MethodConnector) Delete(connectorid string) *connector_delete.Delete

Delete a connector.

Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. These need to be removed manually. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete

func (*MethodConnector) Get ¶ added in v9.1.0 

func (p *MethodConnector) Get(connectorid string) *connector_get.Get

Get a connector.

Get the details about a connector. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get

func (*MethodConnector) LastSync ¶ added in v9.1.0 

func (p *MethodConnector) LastSync(connectorid string) *connector_last_sync.LastSync

Update the connector last sync stats.

Update the fields related to the last sync of a connector. This action is used for analytics and monitoring. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-last-sync

func (*MethodConnector) List ¶ added in v9.1.0 

func (p *MethodConnector) List() *connector_list.List

Get all connectors.

Get information about all connectors. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-list

func (*MethodConnector) Post ¶ added in v9.1.0 

func (p *MethodConnector) Post() *connector_post.Post

Create a connector.

Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put

func (*MethodConnector) Put ¶ added in v9.1.0 

func (p *MethodConnector) Put() *connector_put.Put

Create or update a connector. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put

func (*MethodConnector) SecretPost ¶ added in v9.1.0 

func (p *MethodConnector) SecretPost() *connector_secret_post.SecretPost

Creates a secret for a Connector.

func (*MethodConnector) SyncJobCancel ¶ added in v9.1.0 

func (p *MethodConnector) SyncJobCancel(connectorsyncjobid string) *connector_sync_job_cancel.SyncJobCancel

Cancel a connector sync job.

Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-cancel

func (*MethodConnector) SyncJobCheckIn ¶ added in v9.1.0 

func (p *MethodConnector) SyncJobCheckIn(connectorsyncjobid string) *connector_sync_job_check_in.SyncJobCheckIn

Check in a connector sync job. Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-check-in

func (*MethodConnector) SyncJobClaim ¶ added in v9.1.0 

func (p *MethodConnector) SyncJobClaim(connectorsyncjobid string) *connector_sync_job_claim.SyncJobClaim

Claim a connector sync job. This action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time. Additionally, it can set the `sync_cursor` property for the sync job.

This API is not intended for direct connector management by users. It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-claim

func (*MethodConnector) SyncJobDelete ¶ added in v9.1.0 

func (p *MethodConnector) SyncJobDelete(connectorsyncjobid string) *connector_sync_job_delete.SyncJobDelete

Delete a connector sync job.

Remove a connector sync job and its associated data. This is a destructive action that is not recoverable. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-delete

func (*MethodConnector) SyncJobError ¶ added in v9.1.0 

func (p *MethodConnector) SyncJobError(connectorsyncjobid string) *connector_sync_job_error.SyncJobError

Set a connector sync job error. Set the `error` field for a connector sync job and set its `status` to `error`.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-error

func (*MethodConnector) SyncJobGet ¶ added in v9.1.0 

func (p *MethodConnector) SyncJobGet(connectorsyncjobid string) *connector_sync_job_get.SyncJobGet

Get a connector sync job. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-get

func (*MethodConnector) SyncJobList ¶ added in v9.1.0 

func (p *MethodConnector) SyncJobList() *connector_sync_job_list.SyncJobList

Get all connector sync jobs.

Get information about all stored connector sync jobs listed by their creation date in ascending order. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-list

func (*MethodConnector) SyncJobPost ¶ added in v9.1.0 

func (p *MethodConnector) SyncJobPost() *connector_sync_job_post.SyncJobPost

Create a connector sync job.

Create a connector sync job document in the internal index and initialize its counters and timestamps with default values. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-post

func (*MethodConnector) SyncJobUpdateStats ¶ added in v9.1.0 

func (p *MethodConnector) SyncJobUpdateStats(connectorsyncjobid string) *connector_sync_job_update_stats.SyncJobUpdateStats

Set the connector sync job stats. Stats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`. You can also update `last_seen`. This API is mainly used by the connector service for updating sync job information.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-sync-job-update-stats

func (*MethodConnector) UpdateActiveFiltering ¶ added in v9.1.0 

func (p *MethodConnector) UpdateActiveFiltering(connectorid string) *connector_update_active_filtering.UpdateActiveFiltering

Activate the connector draft filter.

Activates the valid draft filtering for a connector. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering

func (*MethodConnector) UpdateApiKeyId ¶ added in v9.1.0 

func (p *MethodConnector) UpdateApiKeyId(connectorid string) *connector_update_api_key_id.UpdateApiKeyId

Update the connector API key ID.

Update the `api_key_id` and `api_key_secret_id` fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-api-key-id

func (*MethodConnector) UpdateConfiguration ¶ added in v9.1.0 

func (p *MethodConnector) UpdateConfiguration(connectorid string) *connector_update_configuration.UpdateConfiguration

Update the connector configuration.

Update the configuration field in the connector document. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-configuration

func (*MethodConnector) UpdateError ¶ added in v9.1.0 

func (p *MethodConnector) UpdateError(connectorid string) *connector_update_error.UpdateError

Update the connector error field.

Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-error

func (*MethodConnector) UpdateFeatures ¶ added in v9.1.0 

func (p *MethodConnector) UpdateFeatures(connectorid string) *connector_update_features.UpdateFeatures

Update the connector features. Update the connector features in the connector document. This API can be used to control the following aspects of a connector:

* document-level security * incremental syncs * advanced sync rules * basic sync rules

Normally, the running connector service automatically manages these features. However, you can use this API to override the default behavior.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-features

func (*MethodConnector) UpdateFiltering ¶ added in v9.1.0 

func (p *MethodConnector) UpdateFiltering(connectorid string) *connector_update_filtering.UpdateFiltering

Update the connector filtering.

Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering

func (*MethodConnector) UpdateFilteringValidation ¶ added in v9.1.0 

func (p *MethodConnector) UpdateFilteringValidation(connectorid string) *connector_update_filtering_validation.UpdateFilteringValidation

Update the connector draft filtering validation.

Update the draft filtering validation info for a connector. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-filtering-validation

func (*MethodConnector) UpdateIndexName ¶ added in v9.1.0 

func (p *MethodConnector) UpdateIndexName(connectorid string) *connector_update_index_name.UpdateIndexName

Update the connector index name.

Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-index-name

func (*MethodConnector) UpdateName ¶ added in v9.1.0 

func (p *MethodConnector) UpdateName(connectorid string) *connector_update_name.UpdateName

Update the connector name and description. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-name

func (*MethodConnector) UpdateNative ¶ added in v9.1.0 

func (p *MethodConnector) UpdateNative(connectorid string) *connector_update_native.UpdateNative

Update the connector is_native flag. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-native

func (*MethodConnector) UpdatePipeline ¶ added in v9.1.0 

func (p *MethodConnector) UpdatePipeline(connectorid string) *connector_update_pipeline.UpdatePipeline

Update the connector pipeline.

When you create a new connector, the configuration of an ingest pipeline is populated with default settings. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-pipeline

func (*MethodConnector) UpdateScheduling ¶ added in v9.1.0 

func (p *MethodConnector) UpdateScheduling(connectorid string) *connector_update_scheduling.UpdateScheduling

Update the connector scheduling. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-scheduling

func (*MethodConnector) UpdateServiceType ¶ added in v9.1.0 

func (p *MethodConnector) UpdateServiceType(connectorid string) *connector_update_service_type.UpdateServiceType

Update the connector service type. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-service-type

func (*MethodConnector) UpdateStatus ¶ added in v9.1.0 

func (p *MethodConnector) UpdateStatus(connectorid string) *connector_update_status.UpdateStatus

Update the connector status. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-update-status

type MethodCore ¶ added in v9.1.0 

type MethodCore struct {
	// contains filtered or unexported fields
}

func (*MethodCore) Bulk ¶ added in v9.1.0 

func (p *MethodCore) Bulk() *core_bulk.Bulk

Bulk index or delete documents. Perform multiple `index`, `create`, `delete`, and `update` actions in a single request. This reduces overhead and can greatly increase indexing speed.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:

* To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action. * To use the `index` action, you must have the `create`, `index`, or `write` index privilege. * To use the `delete` action, you must have the `delete` or `write` index privilege. * To use the `update` action, you must have the `index` or `write` index privilege. * To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege. * To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege.

Automatic data stream creation requires a matching index template with data stream enabled.

The actions are specified in the request body using a newline delimited JSON (NDJSON) structure:

``` action_and_meta_data\n optional_source\n action_and_meta_data\n optional_source\n .... action_and_meta_data\n optional_source\n ```

The `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API. A `create` action fails if a document with the same ID already exists in the target An `index` action adds or replaces a document as necessary.

NOTE: Data streams support only the `create` action. To update or delete a document in a data stream, you must target the backing index containing the document.

An `update` action expects that the partial doc, upsert, and script and its options are specified on the next line.

A `delete` action does not expect a source on the next line and has the same semantics as the standard delete API.

NOTE: The final line of data must end with a newline character (`\n`). Each newline character may be preceded by a carriage return (`\r`). When sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`. Because this format uses literal newline characters (`\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed.

If you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument.

A note on the format: the idea here is to make processing as fast as possible. As some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side.

Client libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible.

There is no "correct" number of actions to perform in a single bulk request. Experiment with different settings to find the optimal size for your particular workload. Note that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size. It is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch. For instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch.

**Client suppport for bulk requests**

Some of the officially supported clients provide helpers to assist with bulk requests and reindexing:

* Go: Check out `esutil.BulkIndexer` * Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll` * Python: Check out `elasticsearch.helpers.*` * JavaScript: Check out `client.helpers.*` * .NET: Check out `BulkAllObservable` * PHP: Check out bulk indexing.

**Submitting bulk requests with cURL**

If you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`. The latter doesn't preserve newlines. For example:

``` $ cat requests { "index" : { "_index" : "test", "_id" : "1" } } { "field1" : "value1" } $ curl -s -H "Content-Type: application/x-ndjson" -XPOST localhost:9200/_bulk --data-binary "@requests"; echo {"took":7, "errors": false, "items":[{"index":{"_index":"test","_id":"1","_version":1,"result":"created","forced_refresh":false}}]} ```

**Optimistic concurrency control**

Each `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines. The `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details.

**Versioning**

Each bulk item can include the version value using the `version` field. It automatically follows the behavior of the index or delete operation based on the `_version` mapping. It also support the `version_type`.

**Routing**

Each bulk item can include the routing value using the `routing` field. It automatically follows the behavior of the index or delete operation based on the `_routing` mapping.

NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.

**Wait for active shards**

When making bulk calls, you can set the `wait_for_active_shards` parameter to require a minimum number of shard copies to be active before starting to process the bulk request.

**Refresh**

Control when the changes made by this request are visible to search.

NOTE: Only the shards that receive the bulk request will be affected by refresh. Imagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards. The request will only wait for those three shards to refresh. The other two shards that make up the index do not participate in the `_bulk` request at all.

You might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests. Refer to the linked documentation for step-by-step instructions using the index settings API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk

func (*MethodCore) ClearScroll ¶ added in v9.1.0 

func (p *MethodCore) ClearScroll() *core_clear_scroll.ClearScroll

Clear a scrolling search. Clear the search context and results for a scrolling search. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll

func (*MethodCore) ClosePointInTime ¶ added in v9.1.0 

func (p *MethodCore) ClosePointInTime() *core_close_point_in_time.ClosePointInTime

Close a point in time. A point in time must be opened explicitly before being used in search requests. The `keep_alive` parameter tells Elasticsearch how long it should persist. A point in time is automatically closed when the `keep_alive` period has elapsed. However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time

func (*MethodCore) Count ¶ added in v9.1.0 

func (p *MethodCore) Count() *core_count.Count

Count search results. Get the number of documents matching a query.

The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body. The query is optional. When no query is provided, the API uses `match_all` to count all the documents.

The count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.

The operation is broadcast across all shards. For each shard ID group, a replica is chosen and the search is run against it. This means that replicas increase the scalability of the count. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-count

func (*MethodCore) Create ¶ added in v9.1.0 

func (p *MethodCore) Create(index, id string) *core_create.Create

Create a new document in the index.

You can index a new JSON document with the `/<target>/_doc/` or `/<target>/_create/<_id>` APIs Using `_create` guarantees that the document is indexed only if it does not already exist. It returns a 409 response when a document with a same ID already exists in the index. To update an existing document, you must use the `/<target>/_doc/` API.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:

* To add a document using the `PUT /<target>/_create/<_id>` or `POST /<target>/_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege. * To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.

Automatic data stream creation requires a matching index template with data stream enabled.

**Automatically create data streams and indices**

If the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.

If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.

NOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.

If no mapping exists, the index operation creates a dynamic mapping. By default, new fields and objects are automatically added to the mapping if needed.

Automatic index creation is controlled by the `action.auto_create_index` setting. If it is `true`, any index can be created automatically. You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely. Specify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked. When a list is specified, the default behaviour is to disallow.

NOTE: The `action.auto_create_index` setting affects the automatic creation of indices only. It does not affect the creation of data streams.

**Routing**

By default, shard placement — or routing — is controlled by using a hash of the document's ID value. For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.

When setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself. This does come at the (very minimal) cost of an additional document parsing pass. If the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.

NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.

**Distributed**

The index operation is directed to the primary shard based on its route and performed on the actual node containing this shard. After the primary shard completes the operation, if needed, the update is distributed to applicable replicas.

**Active shards**

To improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation. If the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs. By default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`). This default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`. To alter this behavior per operation, use the `wait_for_active_shards request` parameter.

Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1). Specifying a negative value or a number greater than the number of shard copies will throw an error.

For example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes). If you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding. This means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data. If `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding. This requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard. However, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index. The operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.

It is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts. After the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary. The `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create

func (*MethodCore) Delete ¶ added in v9.1.0 

func (p *MethodCore) Delete(index, id string) *core_delete.Delete

Delete a document.

Remove a JSON document from the specified index.

NOTE: You cannot send deletion requests directly to a data stream. To delete a document in a data stream, you must target the backing index containing the document.

**Optimistic concurrency control**

Delete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters. If a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.

**Versioning**

Each document indexed is versioned. When deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime. Every write operation run on a document, deletes included, causes its version to be incremented. The version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations. The length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.

**Routing**

If routing is used during indexing, the routing value also needs to be specified to delete a document.

If the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.

For example:

``` DELETE /my-index-000001/_doc/1?routing=shard-1 ```

This request deletes the document with ID 1, but it is routed based on the user. The document is not deleted if the correct routing is not specified.

**Distributed**

The delete operation gets hashed into a specific shard ID. It then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete

func (*MethodCore) DeleteByQuery ¶ added in v9.1.0 

func (p *MethodCore) DeleteByQuery(index string) *core_delete_by_query.DeleteByQuery

Delete documents.

Deletes documents that match the specified query.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:

* `read` * `delete` or `write`

You can specify the query criteria in the request URI or the request body using the same syntax as the search API. When you submit a delete by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and deletes matching documents using internal versioning. If a document changes between the time that the snapshot is taken and the delete operation is processed, it results in a version conflict and the delete operation fails.

NOTE: Documents with a version equal to 0 cannot be deleted using delete by query because internal versioning does not support 0 as a valid version number.

While processing a delete by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents to delete. A bulk delete request is performed for each batch of matching documents. If a search or bulk request is rejected, the requests are retried up to 10 times, with exponential back off. If the maximum retry limit is reached, processing halts and all failed requests are returned in the response. Any delete requests that completed successfully still stick, they are not rolled back.

You can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`. Note that if you opt to count version conflicts the operation could attempt to delete more documents from the source than `max_docs` until it has successfully deleted `max_docs documents`, or it has gone through every document in the source query.

**Throttling delete requests**

To control the rate at which delete by query issues batches of delete operations, you can set `requests_per_second` to any positive decimal number. This pads each batch with a wait time to throttle the rate. Set `requests_per_second` to `-1` to disable throttling.

Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account. The padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing. By default the batch size is `1000`, so if `requests_per_second` is set to `500`:

``` target_time = 1000 / 500 per second = 2 seconds wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds ```

Since the batch is issued as a single `_bulk` request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set. This is "bursty" instead of "smooth".

**Slicing**

Delete by query supports sliced scroll to parallelize the delete process. This can improve efficiency and provide a convenient way to break the request down into smaller parts.

Setting `slices` to `auto` lets Elasticsearch choose the number of slices to use. This setting will use one slice per shard, up to a certain limit. If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards. Adding slices to the delete by query operation creates sub-requests which means it has some quirks:

* You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices. * Fetching the status of the task for the request with slices only contains the status of completed slices. * These sub-requests are individually addressable for things like cancellation and rethrottling. * Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally. * Canceling the request with `slices` will cancel each sub-request. * Due to the nature of `slices` each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution. * Parameters like `requests_per_second` and `max_docs` on a request with `slices` are distributed proportionally to each sub-request. Combine that with the earlier point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being deleted. * Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.

If you're slicing manually or otherwise tuning automatic slicing, keep in mind that:

* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many `slices` hurts performance. Setting `slices` higher than the number of shards generally does not improve efficiency and adds overhead. * Delete performance scales linearly across available resources with the number of slices.

Whether query or delete performance dominates the runtime depends on the documents being reindexed and cluster resources.

**Cancel a delete by query operation**

Any delete by query can be canceled using the task cancel API. For example:

``` POST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel ```

The task ID can be found by using the get tasks API.

Cancellation should happen quickly but might take a few seconds. The get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query

func (*MethodCore) DeleteByQueryRethrottle ¶ added in v9.1.0 

func (p *MethodCore) DeleteByQueryRethrottle(taskid string) *core_delete_by_query_rethrottle.DeleteByQueryRethrottle

Throttle a delete by query operation.

Change the number of requests per second for a particular delete by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-by-query-rethrottle

func (*MethodCore) DeleteScript ¶ added in v9.1.0 

func (p *MethodCore) DeleteScript(id string) *core_delete_script.DeleteScript

Delete a script or search template. Deletes a stored script or search template. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-delete-script

func (*MethodCore) Exists ¶ added in v9.1.0 

func (p *MethodCore) Exists(index, id string) *core_exists.Exists

Check a document.

Verify that a document exists. For example, check to see if a document with the `_id` 0 exists:

``` HEAD my-index-000001/_doc/0 ```

If the document exists, the API returns a status code of `200 - OK`. If the document doesn’t exist, the API returns `404 - Not Found`.

**Versioning support**

You can use the `version` parameter to check the document only if its current version is equal to the specified one.

Internally, Elasticsearch has marked the old document as deleted and added an entirely new document. The old version of the document doesn't disappear immediately, although you won't be able to access it. Elasticsearch cleans up deleted documents in the background as you continue to index more data. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get

func (*MethodCore) ExistsSource ¶ added in v9.1.0 

func (p *MethodCore) ExistsSource(index, id string) *core_exists_source.ExistsSource

Check for a document source.

Check whether a document source exists in an index. For example:

``` HEAD my-index-000001/_source/1 ```

A document's source is not available if it is disabled in the mapping. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get

func (*MethodCore) Explain ¶ added in v9.1.0 

func (p *MethodCore) Explain(index, id string) *core_explain.Explain

Explain a document match result. Get information about why a specific document matches, or doesn't match, a query. It computes a score explanation for a query and a specific document. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-explain

func (*MethodCore) FieldCaps ¶ added in v9.1.0 

func (p *MethodCore) FieldCaps() *core_field_caps.FieldCaps

Get the field capabilities.

Get information about the capabilities of fields among multiple indices.

For data streams, the API returns field capabilities among the stream’s backing indices. It returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-field-caps

func (*MethodCore) Get ¶ added in v9.1.0 

func (p *MethodCore) Get(index, id string) *core_get.Get

Get a document by its ID.

Get a document and its source or stored fields from an index.

By default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search). In the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields. To turn off realtime behavior, set the `realtime` parameter to false.

**Source filtering**

By default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off. You can turn off `_source` retrieval by using the `_source` parameter:

``` GET my-index-000001/_doc/0?_source=false ```

If you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields. This can be helpful with large documents where partial retrieval can save on network overhead Both parameters take a comma separated list of fields or wildcard expressions. For example:

``` GET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities ```

If you only want to specify includes, you can use a shorter notation:

``` GET my-index-000001/_doc/0?_source=*.id ```

**Routing**

If routing is used during indexing, the routing value also needs to be specified to retrieve a document. For example:

``` GET my-index-000001/_doc/2?routing=user1 ```

This request gets the document with ID 2, but it is routed based on the user. The document is not fetched if the correct routing is not specified.

**Distributed**

The GET operation is hashed into a specific shard ID. It is then redirected to one of the replicas within that shard ID and returns the result. The replicas are the primary shard and its replicas within that shard ID group. This means that the more replicas you have, the better your GET scaling will be.

**Versioning support**

You can use the `version` parameter to retrieve the document only if its current version is equal to the specified one.

Internally, Elasticsearch has marked the old document as deleted and added an entirely new document. The old version of the document doesn't disappear immediately, although you won't be able to access it. Elasticsearch cleans up deleted documents in the background as you continue to index more data. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get

func (*MethodCore) GetScript ¶ added in v9.1.0 

func (p *MethodCore) GetScript(id string) *core_get_script.GetScript

Get a script or search template. Retrieves a stored script or search template. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script

func (*MethodCore) GetScriptContext ¶ added in v9.1.0 

func (p *MethodCore) GetScriptContext() *core_get_script_context.GetScriptContext

Get script contexts.

Get a list of supported script contexts and their methods. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-context

func (*MethodCore) GetScriptLanguages ¶ added in v9.1.0 

func (p *MethodCore) GetScriptLanguages() *core_get_script_languages.GetScriptLanguages

Get script languages.

Get a list of available script types, languages, and contexts. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get-script-languages

func (*MethodCore) GetSource ¶ added in v9.1.0 

func (p *MethodCore) GetSource(index, id string) *core_get_source.GetSource

Get a document's source.

Get the source of a document. For example:

``` GET my-index-000001/_source/1 ```

You can use the source filtering parameters to control which parts of the `_source` are returned:

``` GET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities ``` https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-get

func (*MethodCore) HealthReport ¶ added in v9.1.0 

func (p *MethodCore) HealthReport() *core_health_report.HealthReport

Get the cluster health. Get a report with the health status of an Elasticsearch cluster. The report contains a list of indicators that compose Elasticsearch functionality.

Each indicator has a health status of: green, unknown, yellow or red. The indicator will provide an explanation and metadata describing the reason for its current health status.

The cluster’s status is controlled by the worst indicator status.

In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.

Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. The root cause and remediation steps are encapsulated in a diagnosis. A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.

NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-health-report

func (*MethodCore) Index ¶ added in v9.1.0 

func (p *MethodCore) Index(index string) *core_index.Index

Create or update a document in an index.

Add a JSON document to the specified data stream or index and make it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.

NOTE: You cannot use this API to send update requests for existing documents in a data stream.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:

* To add or overwrite a document using the `PUT /<target>/_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege. * To add a document using the `POST /<target>/_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege. * To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.

Automatic data stream creation requires a matching index template with data stream enabled.

NOTE: Replica shards might not all be started when an indexing operation returns successfully. By default, only the primary is required. Set `wait_for_active_shards` to change this default behavior.

**Automatically create data streams and indices**

If the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.

If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.

NOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.

If no mapping exists, the index operation creates a dynamic mapping. By default, new fields and objects are automatically added to the mapping if needed.

Automatic index creation is controlled by the `action.auto_create_index` setting. If it is `true`, any index can be created automatically. You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely. Specify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked. When a list is specified, the default behaviour is to disallow.

NOTE: The `action.auto_create_index` setting affects the automatic creation of indices only. It does not affect the creation of data streams.

**Optimistic concurrency control**

Index operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters. If a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.

**Routing**

By default, shard placement — or routing — is controlled by using a hash of the document's ID value. For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.

When setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself. This does come at the (very minimal) cost of an additional document parsing pass. If the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.

NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.

**Distributed**

The index operation is directed to the primary shard based on its route and performed on the actual node containing this shard. After the primary shard completes the operation, if needed, the update is distributed to applicable replicas.

**Active shards**

To improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation. If the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs. By default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`). This default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`. To alter this behavior per operation, use the `wait_for_active_shards request` parameter.

Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1). Specifying a negative value or a number greater than the number of shard copies will throw an error.

For example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes). If you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding. This means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data. If `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding. This requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard. However, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index. The operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.

It is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts. After the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary. The `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.

**No operation (noop) updates**

When updating a document by using this API, a new version of the document is always created even if the document hasn't changed. If this isn't acceptable use the `_update` API with `detect_noop` set to `true`. The `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.

There isn't a definitive rule for when noop updates aren't acceptable. It's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.

**Versioning**

Each indexed document is given a version number. By default, internal versioning is used that starts at 1 and increments with each update, deletes included. Optionally, the version number can be set to an external value (for example, if maintained in a database). To enable this functionality, `version_type` should be set to `external`. The value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.

NOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations. If no version is provided, the operation runs without any version checks.

When using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document. If true, the document will be indexed and the new version number used. If the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:

``` PUT my-index-000001/_doc/1?version=2&version_type=external 

{
  "user": {
    "id": "elkbee"
  }
}

In this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1. If the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).

A nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used. Even the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create

func (*MethodCore) Info ¶ added in v9.1.0 

func (p *MethodCore) Info() *core_info.Info

Get cluster info. Get basic build, version, and cluster information. ::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-info

func (*MethodCore) Mget ¶ added in v9.1.0 

func (p *MethodCore) Mget() *core_mget.Mget

Get multiple documents.

Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.

**Filter source fields**

By default, the `_source` field is returned for every document (if stored). Use the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document. You can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions.

**Get stored fields**

Use the `stored_fields` attribute to specify the set of stored fields you want to retrieve. Any requested fields that are not stored are ignored. You can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mget

func (*MethodCore) Msearch ¶ added in v9.1.0 

func (p *MethodCore) Msearch() *core_msearch.Msearch

Run multiple searches.

The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows:

``` header\n body\n header\n body\n ```

This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node.

IMPORTANT: The final line of data must end with a newline character `\n`. Each newline character may be preceded by a carriage return `\r`. When sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch

func (*MethodCore) MsearchTemplate ¶ added in v9.1.0 

func (p *MethodCore) MsearchTemplate() *core_msearch_template.MsearchTemplate

Run multiple templated searches.

Run multiple templated searches with a single request. If you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines. For example:

``` $ cat requests { "index": "my-index" } { "id": "my-search-template", "params": { "query_string": "hello world", "from": 0, "size": 10 }} { "index": "my-other-index" } { "id": "my-other-search-template", "params": { "query_type": "match_all" }}

$ curl -H "Content-Type: application/x-ndjson" -XGET localhost:9200/_msearch/template --data-binary "@requests"; echo ``` https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-msearch-template

func (*MethodCore) Mtermvectors ¶ added in v9.1.0 

func (p *MethodCore) Mtermvectors() *core_mtermvectors.Mtermvectors

Get multiple term vectors.

Get multiple term vectors with a single request. You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI. The response contains a `docs` array with all the fetched termvectors. Each element has the structure provided by the termvectors API.

**Artificial documents**

You can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request. The mapping used is determined by the specified `_index`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-mtermvectors

func (*MethodCore) OpenPointInTime ¶ added in v9.1.0 

func (p *MethodCore) OpenPointInTime(index string) *core_open_point_in_time.OpenPointInTime

Open a point in time.

A search request by default runs against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between `search_after` requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time.

A point in time must be opened explicitly before being used in search requests.

A subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time.

Just like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits. If you want to retrieve more hits, use PIT with `search_after`.

IMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request.

When a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception. To get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime.

**Keeping point in time alive**

The `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time. The value does not need to be long enough to process all data — it just needs to be long enough for the next request.

Normally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments. Once the smaller segments are no longer needed they are deleted. However, open point-in-times prevent the old segments from being deleted since they are still in use.

TIP: Keeping older segments alive means that more disk space and file handles are needed. Ensure that you have configured your nodes to have ample free file handles.

Additionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request. Ensure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates. Note that a point-in-time doesn't prevent its associated indices from being deleted. You can check how many point-in-times (that is, search contexts) are open with the nodes stats API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time

func (*MethodCore) Ping ¶ added in v9.1.0 

func (p *MethodCore) Ping() *core_ping.Ping

Ping the cluster. Get information about whether the cluster is running. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cluster

func (*MethodCore) PutScript ¶ added in v9.1.0 

func (p *MethodCore) PutScript(id string) *core_put_script.PutScript

Create or update a script or search template. Creates or updates a stored script or search template. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-put-script

func (*MethodCore) RankEval ¶ added in v9.1.0 

func (p *MethodCore) RankEval() *core_rank_eval.RankEval

Evaluate ranked search results.

Evaluate the quality of ranked search results over a set of typical search queries. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rank-eval

func (*MethodCore) Reindex ¶ added in v9.1.0 

func (p *MethodCore) Reindex() *core_reindex.Reindex

Reindex documents.

Copy documents from a source to a destination. You can copy all documents to the destination index or reindex a subset of the documents. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.

IMPORTANT: Reindex requires `_source` to be enabled for all documents in the source. The destination should be configured as wanted before calling the reindex API. Reindex does not copy the settings from the source or its associated template. Mappings, shard counts, and replicas, for example, must be configured ahead of time.

If the Elasticsearch security features are enabled, you must have the following security privileges:

* The `read` index privilege for the source data stream, index, or alias. * The `write` index privilege for the destination data stream, index, or index alias. * To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias. * If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias.

If reindexing from a remote cluster, you must explicitly allow the remote host in the `reindex.remote.whitelist` setting. Automatic data stream creation requires a matching index template with data stream enabled.

The `dest` element can be configured like the index API to control optimistic concurrency control. Omitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID.

Setting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source.

Setting `op_type` to `create` causes the reindex API to create only missing documents in the destination. All existing documents will cause a version conflict.

IMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`. A reindex can only add new documents to a destination data stream. It cannot update existing documents in a destination data stream.

By default, version conflicts abort the reindex process. To continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`. In this case, the response includes a count of the version conflicts that were encountered. Note that the handling of other error types is unaffected by the `conflicts` property. Additionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query.

Refer to the linked documentation for examples of how to reindex documents. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex

func (*MethodCore) ReindexRethrottle ¶ added in v9.1.0 

func (p *MethodCore) ReindexRethrottle(taskid string) *core_reindex_rethrottle.ReindexRethrottle

Throttle a reindex operation.

Change the number of requests per second for a particular reindex operation. For example:

``` POST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1 ```

Rethrottling that speeds up the query takes effect immediately. Rethrottling that slows down the query will take effect after completing the current batch. This behavior prevents scroll timeouts. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex

func (*MethodCore) RenderSearchTemplate ¶ added in v9.1.0 

func (p *MethodCore) RenderSearchTemplate() *core_render_search_template.RenderSearchTemplate

Render a search template.

Render a search template as a search request body. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-render-search-template

func (*MethodCore) ScriptsPainlessExecute ¶ added in v9.1.0 

func (p *MethodCore) ScriptsPainlessExecute() *core_scripts_painless_execute.ScriptsPainlessExecute

Run a script.

Runs a script and returns a result. Use this API to build and test scripts, such as when defining a script for a runtime field. This API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.

The API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is.

Each context requires a script, but additional parameters depend on the context you're using for that script. https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples

func (*MethodCore) Scroll ¶ added in v9.1.0 

func (p *MethodCore) Scroll() *core_scroll.Scroll

Run a scrolling search.

IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT).

The scroll API gets large sets of results from a single scrolling search request. To get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter. The `scroll` parameter indicates how long Elasticsearch should retain the search context for the request. The search response returns a scroll ID in the `_scroll_id` response body parameter. You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search.

You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context.

IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-scroll

func (*MethodCore) Search ¶ added in v9.1.0 

func (p *MethodCore) Search() *core_search.Search

Run a search.

Get search hits that match the query defined in the request. You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.

If the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges. To search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices.

**Search slicing**

When paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties. By default the splitting is done first on the shards, then locally on each shard. The local splitting partitions the shard into contiguous ranges based on Lucene document IDs.

For instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard.

IMPORTANT: The same point-in-time ID should be used for all slices. If different PIT IDs are used, slices can overlap and miss documents. This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search

func (*MethodCore) SearchMvt ¶ added in v9.1.0 

func (p *MethodCore) SearchMvt(index, field, zoom, x, y string) *core_search_mvt.SearchMvt

Search a vector tile.

Search a vector tile for geospatial values. Before using this API, you should be familiar with the Mapbox vector tile specification. The API returns results as a binary mapbox vector tile.

Internally, Elasticsearch translates a vector tile search API request into a search containing:

* A `geo_bounding_box` query on the `<field>`. The query uses the `<zoom>/<x>/<y>` tile as a bounding box. * A `geotile_grid` or `geohex_grid` aggregation on the `<field>`. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `<zoom>/<x>/<y>` tile as a bounding box. * Optionally, a `geo_bounds` aggregation on the `<field>`. The search only includes this aggregation if the `exact_bounds` parameter is `true`. * If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.

The API returns results as a binary Mapbox vector tile. Mapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:

* A `hits` layer containing a feature for each `<field>` value matching the `geo_bounding_box` query. * An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data. * A meta layer containing:

  • A feature containing a bounding box. By default, this is the bounding box

of the tile.

  • Value ranges for any sub-aggregations on the `geotile_grid` or

`geohex_grid`.

  • Metadata for the search.

The API only returns features that can display at its zoom level. For example, if a polygon feature has no area at its zoom level, the API omits it. The API returns errors as UTF-8 encoded JSON.

IMPORTANT: You can specify several options for this API as either a query parameter or request body parameter. If you specify both parameters, the query parameter takes precedence.

**Grid precision for geotile**

For a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels. `grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: `<zoom> + grid_precision`. For example, if `<zoom>` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15. The maximum final precision is 29. The `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`. For example, a value of 8 divides the tile into a grid of 256 x 256 cells. The `aggs` layer only contains features for cells with matching data.

**Grid precision for geohex**

For a `grid_agg` of `geohex`, Elasticsearch uses `<zoom>` and `grid_precision` to calculate a final precision as follows: `<zoom> + grid_precision`.

This precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation. The following table maps the H3 resolution for each precision. For example, if `<zoom>` is 3 and `grid_precision` is 3, the precision is 6. At a precision of 6, hexagonal cells have an H3 resolution of 2. If `<zoom>` is 3 and `grid_precision` is 4, the precision is 7. At a precision of 7, hexagonal cells have an H3 resolution of 3.

| Precision | Unique tile bins | H3 resolution | Unique hex bins | Ratio | | --------- | ---------------- | ------------- | ----------------| ----- | | 1 | 4 | 0 | 122 | 30.5 | | 2 | 16 | 0 | 122 | 7.625 | | 3 | 64 | 1 | 842 | 13.15625 | | 4 | 256 | 1 | 842 | 3.2890625 | | 5 | 1024 | 2 | 5882 | 5.744140625 | | 6 | 4096 | 2 | 5882 | 1.436035156 | | 7 | 16384 | 3 | 41162 | 2.512329102 | | 8 | 65536 | 3 | 41162 | 0.6280822754 | | 9 | 262144 | 4 | 288122 | 1.099098206 | | 10 | 1048576 | 4 | 288122 | 0.2747745514 | | 11 | 4194304 | 5 | 2016842 | 0.4808526039 | | 12 | 16777216 | 6 | 14117882 | 0.8414913416 | | 13 | 67108864 | 6 | 14117882 | 0.2103728354 | | 14 | 268435456 | 7 | 98825162 | 0.3681524172 | | 15 | 1073741824 | 8 | 691776122 | 0.644266719 | | 16 | 4294967296 | 8 | 691776122 | 0.1610666797 | | 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 | | 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 | | 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 | | 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 | | 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 | | 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 | | 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 | | 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 | | 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 | | 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 | | 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 | | 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 | | 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 |

Hexagonal cells don't align perfectly on a vector tile. Some cells may intersect more than one vector tile. To compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level. Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.

Learn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt

func (*MethodCore) SearchShards ¶ added in v9.1.0 

func (p *MethodCore) SearchShards() *core_search_shards.SearchShards

Get the search shards.

Get the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the `indices` section.

If the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-shards

func (*MethodCore) SearchTemplate ¶ added in v9.1.0 

func (p *MethodCore) SearchTemplate() *core_search_template.SearchTemplate

Run a search with a search template. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-template

func (*MethodCore) TermsEnum ¶ added in v9.1.0 

func (p *MethodCore) TermsEnum(index string) *core_terms_enum.TermsEnum

Get terms in an index.

Discover terms that match a partial string in an index. This API is designed for low-latency look-ups used in auto-complete scenarios.

> info > The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum

func (*MethodCore) Termvectors ¶ added in v9.1.0 

func (p *MethodCore) Termvectors(index string) *core_termvectors.Termvectors

Get term vector information.

Get information and statistics about terms in the fields of a particular document.

You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request. You can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body. For example:

``` GET /my-index-000001/_termvectors/1?fields=message ```

Fields can be specified using wildcards, similar to the multi match query.

Term vectors are real-time by default, not near real-time. This can be changed by setting `realtime` parameter to `false`.

You can request three types of values: _term information_, _term statistics_, and _field statistics_. By default, all term information and field statistics are returned for all fields but term statistics are excluded.

**Term information**

* term frequency in the field (always returned) * term positions (`positions: true`) * start and end offsets (`offsets: true`) * term payloads (`payloads: true`), as base64 encoded bytes

If the requested information wasn't stored in the index, it will be computed on the fly if possible. Additionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.

> warn > Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.

**Behaviour**

The term and field statistics are not accurate. Deleted documents are not taken into account. The information is only retrieved for the shard the requested document resides in. The term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context. By default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected. Use `routing` only to hit a particular shard. Refer to the linked documentation for detailed examples of how to use this API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-termvectors

func (*MethodCore) Update ¶ added in v9.1.0 

func (p *MethodCore) Update(index, id string) *core_update.Update

Update a document.

Update a document by running a script or passing a partial document.

If the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias.

The script can update, delete, or skip modifying the document. The API also supports passing a partial document, which is merged into the existing document. To fully replace an existing document, use the index API. This operation:

* Gets the document (collocated with the shard) from the index. * Runs the specified script. * Indexes the result.

The document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation.

The `_source` field must be enabled to use this API. In addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp). For usage examples such as partial updates, upserts, and scripted updates, see the External documentation. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update

func (*MethodCore) UpdateByQuery ¶ added in v9.1.0 

func (p *MethodCore) UpdateByQuery(index string) *core_update_by_query.UpdateByQuery

Update documents. Updates documents that match the specified query. If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes.

If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias:

* `read` * `index` or `write`

You can specify the query criteria in the request URI or the request body using the same syntax as the search API.

When you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning. When the versions match, the document is updated and the version number is incremented. If a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails. You can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`. Note that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query.

NOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number.

While processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents. A bulk update request is performed for each batch of matching documents. Any query or update failures cause the update by query request to fail and the failures are shown in the response. Any update requests that completed successfully still stick, they are not rolled back.

**Refreshing shards**

Specifying the `refresh` parameter refreshes all shards once the request completes. This is different to the update API's `refresh` parameter, which causes only the shard that received the request to be refreshed. Unlike the update API, it does not support `wait_for`.

**Running update by query asynchronously**

If the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a [task](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`.

**Waiting for active shards**

`wait_for_active_shards` controls how many copies of a shard must be active before proceeding with the request. See [`wait_for_active_shards`](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create#operation-create-wait_for_active_shards) for details. `timeout` controls how long each write request waits for unavailable shards to become available. Both work exactly the way they work in the [Bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk). Update by query uses scrolled searches, so you can also specify the `scroll` parameter to control how long it keeps the search context alive, for example `?scroll=10m`. The default is 5 minutes.

**Throttling update requests**

To control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number. This pads each batch with a wait time to throttle the rate. Set `requests_per_second` to `-1` to turn off throttling.

Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account. The padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing. By default the batch size is 1000, so if `requests_per_second` is set to `500`:

``` target_time = 1000 / 500 per second = 2 seconds wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds ```

Since the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set. This is "bursty" instead of "smooth".

**Slicing**

Update by query supports sliced scroll to parallelize the update process. This can improve efficiency and provide a convenient way to break the request down into smaller parts.

Setting `slices` to `auto` chooses a reasonable number for most data streams and indices. This setting will use one slice per shard, up to a certain limit. If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards.

Adding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks:

* You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices. * Fetching the status of the task for the request with `slices` only contains the status of completed slices. * These sub-requests are individually addressable for things like cancellation and rethrottling. * Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally. * Canceling the request with slices will cancel each sub-request. * Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution. * Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated. * Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time.

If you're slicing manually or otherwise tuning automatic slicing, keep in mind that:

* Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead. * Update performance scales linearly across available resources with the number of slices.

Whether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources. Refer to the linked documentation for examples of how to update documents using the `_update_by_query` API: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query

func (*MethodCore) UpdateByQueryRethrottle ¶ added in v9.1.0 

func (p *MethodCore) UpdateByQueryRethrottle(taskid string) *core_update_by_query_rethrottle.UpdateByQueryRethrottle

Throttle an update by query operation.

Change the number of requests per second for a particular update by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update-by-query-rethrottle

type MethodDanglingIndices ¶ added in v9.1.0 

type MethodDanglingIndices struct {
	// contains filtered or unexported fields
}

func (*MethodDanglingIndices) DeleteDanglingIndex ¶ added in v9.1.0 

func (p *MethodDanglingIndices) DeleteDanglingIndex(indexuuid string) *dangling_indices_delete_dangling_index.DeleteDanglingIndex

Delete a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-delete-dangling-index

func (*MethodDanglingIndices) ImportDanglingIndex ¶ added in v9.1.0 

func (p *MethodDanglingIndices) ImportDanglingIndex(indexuuid string) *dangling_indices_import_dangling_index.ImportDanglingIndex

Import a dangling index.

If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-import-dangling-index

func (*MethodDanglingIndices) ListDanglingIndices ¶ added in v9.1.0 

func (p *MethodDanglingIndices) ListDanglingIndices() *dangling_indices_list_dangling_indices.ListDanglingIndices

Get the dangling indices.

If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.

Use this API to list dangling indices, which you can then import or delete. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-dangling-indices-list-dangling-indices

type MethodEnrich ¶ added in v9.1.0 

type MethodEnrich struct {
	// contains filtered or unexported fields
}

func (*MethodEnrich) DeletePolicy ¶ added in v9.1.0 

func (p *MethodEnrich) DeletePolicy(name string) *enrich_delete_policy.DeletePolicy

Delete an enrich policy. Deletes an existing enrich policy and its enrich index. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-delete-policy

func (*MethodEnrich) ExecutePolicy ¶ added in v9.1.0 

func (p *MethodEnrich) ExecutePolicy(name string) *enrich_execute_policy.ExecutePolicy

Run an enrich policy. Create the enrich index for an existing enrich policy. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-execute-policy

func (*MethodEnrich) GetPolicy ¶ added in v9.1.0 

func (p *MethodEnrich) GetPolicy() *enrich_get_policy.GetPolicy

Get an enrich policy. Returns information about an enrich policy. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-get-policy

func (*MethodEnrich) PutPolicy ¶ added in v9.1.0 

func (p *MethodEnrich) PutPolicy(name string) *enrich_put_policy.PutPolicy

Create an enrich policy. Creates an enrich policy. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-put-policy

func (*MethodEnrich) Stats ¶ added in v9.1.0 

func (p *MethodEnrich) Stats() *enrich_stats.Stats

Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-enrich-stats

type MethodEql ¶ added in v9.1.0 

type MethodEql struct {
	// contains filtered or unexported fields
}

func (*MethodEql) Delete ¶ added in v9.1.0 

func (p *MethodEql) Delete(id string) *eql_delete.Delete

Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-delete

func (*MethodEql) Get ¶ added in v9.1.0 

func (p *MethodEql) Get(id string) *eql_get.Get

Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get

func (*MethodEql) GetStatus ¶ added in v9.1.0 

func (p *MethodEql) GetStatus(id string) *eql_get_status.GetStatus

Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-get-status

func (*MethodEql) Search ¶ added in v9.1.0 

func (p *MethodEql) Search(index string) *eql_search.Search

Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search

type MethodEsql ¶ added in v9.1.0 

type MethodEsql struct {
	// contains filtered or unexported fields
}

func (*MethodEsql) AsyncQuery ¶ added in v9.1.0 

func (p *MethodEsql) AsyncQuery() *esql_async_query.AsyncQuery

Run an async ES|QL query. Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available.

The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query

func (*MethodEsql) AsyncQueryDelete ¶ added in v9.1.0 

func (p *MethodEsql) AsyncQueryDelete(id string) *esql_async_query_delete.AsyncQueryDelete

Delete an async ES|QL query. If the query is still running, it is cancelled. Otherwise, the stored results are deleted.

If the Elasticsearch security features are enabled, only the following users can use this API to delete a query:

* The authenticated user that submitted the original query request * Users with the `cancel_task` cluster privilege https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-delete

func (*MethodEsql) AsyncQueryGet ¶ added in v9.1.0 

func (p *MethodEsql) AsyncQueryGet(id string) *esql_async_query_get.AsyncQueryGet

Get async ES|QL query results. Get the current status and available results or stored results for an ES|QL asynchronous query. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-get

func (*MethodEsql) AsyncQueryStop ¶ added in v9.1.0 

func (p *MethodEsql) AsyncQueryStop(id string) *esql_async_query_stop.AsyncQueryStop

Stop async ES|QL query.

This API interrupts the query execution and returns the results so far. If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-esql-async-query-stop

func (*MethodEsql) GetQuery ¶ added in v9.1.0 

func (p *MethodEsql) GetQuery(id string) *esql_get_query.GetQuery

Get a specific running ES|QL query information. Returns an object extended information about a running ES|QL query.

func (*MethodEsql) ListQueries ¶ added in v9.1.0 

func (p *MethodEsql) ListQueries() *esql_list_queries.ListQueries

Get running ES|QL queries information. Returns an object containing IDs and other information about the running ES|QL queries.

func (*MethodEsql) Query ¶ added in v9.1.0 

func (p *MethodEsql) Query() *esql_query.Query

Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language) query. https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest

type MethodFeatures ¶ added in v9.1.0 

type MethodFeatures struct {
	// contains filtered or unexported fields
}

func (*MethodFeatures) GetFeatures ¶ added in v9.1.0 

func (p *MethodFeatures) GetFeatures() *features_get_features.GetFeatures

Get the features. Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot. You can use this API to determine which feature states to include when taking a snapshot. By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not.

A feature state includes one or more system indices necessary for a given feature to function. In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together.

The features listed by this API are a combination of built-in features and features defined by plugins. In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-get-features

func (*MethodFeatures) ResetFeatures ¶ added in v9.1.0 

func (p *MethodFeatures) ResetFeatures() *features_reset_features.ResetFeatures

Reset the features. Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices.

WARNING: Intended for development and testing use only. Do not reset features on a production cluster.

Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. This deletes all state information stored in system indices.

The response code is HTTP 200 if the state is successfully reset for all features. It is HTTP 500 if the reset operation failed for any feature.

Note that select features might provide a way to reset particular system indices. Using this API resets all features, both those that are built-in and implemented as plugins.

To list the features that will be affected, use the get features API.

IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-features-reset-features

type MethodFleet ¶ added in v9.1.0 

type MethodFleet struct {
	// contains filtered or unexported fields
}

func (*MethodFleet) GlobalCheckpoints ¶ added in v9.1.0 

func (p *MethodFleet) GlobalCheckpoints(index string) *fleet_global_checkpoints.GlobalCheckpoints

Get global checkpoints.

Get the current global checkpoints for an index. This API is designed for internal use by the Fleet server project. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-fleet

func (*MethodFleet) Msearch ¶ added in v9.1.0 

func (p *MethodFleet) Msearch() *fleet_msearch.Msearch

Run multiple Fleet searches. Run several Fleet searches with a single API request. The API follows the same structure as the multi search API. However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-msearch

func (*MethodFleet) PostSecret ¶ added in v9.1.0 

func (p *MethodFleet) PostSecret() *fleet_post_secret.PostSecret

Creates a secret stored by Fleet.

func (*MethodFleet) Search ¶ added in v9.1.0 

func (p *MethodFleet) Search(index string) *fleet_search.Search

Run a Fleet search. The purpose of the Fleet search API is to provide an API where the search will be run only after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-search

type MethodGraph ¶ added in v9.1.0 

type MethodGraph struct {
	// contains filtered or unexported fields
}

func (*MethodGraph) Explore ¶ added in v9.1.0 

func (p *MethodGraph) Explore(index string) *graph_explore.Explore

Explore graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-graph

type MethodIlm ¶ added in v9.1.0 

type MethodIlm struct {
	// contains filtered or unexported fields
}

func (*MethodIlm) DeleteLifecycle ¶ added in v9.1.0 

func (p *MethodIlm) DeleteLifecycle(policy string) *ilm_delete_lifecycle.DeleteLifecycle

Delete a lifecycle policy. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-delete-lifecycle

func (*MethodIlm) ExplainLifecycle ¶ added in v9.1.0 

func (p *MethodIlm) ExplainLifecycle(index string) *ilm_explain_lifecycle.ExplainLifecycle

Explain the lifecycle state. Get the current lifecycle status for one or more indices. For data streams, the API retrieves the current lifecycle status for the stream's backing indices.

The response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-explain-lifecycle

func (*MethodIlm) GetLifecycle ¶ added in v9.1.0 

func (p *MethodIlm) GetLifecycle() *ilm_get_lifecycle.GetLifecycle

Get lifecycle policies. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-lifecycle

func (*MethodIlm) GetStatus ¶ added in v9.1.0 

func (p *MethodIlm) GetStatus() *ilm_get_status.GetStatus

Get the ILM status.

Get the current index lifecycle management status. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-get-status

func (*MethodIlm) MigrateToDataTiers ¶ added in v9.1.0 

func (p *MethodIlm) MigrateToDataTiers() *ilm_migrate_to_data_tiers.MigrateToDataTiers

Migrate to data tiers routing. Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. Optionally, delete one legacy index template. Using node roles enables ILM to automatically move the indices between data tiers.

Migrating away from custom node attributes routing can be manually performed. This API provides an automated way of performing three out of the four manual steps listed in the migration guide:

1. Stop setting the custom hot attribute on new indices. 1. Remove custom allocation settings from existing ILM policies. 1. Replace custom allocation settings from existing indices with the corresponding tier preference.

ILM must be stopped before performing the migration. Use the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-migrate-to-data-tiers

func (*MethodIlm) MoveToStep ¶ added in v9.1.0 

func (p *MethodIlm) MoveToStep(index string) *ilm_move_to_step.MoveToStep

Move to a lifecycle step. Manually move an index into a specific step in the lifecycle policy and run that step.

WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API.

You must specify both the current step and the step to be executed in the body of the request. The request will fail if the current step does not match the step currently running for the index This is to prevent the index from being moved from an unexpected step into the next step.

When specifying the target (`next_step`) to which the index will be moved, either the name or both the action and name fields are optional. If only the phase is specified, the index will move to the first step of the first action in the target phase. If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. Only actions specified in the ILM policy are considered valid. An index cannot move to a step that is not part of its policy. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-move-to-step

func (*MethodIlm) PutLifecycle ¶ added in v9.1.0 

func (p *MethodIlm) PutLifecycle(policy string) *ilm_put_lifecycle.PutLifecycle

Create or update a lifecycle policy. If the specified policy exists, it is replaced and the policy version is incremented.

NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-put-lifecycle

func (*MethodIlm) RemovePolicy ¶ added in v9.1.0 

func (p *MethodIlm) RemovePolicy(index string) *ilm_remove_policy.RemovePolicy

Remove policies from an index. Remove the assigned lifecycle policies from an index or a data stream's backing indices. It also stops managing the indices. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-remove-policy

func (*MethodIlm) Retry ¶ added in v9.1.0 

func (p *MethodIlm) Retry(index string) *ilm_retry.Retry

Retry a policy. Retry running the lifecycle policy for an index that is in the ERROR step. The API sets the policy back to the step where the error occurred and runs the step. Use the explain lifecycle state API to determine whether an index is in the ERROR step. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-retry

func (*MethodIlm) Start ¶ added in v9.1.0 

func (p *MethodIlm) Start() *ilm_start.Start

Start the ILM plugin. Start the index lifecycle management plugin if it is currently stopped. ILM is started automatically when the cluster is formed. Restarting ILM is necessary only when it has been stopped using the stop ILM API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-start

func (*MethodIlm) Stop ¶ added in v9.1.0 

func (p *MethodIlm) Stop() *ilm_stop.Stop

Stop the ILM plugin. Halt all lifecycle management operations and stop the index lifecycle management plugin. This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.

The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. Use the get ILM status API to check whether ILM is running. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ilm-stop

type MethodIndices ¶ added in v9.1.0 

type MethodIndices struct {
	// contains filtered or unexported fields
}

func (*MethodIndices) AddBlock ¶ added in v9.1.0 

func (p *MethodIndices) AddBlock(index, block string) *indices_add_block.AddBlock

Add an index block.

Add an index block to an index. Index blocks limit the operations allowed on an index by blocking specific operation types. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-add-block

func (*MethodIndices) Analyze ¶ added in v9.1.0 

func (p *MethodIndices) Analyze() *indices_analyze.Analyze

Get tokens from text analysis. The analyze API performs analysis on a text string and returns the resulting tokens.

Generating excessive amount of tokens may cause a node to run out of memory. The `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced. If more than this limit of tokens gets generated, an error occurs. The `_analyze` endpoint without a specified index will always use `10000` as its limit. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze

func (*MethodIndices) CancelMigrateReindex ¶ added in v9.1.0 

func (p *MethodIndices) CancelMigrateReindex(index string) *indices_cancel_migrate_reindex.CancelMigrateReindex

Cancel a migration reindex operation.

Cancel a migration reindex attempt for a data stream or index. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-cancel-migrate-reindex

func (*MethodIndices) ClearCache ¶ added in v9.1.0 

func (p *MethodIndices) ClearCache() *indices_clear_cache.ClearCache

Clear the cache. Clear the cache of one or more indices. For data streams, the API clears the caches of the stream's backing indices.

By default, the clear cache API clears all caches. To clear only specific caches, use the `fielddata`, `query`, or `request` parameters. To clear the cache only of specific fields, use the `fields` parameter. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clear-cache

func (*MethodIndices) Clone ¶ added in v9.1.0 

func (p *MethodIndices) Clone(index, target string) *indices_clone.Clone

Clone an index. Clone an existing index into a new index. Each original primary shard is cloned into a new primary shard in the new index.

IMPORTANT: Elasticsearch does not apply index templates to the resulting index. The API also does not copy index metadata from the original index. Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. For example, if you clone a CCR follower index, the resulting clone will not be a follower index.

The clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`. To set the number of replicas in the resulting index, configure these settings in the clone request.

Cloning works as follows:

* First, it creates a new target index with the same definition as the source index. * Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. * Finally, it recovers the target index as though it were a closed index which had just been re-opened.

IMPORTANT: Indices can only be cloned if they meet the following requirements:

* The index must be marked as read-only and have a cluster health status of green. * The target index must not exist. * The source index must have the same number of primary shards as the target index. * The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.

The current write index on a data stream cannot be cloned. In order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned.

NOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index.

**Monitor the cloning process**

The cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`.

The `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated. At this point, all shards are in the state unassigned. If, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node.

Once the primary shard is allocated, it moves to state initializing, and the clone process begins. When the clone operation completes, the shard will become active. At that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node.

**Wait for active shards**

Because the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone

func (*MethodIndices) Close ¶ added in v9.1.0 

func (p *MethodIndices) Close(index string) *indices_close.Close

Close an index. A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. It is not possible to index documents or to search for documents in a closed index. Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster.

When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. The shards will then go through the normal recovery process. The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.

You can open and close multiple indices. An error is thrown if the request explicitly refers to a missing index. This behaviour can be turned off using the `ignore_unavailable=true` parameter.

By default, you must explicitly name the indices you are opening or closing. To open or close indices with `_all`, `*`, or other wildcard expressions, change the` action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API.

Closed indices consume a significant amount of disk-space which can cause problems in managed environments. Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-close

func (*MethodIndices) Create ¶ added in v9.1.0 

func (p *MethodIndices) Create(index string) *indices_create.Create

Create an index. You can use the create index API to add a new index to an Elasticsearch cluster. When creating an index, you can specify the following:

* Settings for the index. * Mappings for fields in the index. * Index aliases

**Wait for active shards**

By default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out. The index creation response will indicate what happened. For example, `acknowledged` indicates whether the index was successfully created in the cluster, `while shards_acknowledged` indicates whether the requisite number of shard copies were started for each shard in the index before timing out. Note that it is still possible for either `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation to be successful. These values simply indicate whether the operation completed before the timeout. If `acknowledged` is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon. If `shards_acknowledged` is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, `acknowledged` is `true`).

You can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`. Note that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create

func (*MethodIndices) CreateDataStream ¶ added in v9.1.0 

func (p *MethodIndices) CreateDataStream(name string) *indices_create_data_stream.CreateDataStream

Create a data stream.

You must have a matching index template with data stream enabled. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-data-stream

func (*MethodIndices) CreateFrom ¶ added in v9.1.0 

func (p *MethodIndices) CreateFrom(source, dest string) *indices_create_from.CreateFrom

Create an index from a source index.

Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-create-from

func (*MethodIndices) DataStreamsStats ¶ added in v9.1.0 

func (p *MethodIndices) DataStreamsStats() *indices_data_streams_stats.DataStreamsStats

Get data stream stats.

Get statistics for one or more data streams. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-data-streams-stats-1

func (*MethodIndices) Delete ¶ added in v9.1.0 

func (p *MethodIndices) Delete(index string) *indices_delete.Delete

Delete indices. Deleting an index deletes its documents, shards, and metadata. It does not delete related Kibana components, such as data views, visualizations, or dashboards.

You cannot delete the current write index of a data stream. To delete the index, you must roll over the data stream so a new write index is created. You can then use the delete index API to delete the previous write index. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete

func (*MethodIndices) DeleteAlias ¶ added in v9.1.0 

func (p *MethodIndices) DeleteAlias(index, name string) *indices_delete_alias.DeleteAlias

Delete an alias. Removes a data stream or index from an alias. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-alias

func (*MethodIndices) DeleteDataLifecycle ¶ added in v9.1.0 

func (p *MethodIndices) DeleteDataLifecycle(name string) *indices_delete_data_lifecycle.DeleteDataLifecycle

Delete data stream lifecycles. Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-lifecycle

func (*MethodIndices) DeleteDataStream ¶ added in v9.1.0 

func (p *MethodIndices) DeleteDataStream(name string) *indices_delete_data_stream.DeleteDataStream

Delete data streams. Deletes one or more data streams and their backing indices. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-data-stream

func (*MethodIndices) DeleteDataStreamOptions ¶ added in v9.1.0 

func (p *MethodIndices) DeleteDataStreamOptions(name string) *indices_delete_data_stream_options.DeleteDataStreamOptions

Delete data stream options. Removes the data stream options from a data stream. https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html

func (*MethodIndices) DeleteIndexTemplate ¶ added in v9.1.0 

func (p *MethodIndices) DeleteIndexTemplate(name string) *indices_delete_index_template.DeleteIndexTemplate

Delete an index template. The provided <index-template> may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-index-template

func (*MethodIndices) DeleteTemplate ¶ added in v9.1.0 

func (p *MethodIndices) DeleteTemplate(name string) *indices_delete_template.DeleteTemplate

Delete a legacy index template. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-template

func (*MethodIndices) DiskUsage ¶ added in v9.1.0 

func (p *MethodIndices) DiskUsage(index string) *indices_disk_usage.DiskUsage

Analyze the index disk usage. Analyze the disk usage of each field of an index or data stream. This API might not support indices created in previous Elasticsearch versions. The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.

NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API. Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate. The stored size of the `_id` field is likely underestimated while the `_source` field is overestimated. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-disk-usage

func (*MethodIndices) Downsample ¶ added in v9.1.0 

func (p *MethodIndices) Downsample(index, targetindex string) *indices_downsample.Downsample

Downsample an index. Aggregate a time series (TSDS) index and store pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. All documents within an hour interval are summarized and stored as a single document in the downsample index.

NOTE: Only indices in a time series data stream are supported. Neither field nor document level security can be defined on the source index. The source index must be read only (`index.blocks.write: true`). https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample

func (*MethodIndices) Exists ¶ added in v9.1.0 

func (p *MethodIndices) Exists(index string) *indices_exists.Exists

Check indices. Check if one or more indices, index aliases, or data streams exist. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists

func (*MethodIndices) ExistsAlias ¶ added in v9.1.0 

func (p *MethodIndices) ExistsAlias(name string) *indices_exists_alias.ExistsAlias

Check aliases.

Check if one or more data stream or index aliases exist. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-alias

func (*MethodIndices) ExistsIndexTemplate ¶ added in v9.1.0 

func (p *MethodIndices) ExistsIndexTemplate(name string) *indices_exists_index_template.ExistsIndexTemplate

Check index templates.

Check whether index templates exist. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-index-template

func (*MethodIndices) ExistsTemplate ¶ added in v9.1.0 

func (p *MethodIndices) ExistsTemplate(name string) *indices_exists_template.ExistsTemplate

Check existence of index templates. Get information about whether index templates exist. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-exists-template

func (*MethodIndices) ExplainDataLifecycle ¶ added in v9.1.0 

func (p *MethodIndices) ExplainDataLifecycle(index string) *indices_explain_data_lifecycle.ExplainDataLifecycle

Get the status for a data stream lifecycle. Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-explain-data-lifecycle

func (*MethodIndices) FieldUsageStats ¶ added in v9.1.0 

func (p *MethodIndices) FieldUsageStats(index string) *indices_field_usage_stats.FieldUsageStats

Get field usage stats. Get field usage information for each shard and field of an index. Field usage statistics are automatically captured when queries are running on a cluster. A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use.

The response body reports the per-shard usage count of the data structures that back the fields in the index. A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-field-usage-stats

func (*MethodIndices) Flush ¶ added in v9.1.0 

func (p *MethodIndices) Flush() *indices_flush.Flush

Flush data streams or indices. Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush.

After each operation has been flushed it is permanently stored in the Lucene index. This may mean that there is no need to maintain an additional copy of it in the transaction log. The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space.

It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-flush

func (*MethodIndices) Forcemerge ¶ added in v9.1.0 

func (p *MethodIndices) Forcemerge() *indices_forcemerge.Forcemerge

Force a merge. Perform the force merge operation on the shards of one or more indices. For data streams, the API forces a merge on the shards of the stream's backing indices.

Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. Merging normally happens automatically, but sometimes it is useful to trigger a merge manually.

WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". These soft-deleted documents are automatically cleaned up during regular segment merges. But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.

**Blocks during a force merge**

Calls to this API block until the merge is complete (unless request contains `wait_for_completion=false`). If the client connection is lost before completion then the force merge process will continue in the background. Any new requests to force merge the same indices will also block until the ongoing force merge is complete.

**Running force merge asynchronously**

If the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task. However, you can not cancel this task as the force merge task is not cancelable. Elasticsearch creates a record of this task as a document at `_tasks/<task_id>`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.

**Force merging multiple indices**

You can force merge multiple indices with a single request by targeting:

* One or more data streams that contain multiple backing indices * Multiple indices * One or more aliases * All data streams and indices in a cluster

Each targeted shard is force-merged separately using the force_merge threadpool. By default each node only has a single `force_merge` thread which means that the shards on that node are force-merged one at a time. If you expand the `force_merge` threadpool on a node then it will force merge its shards in parallel

Force merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one.

**Data streams and time-based indices**

Force-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover. In these cases, each index only receives indexing traffic for a certain period of time. Once an index receive no more writes, its shards can be force-merged to a single segment. This can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches. For example:

``` POST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1 ``` https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-forcemerge

func (*MethodIndices) Get ¶ added in v9.1.0 

func (p *MethodIndices) Get(index string) *indices_get.Get

Get index information. Get information about one or more indices. For data streams, the API returns information about the stream’s backing indices. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get

func (*MethodIndices) GetAlias ¶ added in v9.1.0 

func (p *MethodIndices) GetAlias() *indices_get_alias.GetAlias

Get aliases. Retrieves information for one or more data stream or index aliases. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-alias

func (*MethodIndices) GetDataLifecycle ¶ added in v9.1.0 

func (p *MethodIndices) GetDataLifecycle(name string) *indices_get_data_lifecycle.GetDataLifecycle

Get data stream lifecycles.

Get the data stream lifecycle configuration of one or more data streams. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle

func (*MethodIndices) GetDataLifecycleStats ¶ added in v9.1.0 

func (p *MethodIndices) GetDataLifecycleStats() *indices_get_data_lifecycle_stats.GetDataLifecycleStats

Get data stream lifecycle stats. Get statistics about the data streams that are managed by a data stream lifecycle. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-lifecycle-stats

func (*MethodIndices) GetDataStream ¶ added in v9.1.0 

func (p *MethodIndices) GetDataStream() *indices_get_data_stream.GetDataStream

Get data streams.

Get information about one or more data streams. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream

func (*MethodIndices) GetDataStreamOptions ¶ added in v9.1.0 

func (p *MethodIndices) GetDataStreamOptions(name string) *indices_get_data_stream_options.GetDataStreamOptions

Get data stream options.

Get the data stream options configuration of one or more data streams. https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html

func (*MethodIndices) GetDataStreamSettings ¶ added in v9.1.0 

func (p *MethodIndices) GetDataStreamSettings(name string) *indices_get_data_stream_settings.GetDataStreamSettings

Get data stream settings.

Get setting information for one or more data streams. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-settings

func (*MethodIndices) GetFieldMapping ¶ added in v9.1.0 

func (p *MethodIndices) GetFieldMapping(fields string) *indices_get_field_mapping.GetFieldMapping

Get mapping definitions. Retrieves mapping definitions for one or more fields. For data streams, the API retrieves field mappings for the stream’s backing indices.

This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping

func (*MethodIndices) GetIndexTemplate ¶ added in v9.1.0 

func (p *MethodIndices) GetIndexTemplate() *indices_get_index_template.GetIndexTemplate

Get index templates. Get information about one or more index templates. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-index-template

func (*MethodIndices) GetMapping ¶ added in v9.1.0 

func (p *MethodIndices) GetMapping() *indices_get_mapping.GetMapping

Get mapping definitions. For data streams, the API retrieves mappings for the stream’s backing indices. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-mapping

func (*MethodIndices) GetMigrateReindexStatus ¶ added in v9.1.0 

func (p *MethodIndices) GetMigrateReindexStatus(index string) *indices_get_migrate_reindex_status.GetMigrateReindexStatus

Get the migration reindexing status.

Get the status of a migration reindex attempt for a data stream or index. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-migration

func (*MethodIndices) GetSettings ¶ added in v9.1.0 

func (p *MethodIndices) GetSettings() *indices_get_settings.GetSettings

Get index settings. Get setting information for one or more indices. For data streams, it returns setting information for the stream's backing indices. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings

func (*MethodIndices) GetTemplate ¶ added in v9.1.0 

func (p *MethodIndices) GetTemplate() *indices_get_template.GetTemplate

Get legacy index templates. Get information about one or more index templates.

IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-template

func (*MethodIndices) MigrateReindex ¶ added in v9.1.0 

func (p *MethodIndices) MigrateReindex() *indices_migrate_reindex.MigrateReindex

Reindex legacy backing indices.

Reindex all legacy backing indices for a data stream. This operation occurs in a persistent task. The persistent task ID is returned immediately and the reindexing work is completed in that task. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-reindex

func (*MethodIndices) MigrateToDataStream ¶ added in v9.1.0 

func (p *MethodIndices) MigrateToDataStream(name string) *indices_migrate_to_data_stream.MigrateToDataStream

Convert an index alias to a data stream. Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-migrate-to-data-stream

func (*MethodIndices) ModifyDataStream ¶ added in v9.1.0 

func (p *MethodIndices) ModifyDataStream() *indices_modify_data_stream.ModifyDataStream

Update data streams. Performs one or more data stream modification actions in a single atomic operation. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-modify-data-stream

func (*MethodIndices) Open ¶ added in v9.1.0 

func (p *MethodIndices) Open(index string) *indices_open.Open

Open a closed index. For data streams, the API opens any closed backing indices.

A closed index is blocked for read/write operations and does not allow all operations that opened indices allow. It is not possible to index documents or to search for documents in a closed index. This allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster.

When opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index. The shards will then go through the normal recovery process. The data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times.

You can open and close multiple indices. An error is thrown if the request explicitly refers to a missing index. This behavior can be turned off by using the `ignore_unavailable=true` parameter.

By default, you must explicitly name the indices you are opening or closing. To open or close indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API.

Closed indices consume a significant amount of disk-space which can cause problems in managed environments. Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`.

Because opening or closing an index allocates its shards, the `wait_for_active_shards` setting on index creation applies to the `_open` and `_close` index actions as well. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-open

func (*MethodIndices) PromoteDataStream ¶ added in v9.1.0 

func (p *MethodIndices) PromoteDataStream(name string) *indices_promote_data_stream.PromoteDataStream

Promote a data stream. Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.

With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. These data streams can't be rolled over in the local cluster. These replicated data streams roll over only if the upstream data stream rolls over. In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.

NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. If this is missing, the data stream will not be able to roll over until a matching index template is created. This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-promote-data-stream

func (*MethodIndices) PutAlias ¶ added in v9.1.0 

func (p *MethodIndices) PutAlias(index, name string) *indices_put_alias.PutAlias

Create or update an alias. Adds a data stream or index to an alias. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-alias

func (*MethodIndices) PutDataLifecycle ¶ added in v9.1.0 

func (p *MethodIndices) PutDataLifecycle(name string) *indices_put_data_lifecycle.PutDataLifecycle

Update data stream lifecycles. Update the data stream lifecycle of the specified data streams. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-lifecycle

func (*MethodIndices) PutDataStreamOptions ¶ added in v9.1.0 

func (p *MethodIndices) PutDataStreamOptions(name string) *indices_put_data_stream_options.PutDataStreamOptions

Update data stream options. Update the data stream options of the specified data streams. https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html

func (*MethodIndices) PutDataStreamSettings ¶ added in v9.1.0 

func (p *MethodIndices) PutDataStreamSettings(name string) *indices_put_data_stream_settings.PutDataStreamSettings

Update data stream settings.

This API can be used to override settings on specific data streams. These overrides will take precedence over what is specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state, only certain settings are allowed. If possible, the setting change is applied to all backing indices. Otherwise, it will be applied when the data stream is next rolled over. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-data-stream-settings

func (*MethodIndices) PutIndexTemplate ¶ added in v9.1.0 

func (p *MethodIndices) PutIndexTemplate(name string) *indices_put_index_template.PutIndexTemplate

Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name. Index templates are applied during data stream or index creation. For data streams, these settings and mappings are applied when the stream's backing indices are created. Settings and mappings specified in a create index API request override any settings or mappings specified in an index template. Changes to index templates do not affect existing indices, including the existing backing indices of a data stream.

You can use C-style `/* *\/` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket.

**Multiple matching templates**

If multiple index templates match the name of a new index or data stream, the template with the highest priority is used.

Multiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.

**Composing aliases, mappings, and settings**

When multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates. Any mappings, settings, or aliases from the parent index template are merged in next. Finally, any configuration on the index request itself is merged. Mapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration. If a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one. This recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`. If an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end. If an entry already exists with the same key, then it is overwritten by the new definition. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-index-template

func (*MethodIndices) PutMapping ¶ added in v9.1.0 

func (p *MethodIndices) PutMapping(index string) *indices_put_mapping.PutMapping

Update field mappings. Add new fields to an existing data stream or index. You can use the update mapping API to:

- Add a new field to an existing index - Update mappings for multiple indices in a single request - Add new properties to an object field - Enable multi-fields for an existing field - Update supported mapping parameters - Change a field's mapping using reindexing - Rename a field using a field alias

Learn how to use the update mapping API with practical examples in the [Update mapping API examples](https://www.elastic.co/docs//manage-data/data-store/mapping/update-mappings-examples) guide. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping

func (*MethodIndices) PutSettings ¶ added in v9.1.0 

func (p *MethodIndices) PutSettings() *indices_put_settings.PutSettings

Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.

To revert a setting to the default value, use a null value. The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation. To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.

For performance optimization during bulk indexing, you can disable the refresh interval. Refer to [disable refresh interval](https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval) for an example. There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:

``` 

{
  "number_of_replicas": 1
}

```

Or you can use an `index` setting object: ``` 

{
  "index": {
    "number_of_replicas": 1
  }
}

```

Or you can use dot annotation: ``` 

{
  "index.number_of_replicas": 1
}

```

Or you can embed any of the aforementioned options in a `settings` object. For example:

``` 

{
  "settings": {
    "index": {
      "number_of_replicas": 1
    }
  }
}

```

NOTE: You can only define new analyzers on closed indices. To add an analyzer, you must close the index, define the analyzer, and reopen the index. You cannot close the write index of a data stream. To update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream. Then roll over the data stream to apply the new analyzer to the stream's write index and future backing indices. This affects searches and any new data added to the stream after the rollover. However, it does not affect the data stream's backing indices or their existing data. To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it. Refer to [updating analyzers on existing indices](https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices) for step-by-step examples. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-settings

func (*MethodIndices) PutTemplate ¶ added in v9.1.0 

func (p *MethodIndices) PutTemplate(name string) *indices_put_template.PutTemplate

Create or update a legacy index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name.

IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

Composable templates always take precedence over legacy templates. If no composable template matches a new index, matching legacy templates are applied according to their order.

Index templates are only applied during index creation. Changes to index templates do not affect existing indices. Settings and mappings specified in create index API requests override any settings or mappings specified in an index template.

You can use C-style `/* *\/` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket.

**Indices matching multiple templates**

Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index. The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them. NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-template

func (*MethodIndices) Recovery ¶ added in v9.1.0 

func (p *MethodIndices) Recovery() *indices_recovery.Recovery

Get index recovery information. Get information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream's backing indices.

All recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time.

Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing.

Recovery automatically occurs during the following processes:

* When creating an index for the first time. * When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. * Creation of new replica shard copies from the primary. * Relocation of a shard copy to a different node in the same cluster. * A snapshot restore operation. * A clone, shrink, or split operation.

You can determine the cause of a shard recovery using the recovery or cat recovery APIs.

The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-recovery

func (*MethodIndices) Refresh ¶ added in v9.1.0 

func (p *MethodIndices) Refresh() *indices_refresh.Refresh

Refresh an index. A refresh makes recent operations performed on one or more indices available for search. For data streams, the API runs the refresh operation on the stream’s backing indices.

By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds. You can change this default interval with the `index.refresh_interval` setting.

Refresh requests are synchronous and do not return a response until the refresh operation completes.

Refreshes are resource-intensive. To ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible.

If your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's `refresh=wait_for` query parameter option. This option ensures the indexing operation waits for a periodic refresh before running the search. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-refresh

func (*MethodIndices) ReloadSearchAnalyzers ¶ added in v9.1.0 

func (p *MethodIndices) ReloadSearchAnalyzers(index string) *indices_reload_search_analyzers.ReloadSearchAnalyzers

Reload search analyzers. Reload an index's search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream's backing indices.

IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer.

You can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer. To be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers.

NOTE: This API does not perform a reload for each shard of an index. Instead, it performs a reload for each node containing index shards. As a result, the total shard count returned by the API can differ from the number of index shards. Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers

func (*MethodIndices) RemoveBlock ¶ added in v9.1.0 

func (p *MethodIndices) RemoveBlock(index, block string) *indices_remove_block.RemoveBlock

Remove an index block.

Remove an index block from an index. Index blocks limit the operations allowed on an index by blocking specific operation types. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-remove-block

func (*MethodIndices) ResolveCluster ¶ added in v9.1.0 

func (p *MethodIndices) ResolveCluster() *indices_resolve_cluster.ResolveCluster

Resolve the cluster.

Resolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included. If no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster.

This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.

You use the same index expression with this endpoint as you would for cross-cluster search. Index and cluster exclusions are also supported with this endpoint.

For each cluster in the index expression, information is returned about:

* Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the `remote/info` endpoint. * Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`. * Whether there are any indices, aliases, or data streams on that cluster that match the index expression. * Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). * Cluster version information, including the Elasticsearch server version.

For example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`. Each cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`.

## Note on backwards compatibility The ability to query without an index expression was added in version 8.18, so when querying remote clusters older than that, the local cluster will send the index expression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference to that index expression even though you didn't request it. If it causes a problem, you can instead include an index expression like `*:*` to bypass the issue.

## Advantages of using this endpoint before a cross-cluster search

You may want to exclude a cluster or index from a search when:

* A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail. * A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search. * The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.) * A remote cluster is an older version that does not support the feature you want to use in your search.

## Test availability of remote clusters

The `remote/info` endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not. The remote cluster may be available, while the local cluster is not currently connected to it.

You can use the `_resolve/cluster` API to attempt to reconnect to remote clusters. For example with `GET _resolve/cluster` or `GET _resolve/cluster/*:*`. The `connected` field in the response will indicate whether it was successful. If a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-cluster

func (*MethodIndices) ResolveIndex ¶ added in v9.1.0 

func (p *MethodIndices) ResolveIndex(name string) *indices_resolve_index.ResolveIndex

Resolve indices. Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index

func (*MethodIndices) Rollover ¶ added in v9.1.0 

func (p *MethodIndices) Rollover(alias string) *indices_rollover.Rollover

Roll over to a new index. TIP: It is recommended to use the index lifecycle rollover action to automate rollovers.

The rollover API creates a new index for a data stream or index alias. The API behavior depends on the rollover target.

**Roll over a data stream**

If you roll over a data stream, the API creates a new write index for the stream. The stream's previous write index becomes a regular backing index. A rollover also increments the data stream's generation.

**Roll over an index alias with a write index**

TIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data. Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers.

If an index alias points to multiple indices, one of the indices must be a write index. The rollover API creates a new write index for the alias with `is_write_index` set to `true`. The API also `sets is_write_index` to `false` for the previous write index.

**Roll over an index alias with one index**

If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.

NOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.

**Increment index names for an alias**

When you roll over an index alias, you can specify a name for the new index. If you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number. For example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`. This number is always six characters and zero-padded, regardless of the previous index's name.

If you use an index alias for time series data, you can use date math in the index name to track the rollover date. For example, you can create an alias that points to an index named `<my-index-{now/d}-000001>`. If you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`. If you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-rollover

func (*MethodIndices) Segments ¶ added in v9.1.0 

func (p *MethodIndices) Segments() *indices_segments.Segments

Get index segments. Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream's backing indices. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-segments

func (*MethodIndices) ShardStores ¶ added in v9.1.0 

func (p *MethodIndices) ShardStores() *indices_shard_stores.ShardStores

Get index shard stores. Get store information about replica shards in one or more indices. For data streams, the API retrieves store information for the stream's backing indices.

The index shard stores API returns the following information:

* The node on which each replica shard exists. * The allocation ID for each replica shard. * A unique ID for each replica shard. * Any errors encountered while opening the shard index or from an earlier failure.

By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shard-stores

func (*MethodIndices) Shrink ¶ added in v9.1.0 

func (p *MethodIndices) Shrink(index, target string) *indices_shrink.Shrink

Shrink an index. Shrink an index into a new index with fewer primary shards.

Before you can shrink an index:

* The index must be read-only. * A copy of every shard in the index must reside on the same node. * The index must have a green health status.

To make shard allocation easier, we recommend you also remove the index's replica shards. You can later re-add replica shards as part of the shrink operation.

The requested number of primary shards in the target index must be a factor of the number of shards in the source index. For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. If the number of shards in the index is a prime number it can only be shrunk into a single primary shard 

Before shrinking, a (primary or replica) copy of every shard in the index

must be present on the same node.

The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk.

A shrink operation:

* Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. * Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. * Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting.

IMPORTANT: Indices can only be shrunk if they satisfy the following requirements:

* The target index must not exist. * The source index must have more primary shards than the target index. * The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. * The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. * The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-shrink

func (*MethodIndices) SimulateIndexTemplate ¶ added in v9.1.0 

func (p *MethodIndices) SimulateIndexTemplate(name string) *indices_simulate_index_template.SimulateIndexTemplate

Simulate an index. Get the index configuration that would be applied to the specified index from an existing index template. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-index-template

func (*MethodIndices) SimulateTemplate ¶ added in v9.1.0 

func (p *MethodIndices) SimulateTemplate() *indices_simulate_template.SimulateTemplate

Simulate an index template. Get the index configuration that would be applied by a particular index template. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-simulate-template

func (*MethodIndices) Split ¶ added in v9.1.0 

func (p *MethodIndices) Split(index, target string) *indices_split.Split

Split an index. Split an index into a new index with more primary shards. * Before you can split an index:

* The index must be read-only. * The cluster health status must be green.

You can do make an index read-only with the following request using the add index block API:

``` PUT /my_source_index/_block/write ```

The current write index on a data stream cannot be split. In order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split.

The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting. The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. For instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3.

A split operation:

* Creates a new target index with the same definition as the source index, but with a larger number of primary shards. * Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. * Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. * Recovers the target index as though it were a closed index which had just been re-opened.

IMPORTANT: Indices can only be split if they satisfy the following requirements:

* The target index must not exist. * The source index must have fewer primary shards than the target index. * The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. * The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-split

func (*MethodIndices) Stats ¶ added in v9.1.0 

func (p *MethodIndices) Stats() *indices_stats.Stats

Get index statistics. For data streams, the API retrieves statistics for the stream's backing indices.

By default, the returned statistics are index-level with `primaries` and `total` aggregations. `primaries` are the values for only the primary shards. `total` are the accumulated values for both primary and replica shards.

To get shard-level statistics, set the `level` parameter to `shards`.

NOTE: When moving to another node, the shard-level statistics for a shard are cleared. Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-stats

func (*MethodIndices) UpdateAliases ¶ added in v9.1.0 

func (p *MethodIndices) UpdateAliases() *indices_update_aliases.UpdateAliases

Create or update an alias. Adds a data stream or index to an alias. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-update-aliases

func (*MethodIndices) ValidateQuery ¶ added in v9.1.0 

func (p *MethodIndices) ValidateQuery() *indices_validate_query.ValidateQuery

Validate a query. Validates a query without running it. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-validate-query

type MethodInference ¶ added in v9.1.0 

type MethodInference struct {
	// contains filtered or unexported fields
}

func (*MethodInference) ChatCompletionUnified ¶ added in v9.1.0 

func (p *MethodInference) ChatCompletionUnified(inferenceid string) *inference_chat_completion_unified.ChatCompletionUnified

Perform chat completion inference

The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. It only works with the `chat_completion` task type for `openai` and `elastic` inference services.

NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming. The Chat completion inference API and the Stream inference API differ in their response structure and capabilities. The Chat completion inference API provides more comprehensive customization options through more fields and function calling support. If you use the `openai`, `hugging_face` or the `elastic` service, use the Chat completion inference API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-unified-inference

func (*MethodInference) Completion ¶ added in v9.1.0 

func (p *MethodInference) Completion(inferenceid string) *inference_completion.Completion

Perform completion inference on the service https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference

func (*MethodInference) Delete ¶ added in v9.1.0 

func (p *MethodInference) Delete(inferenceid string) *inference_delete.Delete

Delete an inference endpoint https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-delete

func (*MethodInference) Get ¶ added in v9.1.0 

func (p *MethodInference) Get() *inference_get.Get

Get an inference endpoint https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-get

func (*MethodInference) Inference ¶ added in v9.1.0 

func (p *MethodInference) Inference(inferenceid string) *inference_inference.Inference

Perform inference on the service.

This API enables you to use machine learning models to perform specific tasks on data that you provide as an input. It returns a response with the results of the tasks. The inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.

For details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation.

> info > The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference

func (*MethodInference) Put ¶ added in v9.1.0 

func (p *MethodInference) Put(inferenceid string) *inference_put.Put

Create an inference endpoint.

IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.

The following integrations are available through the inference API. You can find the available task types next to the integration name: * AlibabaCloud AI Search (`completion`, `rerank`, `sparse_embedding`, `text_embedding`) * Amazon Bedrock (`completion`, `text_embedding`) * Amazon SageMaker (`chat_completion`, `completion`, `rerank`, `sparse_embedding`, `text_embedding`) * Anthropic (`completion`) * Azure AI Studio (`completion`, `text_embedding`) * Azure OpenAI (`completion`, `text_embedding`) * Cohere (`completion`, `rerank`, `text_embedding`) * DeepSeek (`completion`, `chat_completion`) * Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland) * ELSER (`sparse_embedding`) * Google AI Studio (`completion`, `text_embedding`) * Google Vertex AI (`rerank`, `text_embedding`) * Hugging Face (`chat_completion`, `completion`, `rerank`, `text_embedding`) * Mistral (`chat_completion`, `completion`, `text_embedding`) * OpenAI (`chat_completion`, `completion`, `text_embedding`) * VoyageAI (`text_embedding`, `rerank`) * Watsonx inference integration (`text_embedding`) * JinaAI (`text_embedding`, `rerank`) https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put

func (*MethodInference) PutAlibabacloud ¶ added in v9.1.0 

func (p *MethodInference) PutAlibabacloud(tasktype, alibabacloudinferenceid string) *inference_put_alibabacloud.PutAlibabacloud

Create an AlibabaCloud AI Search inference endpoint.

Create an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-alibabacloud

func (*MethodInference) PutAmazonbedrock ¶ added in v9.1.0 

func (p *MethodInference) PutAmazonbedrock(tasktype, amazonbedrockinferenceid string) *inference_put_amazonbedrock.PutAmazonbedrock

Create an Amazon Bedrock inference endpoint.

Create an inference endpoint to perform an inference task with the `amazonbedrock` service.

>info > You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-amazonbedrock

func (*MethodInference) PutAmazonsagemaker ¶ added in v9.1.0 

func (p *MethodInference) PutAmazonsagemaker(tasktype, amazonsagemakerinferenceid string) *inference_put_amazonsagemaker.PutAmazonsagemaker

Create an Amazon SageMaker inference endpoint.

Create an inference endpoint to perform an inference task with the `amazon_sagemaker` service. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-amazonsagemaker

func (*MethodInference) PutAnthropic ¶ added in v9.1.0 

func (p *MethodInference) PutAnthropic(tasktype, anthropicinferenceid string) *inference_put_anthropic.PutAnthropic

Create an Anthropic inference endpoint.

Create an inference endpoint to perform an inference task with the `anthropic` service. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-anthropic

func (*MethodInference) PutAzureaistudio ¶ added in v9.1.0 

func (p *MethodInference) PutAzureaistudio(tasktype, azureaistudioinferenceid string) *inference_put_azureaistudio.PutAzureaistudio

Create an Azure AI studio inference endpoint.

Create an inference endpoint to perform an inference task with the `azureaistudio` service. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-azureaistudio

func (*MethodInference) PutAzureopenai ¶ added in v9.1.0 

func (p *MethodInference) PutAzureopenai(tasktype, azureopenaiinferenceid string) *inference_put_azureopenai.PutAzureopenai

Create an Azure OpenAI inference endpoint.

Create an inference endpoint to perform an inference task with the `azureopenai` service.

The list of chat completion models that you can choose from in your Azure OpenAI deployment include:

* [GPT-4 and GPT-4 Turbo models](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-4-and-gpt-4-turbo-models) * [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35)

The list of embeddings models that you can choose from in your deployment can be found in the [Azure models documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings). https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-azureopenai

func (*MethodInference) PutCohere ¶ added in v9.1.0 

func (p *MethodInference) PutCohere(tasktype, cohereinferenceid string) *inference_put_cohere.PutCohere

Create a Cohere inference endpoint.

Create an inference endpoint to perform an inference task with the `cohere` service. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-cohere

func (*MethodInference) PutCustom ¶ added in v9.1.0 

func (p *MethodInference) PutCustom(tasktype, custominferenceid string) *inference_put_custom.PutCustom

Create a custom inference endpoint.

The custom service gives more control over how to interact with external inference services that aren't explicitly supported through dedicated integrations. The custom service gives you the ability to define the headers, url, query parameters, request body, and secrets. The custom service supports the template replacement functionality, which enables you to define a template that can be replaced with the value associated with that key. Templates are portions of a string that start with `${` and end with `}`. The parameters `secret_parameters` and `task_settings` are checked for keys for template replacement. Template replacement is supported in the `request`, `headers`, `url`, and `query_parameters`. If the definition (key) is not found for a template, an error message is returned. In case of an endpoint definition like the following: ``` PUT _inference/text_embedding/test-text-embedding 

{
  "service": "custom",
  "service_settings": {
     "secret_parameters": {
          "api_key": "<some api key>"
     },
     "url": "...endpoints.huggingface.cloud/v1/embeddings",
     "headers": {
         "Authorization": "Bearer ${api_key}",
         "Content-Type": "application/json"
     },
     "request": "{\"input\": ${input}}",
     "response": {
         "json_parser": {
             "text_embeddings":"$.data[*].embedding[*]"
         }
     }
  }
}

``` To replace `${api_key}` the `secret_parameters` and `task_settings` are checked for a key named `api_key`.

> info > Templates should not be surrounded by quotes.

Pre-defined templates: * `${input}` refers to the array of input strings that comes from the `input` field of the subsequent inference requests. * `${input_type}` refers to the input type translation values. * `${query}` refers to the query field used specifically for reranking tasks. * `${top_n}` refers to the `top_n` field available when performing rerank requests. * `${return_documents}` refers to the `return_documents` field available when performing rerank requests. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-custom

func (*MethodInference) PutDeepseek ¶ added in v9.1.0 

func (p *MethodInference) PutDeepseek(tasktype, deepseekinferenceid string) *inference_put_deepseek.PutDeepseek

Create a DeepSeek inference endpoint.

Create an inference endpoint to perform an inference task with the `deepseek` service. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-deepseek

func (*MethodInference) PutElasticsearch ¶ added in v9.1.0 

func (p *MethodInference) PutElasticsearch(tasktype, elasticsearchinferenceid string) *inference_put_elasticsearch.PutElasticsearch

Create an Elasticsearch inference endpoint.

Create an inference endpoint to perform an inference task with the `elasticsearch` service.

> info > Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings.

If you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet.

> info > You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.

After creating the endpoint, wait for the model deployment to complete before using it. To verify the deployment status, use the get trained model statistics API. Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-elasticsearch

func (*MethodInference) PutElser ¶ added in v9.1.0 

func (p *MethodInference) PutElser(tasktype, elserinferenceid string) *inference_put_elser.PutElser

Create an ELSER inference endpoint.

Create an inference endpoint to perform an inference task with the `elser` service. You can also deploy ELSER by using the Elasticsearch inference integration.

> info > Your Elasticsearch deployment contains a preconfigured ELSER inference endpoint, you only need to create the enpoint using the API if you want to customize the settings.

The API request will automatically download and deploy the ELSER model if it isn't already downloaded.

> info > You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value.

After creating the endpoint, wait for the model deployment to complete before using it. To verify the deployment status, use the get trained model statistics API. Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-elser

func (*MethodInference) PutGoogleaistudio ¶ added in v9.1.0 

func (p *MethodInference) PutGoogleaistudio(tasktype, googleaistudioinferenceid string) *inference_put_googleaistudio.PutGoogleaistudio

Create an Google AI Studio inference endpoint.

Create an inference endpoint to perform an inference task with the `googleaistudio` service. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-googleaistudio

func (*MethodInference) PutGooglevertexai ¶ added in v9.1.0 

func (p *MethodInference) PutGooglevertexai(tasktype, googlevertexaiinferenceid string) *inference_put_googlevertexai.PutGooglevertexai

Create a Google Vertex AI inference endpoint.

Create an inference endpoint to perform an inference task with the `googlevertexai` service. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-googlevertexai

func (*MethodInference) PutHuggingFace ¶ added in v9.1.0 

func (p *MethodInference) PutHuggingFace(tasktype, huggingfaceinferenceid string) *inference_put_hugging_face.PutHuggingFace

Create a Hugging Face inference endpoint.

Create an inference endpoint to perform an inference task with the `hugging_face` service. Supported tasks include: `text_embedding`, `completion`, and `chat_completion`.

To configure the endpoint, first visit the Hugging Face Inference Endpoints page and create a new endpoint. Select a model that supports the task you intend to use.

For Elastic's `text_embedding` task: The selected model must support the `Sentence Embeddings` task. On the new endpoint creation page, select the `Sentence Embeddings` task under the `Advanced Configuration` section. After the endpoint has initialized, copy the generated endpoint URL. Recommended models for `text_embedding` task:

* `all-MiniLM-L6-v2` * `all-MiniLM-L12-v2` * `all-mpnet-base-v2` * `e5-base-v2` * `e5-small-v2` * `multilingual-e5-base` * `multilingual-e5-small`

For Elastic's `chat_completion` and `completion` tasks: The selected model must support the `Text Generation` task and expose OpenAI API. HuggingFace supports both serverless and dedicated endpoints for `Text Generation`. When creating dedicated endpoint select the `Text Generation` task. After the endpoint is initialized (for dedicated) or ready (for serverless), ensure it supports the OpenAI API and includes `/v1/chat/completions` part in URL. Then, copy the full endpoint URL for use. Recommended models for `chat_completion` and `completion` tasks:

* `Mistral-7B-Instruct-v0.2` * `QwQ-32B` * `Phi-3-mini-128k-instruct`

For Elastic's `rerank` task: The selected model must support the `sentence-ranking` task and expose OpenAI API. HuggingFace supports only dedicated (not serverless) endpoints for `Rerank` so far. After the endpoint is initialized, copy the full endpoint URL for use. Tested models for `rerank` task:

* `bge-reranker-base` * `jina-reranker-v1-turbo-en-GGUF` https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-hugging-face

func (*MethodInference) PutJinaai ¶ added in v9.1.0 

func (p *MethodInference) PutJinaai(tasktype, jinaaiinferenceid string) *inference_put_jinaai.PutJinaai

Create an JinaAI inference endpoint.

Create an inference endpoint to perform an inference task with the `jinaai` service.

To review the available `rerank` models, refer to <https://jina.ai/reranker>. To review the available `text_embedding` models, refer to the <https://jina.ai/embeddings/>. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-jinaai

func (*MethodInference) PutMistral ¶ added in v9.1.0 

func (p *MethodInference) PutMistral(tasktype, mistralinferenceid string) *inference_put_mistral.PutMistral

Create a Mistral inference endpoint.

Create an inference endpoint to perform an inference task with the `mistral` service. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-mistral

func (*MethodInference) PutOpenai ¶ added in v9.1.0 

func (p *MethodInference) PutOpenai(tasktype, openaiinferenceid string) *inference_put_openai.PutOpenai

Create an OpenAI inference endpoint.

Create an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-openai

func (*MethodInference) PutVoyageai ¶ added in v9.1.0 

func (p *MethodInference) PutVoyageai(tasktype, voyageaiinferenceid string) *inference_put_voyageai.PutVoyageai

Create a VoyageAI inference endpoint.

Create an inference endpoint to perform an inference task with the `voyageai` service.

Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-voyageai

func (*MethodInference) PutWatsonx ¶ added in v9.1.0 

func (p *MethodInference) PutWatsonx(tasktype, watsonxinferenceid string) *inference_put_watsonx.PutWatsonx

Create a Watsonx inference endpoint.

Create an inference endpoint to perform an inference task with the `watsonxai` service. You need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service. You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-watsonx

func (*MethodInference) Rerank ¶ added in v9.1.0 

func (p *MethodInference) Rerank(inferenceid string) *inference_rerank.Rerank

Perform reranking inference on the service https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference

func (*MethodInference) SparseEmbedding ¶ added in v9.1.0 

func (p *MethodInference) SparseEmbedding(inferenceid string) *inference_sparse_embedding.SparseEmbedding

Perform sparse embedding inference on the service https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference

func (*MethodInference) StreamCompletion ¶ added in v9.1.0 

func (p *MethodInference) StreamCompletion(inferenceid string) *inference_stream_completion.StreamCompletion

Perform streaming inference. Get real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation. This API works only with the completion task type.

IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.

This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-stream-inference

func (*MethodInference) TextEmbedding ¶ added in v9.1.0 

func (p *MethodInference) TextEmbedding(inferenceid string) *inference_text_embedding.TextEmbedding

Perform text embedding inference on the service https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-inference

func (*MethodInference) Update ¶ added in v9.1.0 

func (p *MethodInference) Update(inferenceid string) *inference_update.Update

Update an inference endpoint.

Modify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`.

IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-update

type MethodIngest ¶ added in v9.1.0 

type MethodIngest struct {
	// contains filtered or unexported fields
}

func (*MethodIngest) DeleteGeoipDatabase ¶ added in v9.1.0 

func (p *MethodIngest) DeleteGeoipDatabase(id string) *ingest_delete_geoip_database.DeleteGeoipDatabase

Delete GeoIP database configurations.

Delete one or more IP geolocation database configurations. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-geoip-database

func (*MethodIngest) DeleteIpLocationDatabase ¶ added in v9.1.0 

func (p *MethodIngest) DeleteIpLocationDatabase(id string) *ingest_delete_ip_location_database.DeleteIpLocationDatabase

Delete IP geolocation database configurations. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-ip-location-database

func (*MethodIngest) DeletePipeline ¶ added in v9.1.0 

func (p *MethodIngest) DeletePipeline(id string) *ingest_delete_pipeline.DeletePipeline

Delete pipelines. Delete one or more ingest pipelines. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-delete-pipeline

func (*MethodIngest) GeoIpStats ¶ added in v9.1.0 

func (p *MethodIngest) GeoIpStats() *ingest_geo_ip_stats.GeoIpStats

Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor. https://www.elastic.co/docs/reference/enrich-processor/geoip-processor

func (*MethodIngest) GetGeoipDatabase ¶ added in v9.1.0 

func (p *MethodIngest) GetGeoipDatabase() *ingest_get_geoip_database.GetGeoipDatabase

Get GeoIP database configurations.

Get information about one or more IP geolocation database configurations. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-geoip-database

func (*MethodIngest) GetIpLocationDatabase ¶ added in v9.1.0 

func (p *MethodIngest) GetIpLocationDatabase() *ingest_get_ip_location_database.GetIpLocationDatabase

Get IP geolocation database configurations. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-ip-location-database

func (*MethodIngest) GetPipeline ¶ added in v9.1.0 

func (p *MethodIngest) GetPipeline() *ingest_get_pipeline.GetPipeline

Get pipelines.

Get information about one or more ingest pipelines. This API returns a local reference of the pipeline. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-get-pipeline

func (*MethodIngest) ProcessorGrok ¶ added in v9.1.0 

func (p *MethodIngest) ProcessorGrok() *ingest_processor_grok.ProcessorGrok

Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused. https://www.elastic.co/docs/reference/enrich-processor/grok-processor

func (*MethodIngest) PutGeoipDatabase ¶ added in v9.1.0 

func (p *MethodIngest) PutGeoipDatabase(id string) *ingest_put_geoip_database.PutGeoipDatabase

Create or update a GeoIP database configuration.

Refer to the create or update IP geolocation database configuration API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-geoip-database

func (*MethodIngest) PutIpLocationDatabase ¶ added in v9.1.0 

func (p *MethodIngest) PutIpLocationDatabase(id string) *ingest_put_ip_location_database.PutIpLocationDatabase

Create or update an IP geolocation database configuration. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-put-ip-location-database

func (*MethodIngest) PutPipeline ¶ added in v9.1.0 

func (p *MethodIngest) PutPipeline(id string) *ingest_put_pipeline.PutPipeline

Create or update a pipeline. Changes made using this API take effect immediately. https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines

func (*MethodIngest) Simulate ¶ added in v9.1.0 

func (p *MethodIngest) Simulate() *ingest_simulate.Simulate

Simulate a pipeline.

Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ingest-simulate

type MethodLicense ¶ added in v9.1.0 

type MethodLicense struct {
	// contains filtered or unexported fields
}

func (*MethodLicense) Delete ¶ added in v9.1.0 

func (p *MethodLicense) Delete() *license_delete.Delete

Delete the license.

When the license expires, your subscription level reverts to Basic.

If the operator privileges feature is enabled, only operator users can use this API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-delete

func (*MethodLicense) Get ¶ added in v9.1.0 

func (p *MethodLicense) Get() *license_get.Get

Get license information.

Get information about your Elastic license including its type, its status, when it was issued, and when it expires.

>info > If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response. > If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get

func (*MethodLicense) GetBasicStatus ¶ added in v9.1.0 

func (p *MethodLicense) GetBasicStatus() *license_get_basic_status.GetBasicStatus

Get the basic license status. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-basic-status

func (*MethodLicense) GetTrialStatus ¶ added in v9.1.0 

func (p *MethodLicense) GetTrialStatus() *license_get_trial_status.GetTrialStatus

Get the trial status. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-get-trial-status

func (*MethodLicense) Post ¶ added in v9.1.0 

func (p *MethodLicense) Post() *license_post.Post

Update the license.

You can update your license at runtime without shutting down your nodes. License updates take effect immediately. If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.

NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. If the operator privileges feature is enabled, only operator users can use this API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post

func (*MethodLicense) PostStartBasic ¶ added in v9.1.0 

func (p *MethodLicense) PostStartBasic() *license_post_start_basic.PostStartBasic

Start a basic license.

Start an indefinite basic license, which gives access to all the basic features.

NOTE: In order to start a basic license, you must not currently have a basic license.

If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the `acknowledge` parameter set to `true`.

To check the status of your basic license, use the get basic license API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-basic

func (*MethodLicense) PostStartTrial ¶ added in v9.1.0 

func (p *MethodLicense) PostStartTrial() *license_post_start_trial.PostStartTrial

Start a trial. Start a 30-day trial, which gives access to all subscription features.

NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.

To check the status of your trial, use the get trial status API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-license-post-start-trial

type MethodLogstash ¶ added in v9.1.0 

type MethodLogstash struct {
	// contains filtered or unexported fields
}

func (*MethodLogstash) DeletePipeline ¶ added in v9.1.0 

func (p *MethodLogstash) DeletePipeline(id string) *logstash_delete_pipeline.DeletePipeline

Delete a Logstash pipeline. Delete a pipeline that is used for Logstash Central Management. If the request succeeds, you receive an empty response with an appropriate status code. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-delete-pipeline

func (*MethodLogstash) GetPipeline ¶ added in v9.1.0 

func (p *MethodLogstash) GetPipeline() *logstash_get_pipeline.GetPipeline

Get Logstash pipelines. Get pipelines that are used for Logstash Central Management. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-get-pipeline

func (*MethodLogstash) PutPipeline ¶ added in v9.1.0 

func (p *MethodLogstash) PutPipeline(id string) *logstash_put_pipeline.PutPipeline

Create or update a Logstash pipeline.

Create a pipeline that is used for Logstash Central Management. If the specified pipeline exists, it is replaced. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-put-pipeline

type MethodMigration ¶ added in v9.1.0 

type MethodMigration struct {
	// contains filtered or unexported fields
}

func (*MethodMigration) Deprecations ¶ added in v9.1.0 

func (p *MethodMigration) Deprecations() *migration_deprecations.Deprecations

Get deprecation information. Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.

TIP: This APIs is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-deprecations

func (*MethodMigration) GetFeatureUpgradeStatus ¶ added in v9.1.0 

func (p *MethodMigration) GetFeatureUpgradeStatus() *migration_get_feature_upgrade_status.GetFeatureUpgradeStatus

Get feature migration information. Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress.

TIP: This API is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status

func (*MethodMigration) PostFeatureUpgrade ¶ added in v9.1.0 

func (p *MethodMigration) PostFeatureUpgrade() *migration_post_feature_upgrade.PostFeatureUpgrade

Start the feature migration. Version upgrades sometimes require changes to how features store configuration information and data in system indices. This API starts the automatic migration process.

Some functionality might be temporarily unavailable during the migration process.

TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-get-feature-upgrade-status

type MethodMl ¶ added in v9.1.0 

type MethodMl struct {
	// contains filtered or unexported fields
}

func (*MethodMl) ClearTrainedModelDeploymentCache ¶ added in v9.1.0 

func (p *MethodMl) ClearTrainedModelDeploymentCache(modelid string) *ml_clear_trained_model_deployment_cache.ClearTrainedModelDeploymentCache

Clear trained model deployment cache.

Cache will be cleared on all nodes where the trained model is assigned. A trained model deployment may have an inference cache enabled. As requests are handled by each allocated node, their responses may be cached on that individual node. Calling this API clears the caches without restarting the deployment. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-clear-trained-model-deployment-cache

func (*MethodMl) CloseJob ¶ added in v9.1.0 

func (p *MethodMl) CloseJob(jobid string) *ml_close_job.CloseJob

Close anomaly detection jobs.

A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-close-job

func (*MethodMl) DeleteCalendar ¶ added in v9.1.0 

func (p *MethodMl) DeleteCalendar(calendarid string) *ml_delete_calendar.DeleteCalendar

Delete a calendar.

Remove all scheduled events from a calendar, then delete it. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar

func (*MethodMl) DeleteCalendarEvent ¶ added in v9.1.0 

func (p *MethodMl) DeleteCalendarEvent(calendarid, eventid string) *ml_delete_calendar_event.DeleteCalendarEvent

Delete events from a calendar. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-event

func (*MethodMl) DeleteCalendarJob ¶ added in v9.1.0 

func (p *MethodMl) DeleteCalendarJob(calendarid, jobid string) *ml_delete_calendar_job.DeleteCalendarJob

Delete anomaly jobs from a calendar. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-job

func (*MethodMl) DeleteDataFrameAnalytics ¶ added in v9.1.0 

func (p *MethodMl) DeleteDataFrameAnalytics(id string) *ml_delete_data_frame_analytics.DeleteDataFrameAnalytics

Delete a data frame analytics job. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-data-frame-analytics

func (*MethodMl) DeleteDatafeed ¶ added in v9.1.0 

func (p *MethodMl) DeleteDatafeed(datafeedid string) *ml_delete_datafeed.DeleteDatafeed

Delete a datafeed. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-datafeed

func (*MethodMl) DeleteExpiredData ¶ added in v9.1.0 

func (p *MethodMl) DeleteExpiredData() *ml_delete_expired_data.DeleteExpiredData

Delete expired ML data.

Delete all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting the `<job_id>`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-expired-data

func (*MethodMl) DeleteFilter ¶ added in v9.1.0 

func (p *MethodMl) DeleteFilter(filterid string) *ml_delete_filter.DeleteFilter

Delete a filter.

If an anomaly detection job references the filter, you cannot delete the filter. You must update or delete the job before you can delete the filter. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-filter

func (*MethodMl) DeleteForecast ¶ added in v9.1.0 

func (p *MethodMl) DeleteForecast(jobid string) *ml_delete_forecast.DeleteForecast

Delete forecasts from a job.

By default, forecasts are retained for 14 days. You can specify a different retention period with the `expires_in` parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-forecast

func (*MethodMl) DeleteJob ¶ added in v9.1.0 

func (p *MethodMl) DeleteJob(jobid string) *ml_delete_job.DeleteJob

Delete an anomaly detection job.

All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed. This behavior is equivalent to calling the delete datafeed API with the same timeout and force parameters as the delete job request. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-job

func (*MethodMl) DeleteModelSnapshot ¶ added in v9.1.0 

func (p *MethodMl) DeleteModelSnapshot(jobid, snapshotid string) *ml_delete_model_snapshot.DeleteModelSnapshot

Delete a model snapshot.

You cannot delete the active model snapshot. To delete that snapshot, first revert to a different one. To identify the active model snapshot, refer to the `model_snapshot_id` in the results from the get jobs API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-model-snapshot

func (*MethodMl) DeleteTrainedModel ¶ added in v9.1.0 

func (p *MethodMl) DeleteTrainedModel(modelid string) *ml_delete_trained_model.DeleteTrainedModel

Delete an unreferenced trained model.

The request deletes a trained inference model that is not referenced by an ingest pipeline. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model

func (*MethodMl) DeleteTrainedModelAlias ¶ added in v9.1.0 

func (p *MethodMl) DeleteTrainedModelAlias(modelid, modelalias string) *ml_delete_trained_model_alias.DeleteTrainedModelAlias

Delete a trained model alias.

This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model-alias

func (*MethodMl) EstimateModelMemory ¶ added in v9.1.0 

func (p *MethodMl) EstimateModelMemory() *ml_estimate_model_memory.EstimateModelMemory

Estimate job model memory usage.

Make an estimation of the memory usage for an anomaly detection job model. The estimate is based on analysis configuration details for the job and cardinality estimates for the fields it references. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-estimate-model-memory

func (*MethodMl) EvaluateDataFrame ¶ added in v9.1.0 

func (p *MethodMl) EvaluateDataFrame() *ml_evaluate_data_frame.EvaluateDataFrame

Evaluate data frame analytics.

The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-evaluate-data-frame

func (*MethodMl) ExplainDataFrameAnalytics ¶ added in v9.1.0 

func (p *MethodMl) ExplainDataFrameAnalytics() *ml_explain_data_frame_analytics.ExplainDataFrameAnalytics

Explain data frame analytics config.

This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: * which fields are included or not in the analysis and why, * how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-explain-data-frame-analytics

func (*MethodMl) FlushJob ¶ added in v9.1.0 

func (p *MethodMl) FlushJob(jobid string) *ml_flush_job.FlushJob

Force buffered data to be processed. The flush jobs API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results. Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-flush-job

func (*MethodMl) Forecast ¶ added in v9.1.0 

func (p *MethodMl) Forecast(jobid string) *ml_forecast.Forecast

Predict future behavior of a time series.

Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an `over_field_name` in its configuration. Forcasts predict future behavior based on historical data. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-forecast

func (*MethodMl) GetBuckets ¶ added in v9.1.0 

func (p *MethodMl) GetBuckets(jobid string) *ml_get_buckets.GetBuckets

Get anomaly detection job results for buckets. The API presents a chronological view of the records, grouped by bucket. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-buckets

func (*MethodMl) GetCalendarEvents ¶ added in v9.1.0 

func (p *MethodMl) GetCalendarEvents(calendarid string) *ml_get_calendar_events.GetCalendarEvents

Get info about events in calendars. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendar-events

func (*MethodMl) GetCalendars ¶ added in v9.1.0 

func (p *MethodMl) GetCalendars() *ml_get_calendars.GetCalendars

Get calendar configuration info. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendars

func (*MethodMl) GetCategories ¶ added in v9.1.0 

func (p *MethodMl) GetCategories(jobid string) *ml_get_categories.GetCategories

Get anomaly detection job results for categories. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-categories

func (*MethodMl) GetDataFrameAnalytics ¶ added in v9.1.0 

func (p *MethodMl) GetDataFrameAnalytics() *ml_get_data_frame_analytics.GetDataFrameAnalytics

Get data frame analytics job configuration info. You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics

func (*MethodMl) GetDataFrameAnalyticsStats ¶ added in v9.1.0 

func (p *MethodMl) GetDataFrameAnalyticsStats() *ml_get_data_frame_analytics_stats.GetDataFrameAnalyticsStats

Get data frame analytics job stats. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics-stats

func (*MethodMl) GetDatafeedStats ¶ added in v9.1.0 

func (p *MethodMl) GetDatafeedStats() *ml_get_datafeed_stats.GetDatafeedStats

Get datafeed stats. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeed-stats

func (*MethodMl) GetDatafeeds ¶ added in v9.1.0 

func (p *MethodMl) GetDatafeeds() *ml_get_datafeeds.GetDatafeeds

Get datafeeds configuration info. You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. This API returns a maximum of 10,000 datafeeds. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeeds

func (*MethodMl) GetFilters ¶ added in v9.1.0 

func (p *MethodMl) GetFilters() *ml_get_filters.GetFilters

Get filters. You can get a single filter or all filters. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-filters

func (*MethodMl) GetInfluencers ¶ added in v9.1.0 

func (p *MethodMl) GetInfluencers(jobid string) *ml_get_influencers.GetInfluencers

Get anomaly detection job results for influencers. Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an `influencer_field_name` is specified in the job configuration. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-influencers

func (*MethodMl) GetJobStats ¶ added in v9.1.0 

func (p *MethodMl) GetJobStats() *ml_get_job_stats.GetJobStats

Get anomaly detection job stats. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-job-stats

func (*MethodMl) GetJobs ¶ added in v9.1.0 

func (p *MethodMl) GetJobs() *ml_get_jobs.GetJobs

Get anomaly detection jobs configuration info. You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting the `<job_id>`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-jobs

func (*MethodMl) GetMemoryStats ¶ added in v9.1.0 

func (p *MethodMl) GetMemoryStats() *ml_get_memory_stats.GetMemoryStats

Get machine learning memory usage info. Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-memory-stats

func (*MethodMl) GetModelSnapshotUpgradeStats ¶ added in v9.1.0 

func (p *MethodMl) GetModelSnapshotUpgradeStats(jobid, snapshotid string) *ml_get_model_snapshot_upgrade_stats.GetModelSnapshotUpgradeStats

Get anomaly detection job model snapshot upgrade usage info. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshot-upgrade-stats

func (*MethodMl) GetModelSnapshots ¶ added in v9.1.0 

func (p *MethodMl) GetModelSnapshots(jobid string) *ml_get_model_snapshots.GetModelSnapshots

Get model snapshots info. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshots

func (*MethodMl) GetOverallBuckets ¶ added in v9.1.0 

func (p *MethodMl) GetOverallBuckets(jobid string) *ml_get_overall_buckets.GetOverallBuckets

Get overall bucket results.

Retrievs overall bucket results that summarize the bucket results of multiple anomaly detection jobs.

The `overall_score` is calculated by combining the scores of all the buckets within the overall bucket span. First, the maximum `anomaly_score` per anomaly detection job in the overall bucket is calculated. Then the `top_n` of those scores are averaged to result in the `overall_score`. This means that you can fine-tune the `overall_score` so that it is more or less sensitive to the number of jobs that detect an anomaly at the same time. For example, if you set `top_n` to `1`, the `overall_score` is the maximum bucket score in the overall bucket. Alternatively, if you set `top_n` to the number of jobs, the `overall_score` is high only when all jobs detect anomalies in that overall bucket. If you set the `bucket_span` parameter (to a value greater than its default), the `overall_score` is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-overall-buckets

func (*MethodMl) GetRecords ¶ added in v9.1.0 

func (p *MethodMl) GetRecords(jobid string) *ml_get_records.GetRecords

Get anomaly records for an anomaly detection job. Records contain the detailed analytical results. They describe the anomalous activity that has been identified in the input data based on the detector configuration. There can be many anomaly records depending on the characteristics and size of the input data. In practice, there are often too many to be able to manually process them. The machine learning features therefore perform a sophisticated aggregation of the anomaly records into buckets. The number of record results depends on the number of anomalies found in each bucket, which relates to the number of time series being modeled and the number of detectors. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-records

func (*MethodMl) GetTrainedModels ¶ added in v9.1.0 

func (p *MethodMl) GetTrainedModels() *ml_get_trained_models.GetTrainedModels

Get trained model configuration info. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models

func (*MethodMl) GetTrainedModelsStats ¶ added in v9.1.0 

func (p *MethodMl) GetTrainedModelsStats() *ml_get_trained_models_stats.GetTrainedModelsStats

Get trained models usage info. You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models-stats

func (*MethodMl) InferTrainedModel ¶ added in v9.1.0 

func (p *MethodMl) InferTrainedModel(modelid string) *ml_infer_trained_model.InferTrainedModel

Evaluate a trained model. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-infer-trained-model

func (*MethodMl) Info ¶ added in v9.1.0 

func (p *MethodMl) Info() *ml_info.Info

Get machine learning information. Get defaults and limits used by machine learning. This endpoint is designed to be used by a user interface that needs to fully understand machine learning configurations where some options are not specified, meaning that the defaults should be used. This endpoint may be used to find out what those defaults are. It also provides information about the maximum size of machine learning jobs that could run in the current cluster configuration. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-info

func (*MethodMl) OpenJob ¶ added in v9.1.0 

func (p *MethodMl) OpenJob(jobid string) *ml_open_job.OpenJob

Open anomaly detection jobs.

An anomaly detection job must be opened to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. When you open a new job, it starts with an empty model. When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-open-job

func (*MethodMl) PostCalendarEvents ¶ added in v9.1.0 

func (p *MethodMl) PostCalendarEvents(calendarid string) *ml_post_calendar_events.PostCalendarEvents

Add scheduled events to the calendar. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-calendar-events

func (*MethodMl) PostData ¶ added in v9.1.0 

func (p *MethodMl) PostData(jobid string) *ml_post_data.PostData

Send data to an anomaly detection job for analysis.

IMPORTANT: For each job, data can be accepted from only a single connection at a time. It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-data

func (*MethodMl) PreviewDataFrameAnalytics ¶ added in v9.1.0 

func (p *MethodMl) PreviewDataFrameAnalytics() *ml_preview_data_frame_analytics.PreviewDataFrameAnalytics

Preview features used by data frame analytics. Preview the extracted features used by a data frame analytics config. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-data-frame-analytics

func (*MethodMl) PreviewDatafeed ¶ added in v9.1.0 

func (p *MethodMl) PreviewDatafeed() *ml_preview_datafeed.PreviewDatafeed

Preview a datafeed. This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-datafeed

func (*MethodMl) PutCalendar ¶ added in v9.1.0 

func (p *MethodMl) PutCalendar(calendarid string) *ml_put_calendar.PutCalendar

Create a calendar. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar

func (*MethodMl) PutCalendarJob ¶ added in v9.1.0 

func (p *MethodMl) PutCalendarJob(calendarid, jobid string) *ml_put_calendar_job.PutCalendarJob

Add anomaly detection job to calendar. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar-job

func (*MethodMl) PutDataFrameAnalytics ¶ added in v9.1.0 

func (p *MethodMl) PutDataFrameAnalytics(id string) *ml_put_data_frame_analytics.PutDataFrameAnalytics

Create a data frame analytics job. This API creates a data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index. By default, the query used in the source configuration is `{"match_all": {}}`.

If the destination index does not exist, it is created automatically when you start the job.

If you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics

func (*MethodMl) PutDatafeed ¶ added in v9.1.0 

func (p *MethodMl) PutDatafeed(datafeedid string) *ml_put_datafeed.PutDatafeed

Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay') at each interval. By default, the datafeed uses the following query: `{"match_all": {"boost": 1}}`.

When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-datafeed

func (*MethodMl) PutFilter ¶ added in v9.1.0 

func (p *MethodMl) PutFilter(filterid string) *ml_put_filter.PutFilter

Create a filter. A filter contains a list of strings. It can be used by one or more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-filter

func (*MethodMl) PutJob ¶ added in v9.1.0 

func (p *MethodMl) PutJob(jobid string) *ml_put_job.PutJob

Create an anomaly detection job.

If you include a `datafeed_config`, you must have read index privileges on the source index. If you include a `datafeed_config` but do not provide a query, the datafeed uses `{"match_all": {"boost": 1}}`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-job

func (*MethodMl) PutTrainedModel ¶ added in v9.1.0 

func (p *MethodMl) PutTrainedModel(modelid string) *ml_put_trained_model.PutTrainedModel

Create a trained model. Enable you to supply a trained model that is not created by data frame analytics. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model

func (*MethodMl) PutTrainedModelAlias ¶ added in v9.1.0 

func (p *MethodMl) PutTrainedModelAlias(modelid, modelalias string) *ml_put_trained_model_alias.PutTrainedModelAlias

Create or update a trained model alias. A trained model alias is a logical name used to reference a single trained model. You can use aliases instead of trained model identifiers to make it easier to reference your models. For example, you can use aliases in inference aggregations and processors. An alias must be unique and refer to only a single trained model. However, you can have multiple aliases for each trained model. If you use this API to update an alias such that it references a different trained model ID and the model uses a different type of data frame analytics, an error occurs. For example, this situation occurs if you have a trained model for regression analysis and a trained model for classification analysis; you cannot reassign an alias from one type of trained model to another. If you use this API to update an alias and there are very few input fields in common between the old and new trained models for the model alias, the API returns a warning. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-alias

func (*MethodMl) PutTrainedModelDefinitionPart ¶ added in v9.1.0 

func (p *MethodMl) PutTrainedModelDefinitionPart(modelid, part string) *ml_put_trained_model_definition_part.PutTrainedModelDefinitionPart

Create part of a trained model definition. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-definition-part

func (*MethodMl) PutTrainedModelVocabulary ¶ added in v9.1.0 

func (p *MethodMl) PutTrainedModelVocabulary(modelid string) *ml_put_trained_model_vocabulary.PutTrainedModelVocabulary

Create a trained model vocabulary. This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-vocabulary

func (*MethodMl) ResetJob ¶ added in v9.1.0 

func (p *MethodMl) ResetJob(jobid string) *ml_reset_job.ResetJob

Reset an anomaly detection job. All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-reset-job

func (*MethodMl) RevertModelSnapshot ¶ added in v9.1.0 

func (p *MethodMl) RevertModelSnapshot(jobid, snapshotid string) *ml_revert_model_snapshot.RevertModelSnapshot

Revert to a snapshot. The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event. In the case where this anomalous input is known to be a one-off, then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-revert-model-snapshot

func (*MethodMl) SetUpgradeMode ¶ added in v9.1.0 

func (p *MethodMl) SetUpgradeMode() *ml_set_upgrade_mode.SetUpgradeMode

Set upgrade_mode for ML indices. Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your machine learning indices. In those circumstances, there must be no machine learning jobs running. You can close the machine learning jobs, do the upgrade, then open all the jobs again. Alternatively, you can use this API to temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening. You can also use this API during upgrades that do not require you to reindex your machine learning indices, though stopping jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-set-upgrade-mode

func (*MethodMl) StartDataFrameAnalytics ¶ added in v9.1.0 

func (p *MethodMl) StartDataFrameAnalytics(id string) *ml_start_data_frame_analytics.StartDataFrameAnalytics

Start a data frame analytics job. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. If the destination index does not exist, it is created automatically the first time you start the data frame analytics job. The `index.number_of_shards` and `index.number_of_replicas` settings for the destination index are copied from the source index. If there are multiple source indices, the destination index copies the highest setting values. The mappings for the destination index are also copied from the source indices. If there are any mapping conflicts, the job fails to start. If the destination index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-data-frame-analytics

func (*MethodMl) StartDatafeed ¶ added in v9.1.0 

func (p *MethodMl) StartDatafeed(datafeedid string) *ml_start_datafeed.StartDatafeed

Start datafeeds.

A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.

Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.

If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. If new data was indexed for that exact millisecond between stopping and starting, it will be ignored.

When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or update it had at the time of creation or update and runs the query using those same roles. If you provided secondary authorization headers when you created or updated the datafeed, those credentials are used instead. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-datafeed

func (*MethodMl) StartTrainedModelDeployment ¶ added in v9.1.0 

func (p *MethodMl) StartTrainedModelDeployment(modelid string) *ml_start_trained_model_deployment.StartTrainedModelDeployment

Start a trained model deployment. It allocates the model to every machine learning node. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-trained-model-deployment

func (*MethodMl) StopDataFrameAnalytics ¶ added in v9.1.0 

func (p *MethodMl) StopDataFrameAnalytics(id string) *ml_stop_data_frame_analytics.StopDataFrameAnalytics

Stop data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-data-frame-analytics

func (*MethodMl) StopDatafeed ¶ added in v9.1.0 

func (p *MethodMl) StopDatafeed(datafeedid string) *ml_stop_datafeed.StopDatafeed

Stop datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-datafeed

func (*MethodMl) StopTrainedModelDeployment ¶ added in v9.1.0 

func (p *MethodMl) StopTrainedModelDeployment(modelid string) *ml_stop_trained_model_deployment.StopTrainedModelDeployment

Stop a trained model deployment. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-trained-model-deployment

func (*MethodMl) UpdateDataFrameAnalytics ¶ added in v9.1.0 

func (p *MethodMl) UpdateDataFrameAnalytics(id string) *ml_update_data_frame_analytics.UpdateDataFrameAnalytics

Update a data frame analytics job. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics

func (*MethodMl) UpdateDatafeed ¶ added in v9.1.0 

func (p *MethodMl) UpdateDatafeed(datafeedid string) *ml_update_datafeed.UpdateDatafeed

Update a datafeed. You must stop and start the datafeed for the changes to be applied. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at the time of the update and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-datafeed

func (*MethodMl) UpdateFilter ¶ added in v9.1.0 

func (p *MethodMl) UpdateFilter(filterid string) *ml_update_filter.UpdateFilter

Update a filter. Updates the description of a filter, adds items, or removes items from the list. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-filter

func (*MethodMl) UpdateJob ¶ added in v9.1.0 

func (p *MethodMl) UpdateJob(jobid string) *ml_update_job.UpdateJob

Update an anomaly detection job. Updates certain properties of an anomaly detection job. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-job

func (*MethodMl) UpdateModelSnapshot ¶ added in v9.1.0 

func (p *MethodMl) UpdateModelSnapshot(jobid, snapshotid string) *ml_update_model_snapshot.UpdateModelSnapshot

Update a snapshot. Updates certain properties of a snapshot. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-model-snapshot

func (*MethodMl) UpdateTrainedModelDeployment ¶ added in v9.1.0 

func (p *MethodMl) UpdateTrainedModelDeployment(modelid string) *ml_update_trained_model_deployment.UpdateTrainedModelDeployment

Update a trained model deployment. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-trained-model-deployment

func (*MethodMl) UpgradeJobSnapshot ¶ added in v9.1.0 

func (p *MethodMl) UpgradeJobSnapshot(jobid, snapshotid string) *ml_upgrade_job_snapshot.UpgradeJobSnapshot

Upgrade a snapshot. Upgrade an anomaly detection model snapshot to the latest major version. Over time, older snapshot formats are deprecated and removed. Anomaly detection jobs support only snapshots that are from the current or previous major version. This API provides a means to upgrade a snapshot to the current major version. This aids in preparing the cluster for an upgrade to the next major version. Only one snapshot per anomaly detection job can be upgraded at a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-upgrade-job-snapshot

func (*MethodMl) Validate ¶ added in v9.1.0 

func (p *MethodMl) Validate() *ml_validate.Validate

Validate an anomaly detection job. https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html

func (*MethodMl) ValidateDetector ¶ added in v9.1.0 

func (p *MethodMl) ValidateDetector() *ml_validate_detector.ValidateDetector

Validate an anomaly detection job. https://www.elastic.co/docs/api/doc/elasticsearch

type MethodMonitoring ¶ added in v9.1.0 

type MethodMonitoring struct {
	// contains filtered or unexported fields
}

func (*MethodMonitoring) Bulk ¶ added in v9.1.0 

func (p *MethodMonitoring) Bulk() *monitoring_bulk.Bulk

Send monitoring data. This API is used by the monitoring features to send monitoring data. https://www.elastic.co/docs/api/doc/elasticsearch

type MethodNodes ¶ added in v9.1.0 

type MethodNodes struct {
	// contains filtered or unexported fields
}

func (*MethodNodes) ClearRepositoriesMeteringArchive ¶ added in v9.1.0 

func (p *MethodNodes) ClearRepositoriesMeteringArchive(nodeid, maxarchiveversion string) *nodes_clear_repositories_metering_archive.ClearRepositoriesMeteringArchive

Clear the archived repositories metering. Clear the archived repositories metering information in the cluster. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-clear-repositories-metering-archive

func (*MethodNodes) GetRepositoriesMeteringInfo ¶ added in v9.1.0 

func (p *MethodNodes) GetRepositoriesMeteringInfo(nodeid string) *nodes_get_repositories_metering_info.GetRepositoriesMeteringInfo

Get cluster repositories metering. Get repositories metering information for a cluster. This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-get-repositories-metering-info

func (*MethodNodes) HotThreads ¶ added in v9.1.0 

func (p *MethodNodes) HotThreads() *nodes_hot_threads.HotThreads

Get the hot threads for nodes. Get a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of the top hot threads for each node. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-hot-threads

func (*MethodNodes) Info ¶ added in v9.1.0 

func (p *MethodNodes) Info() *nodes_info.Info

Get node information.

By default, the API returns all attributes and core settings for cluster nodes. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-info

func (*MethodNodes) ReloadSecureSettings ¶ added in v9.1.0 

func (p *MethodNodes) ReloadSecureSettings() *nodes_reload_secure_settings.ReloadSecureSettings

Reload the keystore on nodes in the cluster.

Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. That is, you can change them on disk and reload them without restarting any nodes in the cluster. When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node.

When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-reload-secure-settings

func (*MethodNodes) Stats ¶ added in v9.1.0 

func (p *MethodNodes) Stats() *nodes_stats.Stats

Get node statistics. Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats

func (*MethodNodes) Usage ¶ added in v9.1.0 

func (p *MethodNodes) Usage() *nodes_usage.Usage

Get feature usage information. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-usage

type MethodProfiling ¶ added in v9.1.0 

type MethodProfiling struct {
	// contains filtered or unexported fields
}

func (*MethodProfiling) Flamegraph ¶ added in v9.1.0 

func (p *MethodProfiling) Flamegraph() *profiling_flamegraph.Flamegraph

Extracts a UI-optimized structure to render flamegraphs from Universal Profiling. https://www.elastic.co/guide/en/observability/current/universal-profiling.html

func (*MethodProfiling) Stacktraces ¶ added in v9.1.0 

func (p *MethodProfiling) Stacktraces() *profiling_stacktraces.Stacktraces

Extracts raw stacktrace information from Universal Profiling. https://www.elastic.co/guide/en/observability/current/universal-profiling.html

func (*MethodProfiling) Status ¶ added in v9.1.0 

func (p *MethodProfiling) Status() *profiling_status.Status

Returns basic information about the status of Universal Profiling. https://www.elastic.co/guide/en/observability/current/universal-profiling.html

func (*MethodProfiling) TopnFunctions ¶ added in v9.1.0 

func (p *MethodProfiling) TopnFunctions() *profiling_topn_functions.TopnFunctions

Extracts a list of topN functions from Universal Profiling. https://www.elastic.co/guide/en/observability/current/universal-profiling.html

type MethodQueryRules ¶ added in v9.1.0 

type MethodQueryRules struct {
	// contains filtered or unexported fields
}

func (*MethodQueryRules) DeleteRule ¶ added in v9.1.0 

func (p *MethodQueryRules) DeleteRule(rulesetid, ruleid string) *query_rules_delete_rule.DeleteRule

Delete a query rule. Delete a query rule within a query ruleset. This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-rule

func (*MethodQueryRules) DeleteRuleset ¶ added in v9.1.0 

func (p *MethodQueryRules) DeleteRuleset(rulesetid string) *query_rules_delete_ruleset.DeleteRuleset

Delete a query ruleset. Remove a query ruleset and its associated data. This is a destructive action that is not recoverable. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-delete-ruleset

func (*MethodQueryRules) GetRule ¶ added in v9.1.0 

func (p *MethodQueryRules) GetRule(rulesetid, ruleid string) *query_rules_get_rule.GetRule

Get a query rule. Get details about a query rule within a query ruleset. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-rule

func (*MethodQueryRules) GetRuleset ¶ added in v9.1.0 

func (p *MethodQueryRules) GetRuleset(rulesetid string) *query_rules_get_ruleset.GetRuleset

Get a query ruleset. Get details about a query ruleset. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-get-ruleset

func (*MethodQueryRules) ListRulesets ¶ added in v9.1.0 

func (p *MethodQueryRules) ListRulesets() *query_rules_list_rulesets.ListRulesets

Get all query rulesets. Get summarized information about the query rulesets. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-list-rulesets

func (*MethodQueryRules) PutRule ¶ added in v9.1.0 

func (p *MethodQueryRules) PutRule(rulesetid, ruleid string) *query_rules_put_rule.PutRule

Create or update a query rule. Create or update a query rule within a query ruleset.

IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-rule

func (*MethodQueryRules) PutRuleset ¶ added in v9.1.0 

func (p *MethodQueryRules) PutRuleset(rulesetid string) *query_rules_put_ruleset.PutRuleset

Create or update a query ruleset. There is a limit of 100 rules per ruleset. This limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting.

IMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule. It is advised to use one or the other in query rulesets, to avoid errors. Additionally, pinned queries have a maximum limit of 100 pinned hits. If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-put-ruleset

func (*MethodQueryRules) Test ¶ added in v9.1.0 

func (p *MethodQueryRules) Test(rulesetid string) *query_rules_test.Test

Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-query-rules-test

type MethodRollup ¶ added in v9.1.0 

type MethodRollup struct {
	// contains filtered or unexported fields
}

func (*MethodRollup) DeleteJob ¶ added in v9.1.0 

func (p *MethodRollup) DeleteJob(id string) *rollup_delete_job.DeleteJob

Delete a rollup job.

A job must be stopped before it can be deleted. If you attempt to delete a started job, an error occurs. Similarly, if you attempt to delete a nonexistent job, an exception occurs.

IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. The API does not delete any previously rolled up data. This is by design; a user may wish to roll up a static data set. Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). Thus the job can be deleted, leaving behind the rolled up data for analysis. If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:

``` POST my_rollup_index/_delete_by_query 

{
  "query": {
    "term": {
      "_rollup.id": "the_rollup_job_id"
    }
  }
}

``` https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-delete-job

func (*MethodRollup) GetJobs ¶ added in v9.1.0 

func (p *MethodRollup) GetJobs() *rollup_get_jobs.GetJobs

Get rollup job information. Get the configuration, stats, and status of rollup jobs.

NOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs. If a job was created, ran for a while, then was deleted, the API does not return any details about it. For details about a historical rollup job, the rollup capabilities API may be more useful. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-jobs

func (*MethodRollup) GetRollupCaps ¶ added in v9.1.0 

func (p *MethodRollup) GetRollupCaps() *rollup_get_rollup_caps.GetRollupCaps

Get the rollup job capabilities. Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.

This API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. Furthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration. This API enables you to inspect an index and determine:

1. Does this index have associated rollup data somewhere in the cluster? 2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live? https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-caps

func (*MethodRollup) GetRollupIndexCaps ¶ added in v9.1.0 

func (p *MethodRollup) GetRollupIndexCaps(index string) *rollup_get_rollup_index_caps.GetRollupIndexCaps

Get the rollup index capabilities. Get the rollup capabilities of all jobs inside of a rollup index. A single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:

* What jobs are stored in an index (or indices specified via a pattern)? * What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job? https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-get-rollup-index-caps

func (*MethodRollup) PutJob ¶ added in v9.1.0 

func (p *MethodRollup) PutJob(id string) *rollup_put_job.PutJob

Create a rollup job.

WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.

The rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.

There are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.

Jobs are created in a `STOPPED` state. You can start them with the start rollup jobs API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-put-job

func (*MethodRollup) RollupSearch ¶ added in v9.1.0 

func (p *MethodRollup) RollupSearch(index string) *rollup_rollup_search.RollupSearch

Search rolled-up data. The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data. It rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.

The request body supports a subset of features from the regular search API. The following functionality is not available:

`size`: Because rollups work on pre-aggregated data, no search hits can be returned and so size must be set to zero or omitted entirely. `highlighter`, `suggestors`, `post_filter`, `profile`, `explain`: These are similarly disallowed.

For more detailed examples of using the rollup search API, including querying rolled-up data only or combining rolled-up and live data, refer to the External documentation. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-rollup-search

func (*MethodRollup) StartJob ¶ added in v9.1.0 

func (p *MethodRollup) StartJob(id string) *rollup_start_job.StartJob

Start rollup jobs. If you try to start a job that does not exist, an exception occurs. If you try to start a job that is already started, nothing happens. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-start-job

func (*MethodRollup) StopJob ¶ added in v9.1.0 

func (p *MethodRollup) StopJob(id string) *rollup_stop_job.StopJob

Stop rollup jobs. If you try to stop a job that does not exist, an exception occurs. If you try to stop a job that is already stopped, nothing happens.

Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped. This is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example:

``` POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s ``` The parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed. If the specified time elapses without the job moving to STOPPED, a timeout exception occurs. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-rollup-stop-job

type MethodSearchApplication ¶ added in v9.1.0 

type MethodSearchApplication struct {
	// contains filtered or unexported fields
}

func (*MethodSearchApplication) Delete ¶ added in v9.1.0 

func (p *MethodSearchApplication) Delete(name string) *search_application_delete.Delete

Delete a search application.

Remove a search application and its associated alias. Indices attached to the search application are not removed. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete

func (*MethodSearchApplication) DeleteBehavioralAnalytics ¶ added in v9.1.0 

func (p *MethodSearchApplication) DeleteBehavioralAnalytics(name string) *search_application_delete_behavioral_analytics.DeleteBehavioralAnalytics

Delete a behavioral analytics collection. The associated data stream is also deleted. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-delete-behavioral-analytics

func (*MethodSearchApplication) Get ¶ added in v9.1.0 

func (p *MethodSearchApplication) Get(name string) *search_application_get.Get

Get search application details. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get

func (*MethodSearchApplication) GetBehavioralAnalytics ¶ added in v9.1.0 

func (p *MethodSearchApplication) GetBehavioralAnalytics() *search_application_get_behavioral_analytics.GetBehavioralAnalytics

Get behavioral analytics collections. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics

func (*MethodSearchApplication) List ¶ added in v9.1.0 

func (p *MethodSearchApplication) List() *search_application_list.List

Get search applications. Get information about search applications. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-get-behavioral-analytics

func (*MethodSearchApplication) PostBehavioralAnalyticsEvent ¶ added in v9.1.0 

func (p *MethodSearchApplication) PostBehavioralAnalyticsEvent(collectionname, eventtype string) *search_application_post_behavioral_analytics_event.PostBehavioralAnalyticsEvent

Create a behavioral analytics collection event. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-post-behavioral-analytics-event

func (*MethodSearchApplication) Put ¶ added in v9.1.0 

func (p *MethodSearchApplication) Put(name string) *search_application_put.Put

Create or update a search application. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put

func (*MethodSearchApplication) PutBehavioralAnalytics ¶ added in v9.1.0 

func (p *MethodSearchApplication) PutBehavioralAnalytics(name string) *search_application_put_behavioral_analytics.PutBehavioralAnalytics

Create a behavioral analytics collection. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-put-behavioral-analytics

func (*MethodSearchApplication) RenderQuery ¶ added in v9.1.0 

func (p *MethodSearchApplication) RenderQuery(name string) *search_application_render_query.RenderQuery

Render a search application query. Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified. If a parameter used in the search template is not specified in `params`, the parameter's default value will be used. The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API.

You must have `read` privileges on the backing alias of the search application. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-render-query

func (*MethodSearchApplication) Search ¶ added in v9.1.0 

func (p *MethodSearchApplication) Search(name string) *search_application_search.Search

Run a search application search. Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-application-search

type MethodSearchableSnapshots ¶ added in v9.1.0 

type MethodSearchableSnapshots struct {
	// contains filtered or unexported fields
}

func (*MethodSearchableSnapshots) CacheStats ¶ added in v9.1.0 

func (p *MethodSearchableSnapshots) CacheStats() *searchable_snapshots_cache_stats.CacheStats

Get cache statistics. Get statistics about the shared cache for partially mounted indices. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-cache-stats

func (*MethodSearchableSnapshots) ClearCache ¶ added in v9.1.0 

func (p *MethodSearchableSnapshots) ClearCache() *searchable_snapshots_clear_cache.ClearCache

Clear the cache. Clear indices and data streams from the shared cache for partially mounted indices. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-clear-cache

func (*MethodSearchableSnapshots) Mount ¶ added in v9.1.0 

func (p *MethodSearchableSnapshots) Mount(repository, snapshot string) *searchable_snapshots_mount.Mount

Mount a snapshot. Mount a snapshot as a searchable snapshot index. Do not use this API for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-mount

func (*MethodSearchableSnapshots) Stats ¶ added in v9.1.0 

func (p *MethodSearchableSnapshots) Stats() *searchable_snapshots_stats.Stats

Get searchable snapshot statistics. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-searchable-snapshots-stats

type MethodSecurity ¶ added in v9.1.0 

type MethodSecurity struct {
	// contains filtered or unexported fields
}

func (*MethodSecurity) ActivateUserProfile ¶ added in v9.1.0 

func (p *MethodSecurity) ActivateUserProfile() *security_activate_user_profile.ActivateUserProfile

Activate a user profile.

Create or update a user profile on behalf of another user.

NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. The calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for. Elastic reserves the right to change or remove this feature in future releases without prior notice.

This API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm. For example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.

When updating a profile document, the API enables the document if it was disabled. Any updates do not change existing content for either the `labels` or `data` fields. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-activate-user-profile

func (*MethodSecurity) Authenticate ¶ added in v9.1.0 

func (p *MethodSecurity) Authenticate() *security_authenticate.Authenticate

Authenticate a user.

Authenticates a user and returns information about the authenticated user. Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication). A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-authenticate

func (*MethodSecurity) BulkDeleteRole ¶ added in v9.1.0 

func (p *MethodSecurity) BulkDeleteRole() *security_bulk_delete_role.BulkDeleteRole

Bulk delete roles.

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk delete roles API cannot delete roles that are defined in roles files. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-delete-role

func (*MethodSecurity) BulkPutRole ¶ added in v9.1.0 

func (p *MethodSecurity) BulkPutRole() *security_bulk_put_role.BulkPutRole

Bulk create or update roles.

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-put-role

func (*MethodSecurity) BulkUpdateApiKeys ¶ added in v9.1.0 

func (p *MethodSecurity) BulkUpdateApiKeys() *security_bulk_update_api_keys.BulkUpdateApiKeys

Bulk update API keys. Update the attributes for multiple API keys.

IMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.

This API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.

It is not possible to update expired or invalidated API keys.

This API supports updates to API key access scope, metadata and expiration. The access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request. The snapshot of the owner's permissions is updated automatically on every call.

IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.

A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-bulk-update-api-keys

func (*MethodSecurity) ChangePassword ¶ added in v9.1.0 

func (p *MethodSecurity) ChangePassword() *security_change_password.ChangePassword

Change passwords.

Change the passwords of users in the native realm and built-in users. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-change-password

func (*MethodSecurity) ClearApiKeyCache ¶ added in v9.1.0 

func (p *MethodSecurity) ClearApiKeyCache(ids string) *security_clear_api_key_cache.ClearApiKeyCache

Clear the API key cache.

Evict a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-api-key-cache

func (*MethodSecurity) ClearCachedPrivileges ¶ added in v9.1.0 

func (p *MethodSecurity) ClearCachedPrivileges(application string) *security_clear_cached_privileges.ClearCachedPrivileges

Clear the privileges cache.

Evict privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-privileges

func (*MethodSecurity) ClearCachedRealms ¶ added in v9.1.0 

func (p *MethodSecurity) ClearCachedRealms(realms string) *security_clear_cached_realms.ClearCachedRealms

Clear the user cache.

Evict users from the user cache. You can completely clear the cache or evict specific users.

User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request. There are realm settings that you can use to configure the user cache. For more information, refer to the documentation about controlling the user cache. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-realms

func (*MethodSecurity) ClearCachedRoles ¶ added in v9.1.0 

func (p *MethodSecurity) ClearCachedRoles(name string) *security_clear_cached_roles.ClearCachedRoles

Clear the roles cache.

Evict roles from the native role cache. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-roles

func (*MethodSecurity) ClearCachedServiceTokens ¶ added in v9.1.0 

func (p *MethodSecurity) ClearCachedServiceTokens(namespace, service, name string) *security_clear_cached_service_tokens.ClearCachedServiceTokens

Clear service account token caches.

Evict a subset of all entries from the service account token caches. Two separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index. This API clears matching entries from both caches.

The cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index. The cache for tokens backed by the `service_tokens` file is cleared automatically on file changes. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-service-tokens

func (*MethodSecurity) CreateApiKey ¶ added in v9.1.0 

func (p *MethodSecurity) CreateApiKey() *security_create_api_key.CreateApiKey

Create an API key.

Create an API key for access without requiring basic authentication.

IMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges. If you specify privileges, the API returns an error.

A successful request returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds.

NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.

The API keys are created by the Elasticsearch API key service, which is automatically enabled. To configure or turn off the API key service, refer to API key service setting documentation. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key

func (*MethodSecurity) CreateCrossClusterApiKey ¶ added in v9.1.0 

func (p *MethodSecurity) CreateCrossClusterApiKey() *security_create_cross_cluster_api_key.CreateCrossClusterApiKey

Create a cross-cluster API key.

Create an API key of the `cross_cluster` type for the API key based remote cluster access. A `cross_cluster` API key cannot be used to authenticate through the REST interface.

IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.

Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.

NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property.

A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.

By default, API keys never expire. You can specify expiration information when you create the API keys.

Cross-cluster API keys can only be updated with the update cross-cluster API key API. Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key

func (*MethodSecurity) CreateServiceToken ¶ added in v9.1.0 

func (p *MethodSecurity) CreateServiceToken(namespace, service string) *security_create_service_token.CreateServiceToken

Create a service account token.

Create a service accounts token for access without requiring basic authentication.

NOTE: Service account tokens never expire. You must actively delete them if they are no longer needed. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-service-token

func (*MethodSecurity) DelegatePki ¶ added in v9.1.0 

func (p *MethodSecurity) DelegatePki() *security_delegate_pki.DelegatePki

Delegate PKI authentication.

This API implements the exchange of an X509Certificate chain for an Elasticsearch access token. The certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`. A successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm.

This API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-​as if the user connected directly to Elasticsearch.

IMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated. This is part of the TLS authentication process and it is delegated to the proxy that calls this API. The proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delegate-pki

func (*MethodSecurity) DeletePrivileges ¶ added in v9.1.0 

func (p *MethodSecurity) DeletePrivileges(application, name string) *security_delete_privileges.DeletePrivileges

Delete application privileges.

To use this API, you must have one of the following privileges:

* The `manage_security` cluster privilege (or a greater privilege such as `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-privileges

func (*MethodSecurity) DeleteRole ¶ added in v9.1.0 

func (p *MethodSecurity) DeleteRole(name string) *security_delete_role.DeleteRole

Delete roles.

Delete roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The delete roles API cannot remove roles that are defined in roles files. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role

func (*MethodSecurity) DeleteRoleMapping ¶ added in v9.1.0 

func (p *MethodSecurity) DeleteRoleMapping(name string) *security_delete_role_mapping.DeleteRoleMapping

Delete role mappings.

Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The delete role mappings API cannot remove role mappings that are defined in role mapping files. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-role-mapping

func (*MethodSecurity) DeleteServiceToken ¶ added in v9.1.0 

func (p *MethodSecurity) DeleteServiceToken(namespace, service, name string) *security_delete_service_token.DeleteServiceToken

Delete service account tokens.

Delete service account tokens for a service in a specified namespace. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-service-token

func (*MethodSecurity) DeleteUser ¶ added in v9.1.0 

func (p *MethodSecurity) DeleteUser(username string) *security_delete_user.DeleteUser

Delete users.

Delete users from the native realm. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-delete-user

func (*MethodSecurity) DisableUser ¶ added in v9.1.0 

func (p *MethodSecurity) DisableUser(username string) *security_disable_user.DisableUser

Disable users.

Disable users in the native realm. By default, when you create users, they are enabled. You can use this API to revoke a user's access to Elasticsearch. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-disable-user

func (*MethodSecurity) DisableUserProfile ¶ added in v9.1.0 

func (p *MethodSecurity) DisableUserProfile(uid string) *security_disable_user_profile.DisableUserProfile

Disable a user profile.

Disable user profiles so that they are not visible in user profile searches.

NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice.

When you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches. To re-enable a disabled user profile, use the enable user profile API . https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-disable-user-profile

func (*MethodSecurity) EnableUser ¶ added in v9.1.0 

func (p *MethodSecurity) EnableUser(username string) *security_enable_user.EnableUser

Enable users.

Enable users in the native realm. By default, when you create users, they are enabled. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enable-user

func (*MethodSecurity) EnableUserProfile ¶ added in v9.1.0 

func (p *MethodSecurity) EnableUserProfile(uid string) *security_enable_user_profile.EnableUserProfile

Enable a user profile.

Enable user profiles to make them visible in user profile searches.

NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice.

When you activate a user profile, it's automatically enabled and visible in user profile searches. If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enable-user-profile

func (*MethodSecurity) EnrollKibana ¶ added in v9.1.0 

func (p *MethodSecurity) EnrollKibana() *security_enroll_kibana.EnrollKibana

Enroll Kibana.

Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.

NOTE: This API is currently intended for internal use only by Kibana. Kibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enroll-kibana

func (*MethodSecurity) EnrollNode ¶ added in v9.1.0 

func (p *MethodSecurity) EnrollNode() *security_enroll_node.EnrollNode

Enroll a node.

Enroll a new node to allow it to join an existing cluster with security features enabled.

The response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster. The response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enroll-node

func (*MethodSecurity) GetApiKey ¶ added in v9.1.0 

func (p *MethodSecurity) GetApiKey() *security_get_api_key.GetApiKey

Get API key information.

Retrieves information for one or more API keys. NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-api-key

func (*MethodSecurity) GetBuiltinPrivileges ¶ added in v9.1.0 

func (p *MethodSecurity) GetBuiltinPrivileges() *security_get_builtin_privileges.GetBuiltinPrivileges

Get builtin privileges.

Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-builtin-privileges

func (*MethodSecurity) GetPrivileges ¶ added in v9.1.0 

func (p *MethodSecurity) GetPrivileges() *security_get_privileges.GetPrivileges

Get application privileges.

To use this API, you must have one of the following privileges:

* The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-privileges

func (*MethodSecurity) GetRole ¶ added in v9.1.0 

func (p *MethodSecurity) GetRole() *security_get_role.GetRole

Get roles.

Get roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role

func (*MethodSecurity) GetRoleMapping ¶ added in v9.1.0 

func (p *MethodSecurity) GetRoleMapping() *security_get_role_mapping.GetRoleMapping

Get role mappings.

Role mappings define which roles are assigned to each user. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The get role mappings API cannot retrieve role mappings that are defined in role mapping files. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role-mapping

func (*MethodSecurity) GetServiceAccounts ¶ added in v9.1.0 

func (p *MethodSecurity) GetServiceAccounts() *security_get_service_accounts.GetServiceAccounts

Get service accounts.

Get a list of service accounts that match the provided path parameters.

NOTE: Currently, only the `elastic/fleet-server` service account is available. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-accounts

func (*MethodSecurity) GetServiceCredentials ¶ added in v9.1.0 

func (p *MethodSecurity) GetServiceCredentials(namespace, service string) *security_get_service_credentials.GetServiceCredentials

Get service account credentials.

To use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`).

The response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.

NOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster. Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-credentials

func (*MethodSecurity) GetSettings ¶ added in v9.1.0 

func (p *MethodSecurity) GetSettings() *security_get_settings.GetSettings

Get security index settings.

Get the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of the index settings — those that are user-configurable—will be shown. This includes:

* `index.auto_expand_replicas` * `index.number_of_replicas` https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-settings

func (*MethodSecurity) GetToken ¶ added in v9.1.0 

func (p *MethodSecurity) GetToken() *security_get_token.GetToken

Get a token.

Create a bearer token for access without requiring basic authentication. The tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface. Alternatively, you can explicitly enable the `xpack.security.authc.token.enabled` setting. When you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface.

The get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body.

A successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available.

The tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used. That time period is defined by the `xpack.security.authc.token.timeout` setting. If you want to invalidate a token immediately, you can do so by using the invalidate token API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-token

func (*MethodSecurity) GetUser ¶ added in v9.1.0 

func (p *MethodSecurity) GetUser() *security_get_user.GetUser

Get users.

Get information about users in the native realm and built-in users. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user

func (*MethodSecurity) GetUserPrivileges ¶ added in v9.1.0 

func (p *MethodSecurity) GetUserPrivileges() *security_get_user_privileges.GetUserPrivileges

Get user privileges.

Get the security privileges for the logged in user. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature. To check whether a user has a specific list of privileges, use the has privileges API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user-privileges

func (*MethodSecurity) GetUserProfile ¶ added in v9.1.0 

func (p *MethodSecurity) GetUserProfile(uid string) *security_get_user_profile.GetUserProfile

Get a user profile.

Get a user's profile using the unique profile ID.

NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user-profile

func (*MethodSecurity) GrantApiKey ¶ added in v9.1.0 

func (p *MethodSecurity) GrantApiKey() *security_grant_api_key.GrantApiKey

Grant an API key.

Create an API key on behalf of another user. This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. The caller must have authentication credentials for the user on whose behalf the API key will be created. It is not possible to use this API to create an API key without that user's credentials. The supported user authentication credential types are:

* username and password * Elasticsearch access tokens * JWTs

The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. In this case, the API key will be created on behalf of the impersonated user.

This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf. The API keys are created by the Elasticsearch API key service, which is automatically enabled.

A successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds.

By default, API keys never expire. You can specify expiration information when you create the API keys. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-grant-api-key

func (*MethodSecurity) HasPrivileges ¶ added in v9.1.0 

func (p *MethodSecurity) HasPrivileges() *security_has_privileges.HasPrivileges

Check user privileges.

Determine whether the specified user has a specified list of privileges. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges

func (*MethodSecurity) HasPrivilegesUserProfile ¶ added in v9.1.0 

func (p *MethodSecurity) HasPrivilegesUserProfile() *security_has_privileges_user_profile.HasPrivilegesUserProfile

Check user profile privileges.

Determine whether the users associated with the specified user profile IDs have all the requested privileges.

NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges-user-profile

func (*MethodSecurity) InvalidateApiKey ¶ added in v9.1.0 

func (p *MethodSecurity) InvalidateApiKey() *security_invalidate_api_key.InvalidateApiKey

Invalidate API keys.

This API invalidates API keys created by the create API key or grant API key APIs. Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.

To use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges. The `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys. The `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys. The `manage_own_api_key` only allows deleting REST API keys that are owned by the user. In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:

- Set the parameter `owner=true`. - Or, set both `username` and `realm_name` to match the user's identity. - Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-api-key

func (*MethodSecurity) InvalidateToken ¶ added in v9.1.0 

func (p *MethodSecurity) InvalidateToken() *security_invalidate_token.InvalidateToken

Invalidate a token.

The access tokens returned by the get token API have a finite period of time for which they are valid. After that time period, they can no longer be used. The time period is defined by the `xpack.security.authc.token.timeout` setting.

The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.

NOTE: While all parameters are optional, at least one of them is required. More specifically, either one of `token` or `refresh_token` parameters is required. If none of these two are specified, then `realm_name` and/or `username` need to be specified. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-token

func (*MethodSecurity) OidcAuthenticate ¶ added in v9.1.0 

func (p *MethodSecurity) OidcAuthenticate() *security_oidc_authenticate.OidcAuthenticate

Authenticate OpenID Connect.

Exchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.

Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-authenticate

func (*MethodSecurity) OidcLogout ¶ added in v9.1.0 

func (p *MethodSecurity) OidcLogout() *security_oidc_logout.OidcLogout

Logout of OpenID Connect.

Invalidate an access token and a refresh token that were generated as a response to the `/_security/oidc/authenticate` API.

If the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout.

Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-logout

func (*MethodSecurity) OidcPrepareAuthentication ¶ added in v9.1.0 

func (p *MethodSecurity) OidcPrepareAuthentication() *security_oidc_prepare_authentication.OidcPrepareAuthentication

Prepare OpenID connect authentication.

Create an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch.

The response of this API is a URL pointing to the Authorization Endpoint of the configured OpenID Connect Provider, which can be used to redirect the browser of the user in order to continue the authentication process.

Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-prepare-authentication

func (*MethodSecurity) PutPrivileges ¶ added in v9.1.0 

func (p *MethodSecurity) PutPrivileges() *security_put_privileges.PutPrivileges

Create or update application privileges.

To use this API, you must have one of the following privileges:

* The `manage_security` cluster privilege (or a greater privilege such as `all`). * The "Manage Application Privileges" global privilege for the application being referenced in the request.

Application names are formed from a prefix, with an optional suffix that conform to the following rules:

* The prefix must begin with a lowercase ASCII letter. * The prefix must contain only ASCII letters or digits. * The prefix must be at least 3 characters long. * If the suffix exists, it must begin with either a dash `-` or `_`. * The suffix cannot contain any of the following characters: `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `*`. * No part of the name can contain whitespace.

Privilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`.

Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-privileges

func (*MethodSecurity) PutRole ¶ added in v9.1.0 

func (p *MethodSecurity) PutRole(name string) *security_put_role.PutRole

Create or update roles.

The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files. File-based role management is not available in Elastic Serverless. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role

func (*MethodSecurity) PutRoleMapping ¶ added in v9.1.0 

func (p *MethodSecurity) PutRoleMapping(name string) *security_put_role_mapping.PutRoleMapping

Create or update role mappings.

Role mappings define which roles are assigned to each user. Each mapping has rules that identify users and a list of roles that are granted to those users. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.

NOTE: This API does not create roles. Rather, it maps users to existing roles. Roles can be created by using the create or update roles API or roles files.

**Role templates**

The most common use for role mappings is to create a mapping from a known value on the user to a fixed role name. For example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch. The `roles` field is used for this purpose.

For more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user. The `role_templates` field is used for this purpose.

NOTE: To use role templates successfully, the relevant scripting feature must be enabled. Otherwise, all attempts to create a role mapping with role templates fail.

All of the user fields that are available in the role mapping rules are also available in the role templates. Thus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated.

By default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user. If the format of the template is set to "json" then the template is expected to produce a JSON string or an array of JSON strings for the role names. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role-mapping

func (*MethodSecurity) PutUser ¶ added in v9.1.0 

func (p *MethodSecurity) PutUser(username string) *security_put_user.PutUser

Create or update users.

Add and update users in the native realm. A password is required for adding a new user but is optional when updating an existing user. To change a user's password without updating any other fields, use the change password API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-user

func (*MethodSecurity) QueryApiKeys ¶ added in v9.1.0 

func (p *MethodSecurity) QueryApiKeys() *security_query_api_keys.QueryApiKeys

Find API keys with a query.

Get a paginated list of API keys and their information. You can optionally filter the results with a query.

To use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges. If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. Refer to the linked documentation for examples of how to find API keys: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-api-keys

func (*MethodSecurity) QueryRole ¶ added in v9.1.0 

func (p *MethodSecurity) QueryRole() *security_query_role.QueryRole

Find roles with a query.

Get roles in a paginated manner. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The query roles API does not retrieve roles that are defined in roles files, nor built-in ones. You can optionally filter the results with a query. Also, the results can be paginated and sorted. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-role

func (*MethodSecurity) QueryUser ¶ added in v9.1.0 

func (p *MethodSecurity) QueryUser() *security_query_user.QueryUser

Find users with a query.

Get information for users in a paginated manner. You can optionally filter the results with a query.

NOTE: As opposed to the get user API, built-in users are excluded from the result. This API is only for native users. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-user

func (*MethodSecurity) SamlAuthenticate ¶ added in v9.1.0 

func (p *MethodSecurity) SamlAuthenticate() *security_saml_authenticate.SamlAuthenticate

Authenticate SAML.

Submit a SAML response message to Elasticsearch for consumption.

NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.

The SAML message that is submitted can be:

* A response to a SAML authentication request that was previously created using the SAML prepare authentication API. * An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow.

In either case, the SAML message needs to be a base64 encoded XML document with a root element of `<Response>`.

After successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-authenticate

func (*MethodSecurity) SamlCompleteLogout ¶ added in v9.1.0 

func (p *MethodSecurity) SamlCompleteLogout() *security_saml_complete_logout.SamlCompleteLogout

Logout of SAML completely.

Verifies the logout response sent from the SAML IdP.

NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.

The SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout. This API verifies the response by ensuring the content is relevant and validating its signature. An empty response is returned if the verification process is successful. The response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding. The caller of this API must prepare the request accordingly so that this API can handle either of them. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-complete-logout

func (*MethodSecurity) SamlInvalidate ¶ added in v9.1.0 

func (p *MethodSecurity) SamlInvalidate() *security_saml_invalidate.SamlInvalidate

Invalidate SAML.

Submit a SAML LogoutRequest message to Elasticsearch for consumption.

NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.

The logout request comes from the SAML IdP during an IdP initiated Single Logout. The custom web application can use this API to have Elasticsearch process the `LogoutRequest`. After successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message. Thus the user can be redirected back to their IdP. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-invalidate

func (*MethodSecurity) SamlLogout ¶ added in v9.1.0 

func (p *MethodSecurity) SamlLogout() *security_saml_logout.SamlLogout

Logout of SAML.

Submits a request to invalidate an access token and refresh token.

NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.

This API invalidates the tokens that were generated for a user by the SAML authenticate API. If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout). https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-logout

func (*MethodSecurity) SamlPrepareAuthentication ¶ added in v9.1.0 

func (p *MethodSecurity) SamlPrepareAuthentication() *security_saml_prepare_authentication.SamlPrepareAuthentication

Prepare SAML authentication.

Create a SAML authentication request (`<AuthnRequest>`) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.

NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.

This API returns a URL pointing to the SAML Identity Provider. You can use the URL to redirect the browser of the user in order to continue the authentication process. The URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded. If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`. These parameters contain the algorithm used for the signature and the signature value itself. It also returns a random string that uniquely identifies this SAML Authentication request. The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-prepare-authentication

func (*MethodSecurity) SamlServiceProviderMetadata ¶ added in v9.1.0 

func (p *MethodSecurity) SamlServiceProviderMetadata(realmname string) *security_saml_service_provider_metadata.SamlServiceProviderMetadata

Create SAML service provider metadata.

Generate SAML metadata for a SAML 2.0 Service Provider.

The SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file. This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-service-provider-metadata

func (*MethodSecurity) SuggestUserProfiles ¶ added in v9.1.0 

func (p *MethodSecurity) SuggestUserProfiles() *security_suggest_user_profiles.SuggestUserProfiles

Suggest a user profile.

Get suggestions for user profiles that match specified search criteria.

NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-suggest-user-profiles

func (*MethodSecurity) UpdateApiKey ¶ added in v9.1.0 

func (p *MethodSecurity) UpdateApiKey(id string) *security_update_api_key.UpdateApiKey

Update an API key.

Update attributes of an existing API key. This API supports updates to an API key's access scope, expiration, and metadata.

To use this API, you must have at least the `manage_own_api_key` cluster privilege. Users can only update API keys that they created or that were granted to them. To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.

IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.

Use this API to update API keys created by the create API key or grant API Key APIs. If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead. It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.

The access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request. The snapshot of the owner's permissions is updated automatically on every call.

IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key

func (*MethodSecurity) UpdateCrossClusterApiKey ¶ added in v9.1.0 

func (p *MethodSecurity) UpdateCrossClusterApiKey(id string) *security_update_cross_cluster_api_key.UpdateCrossClusterApiKey

Update a cross-cluster API key.

Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.

To use this API, you must have at least the `manage_security` cluster privilege. Users can only update API keys that they created. To update another user's API key, use the `run_as` feature to submit a request on behalf of another user.

IMPORTANT: It's not possible to use an API key as the authentication credential for this API. To update an API key, the owner user's credentials are required.

It's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.

This API supports updates to an API key's access scope, metadata, and expiration. The owner user's information, such as the `username` and `realm`, is also updated automatically on every call.

NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.

To learn more about how to use this API, refer to the [Update cross cluter API key API examples page](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-cc-api-key-examples). https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-cross-cluster-api-key

func (*MethodSecurity) UpdateSettings ¶ added in v9.1.0 

func (p *MethodSecurity) UpdateSettings() *security_update_settings.UpdateSettings

Update security index settings.

Update the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`.

NOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates.

If a specific index is not in use on the system and settings are provided for it, the request will be rejected. This API does not yet support configuring the settings for indices before they are in use. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-settings

func (*MethodSecurity) UpdateUserProfileData ¶ added in v9.1.0 

func (p *MethodSecurity) UpdateUserProfileData(uid string) *security_update_user_profile_data.UpdateUserProfileData

Update user profile data.

Update specific data for the user profile that is associated with a unique ID.

NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. Elastic reserves the right to change or remove this feature in future releases without prior notice.

To use this API, you must have one of the following privileges:

* The `manage_user_profile` cluster privilege. * The `update_profile_data` global privilege for the namespaces that are referenced in the request.

This API updates the `labels` and `data` fields of an existing user profile document with JSON objects. New keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.

For both labels and data, content is namespaced by the top-level fields. The `update_profile_data` global privilege grants privileges for updating only the allowed namespaces. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-user-profile-data

type MethodShutdown ¶ added in v9.1.0 

type MethodShutdown struct {
	// contains filtered or unexported fields
}

func (*MethodShutdown) DeleteNode ¶ added in v9.1.0 

func (p *MethodShutdown) DeleteNode(nodeid string) *shutdown_delete_node.DeleteNode

Cancel node shutdown preparations. Remove a node from the shutdown list so it can resume normal operations. You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster. Shutdown requests are never removed automatically by Elasticsearch.

NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

If the operator privileges feature is enabled, you must be an operator to use this API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-delete-node

func (*MethodShutdown) GetNode ¶ added in v9.1.0 

func (p *MethodShutdown) GetNode() *shutdown_get_node.GetNode

Get the shutdown status.

Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled. The API returns status information for each part of the shut down process.

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

If the operator privileges feature is enabled, you must be an operator to use this API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-get-node

func (*MethodShutdown) PutNode ¶ added in v9.1.0 

func (p *MethodShutdown) PutNode(nodeid string) *shutdown_put_node.PutNode

Prepare a node to be shut down.

NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

If you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster.

If the operator privileges feature is enabled, you must be an operator to use this API.

The API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster. This ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.

You must specify the type of shutdown: `restart`, `remove`, or `replace`. If a node is already being prepared for shutdown, you can use this API to change the shutdown type.

IMPORTANT: This API does NOT terminate the Elasticsearch process. Monitor the node shutdown status to determine when it is safe to stop Elasticsearch. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-shutdown-put-node

type MethodSimulate ¶ added in v9.1.0 

type MethodSimulate struct {
	// contains filtered or unexported fields
}

func (*MethodSimulate) Ingest ¶ added in v9.1.0 

func (p *MethodSimulate) Ingest() *simulate_ingest.Ingest

Simulate data ingestion. Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.

This API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch.

The API runs the default and final pipeline for that index against a set of documents provided in the body of the request. If a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would. No data is indexed into Elasticsearch. Instead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation. The transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result.

This API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline. The simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index.

By default, the pipeline definitions that are currently in the system are used. However, you can supply substitute pipeline definitions in the body of the request. These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-simulate-ingest

type MethodSlm ¶ added in v9.1.0 

type MethodSlm struct {
	// contains filtered or unexported fields
}

func (*MethodSlm) DeleteLifecycle ¶ added in v9.1.0 

func (p *MethodSlm) DeleteLifecycle(policyid string) *slm_delete_lifecycle.DeleteLifecycle

Delete a policy. Delete a snapshot lifecycle policy definition. This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-delete-lifecycle

func (*MethodSlm) ExecuteLifecycle ¶ added in v9.1.0 

func (p *MethodSlm) ExecuteLifecycle(policyid string) *slm_execute_lifecycle.ExecuteLifecycle

Run a policy. Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-lifecycle

func (*MethodSlm) ExecuteRetention ¶ added in v9.1.0 

func (p *MethodSlm) ExecuteRetention() *slm_execute_retention.ExecuteRetention

Run a retention policy. Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. The retention policy is normally applied according to its schedule. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-retention

func (*MethodSlm) GetLifecycle ¶ added in v9.1.0 

func (p *MethodSlm) GetLifecycle() *slm_get_lifecycle.GetLifecycle

Get policy information. Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-lifecycle

func (*MethodSlm) GetStats ¶ added in v9.1.0 

func (p *MethodSlm) GetStats() *slm_get_stats.GetStats

Get snapshot lifecycle management statistics. Get global and policy-level statistics about actions taken by snapshot lifecycle management. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-stats

func (*MethodSlm) GetStatus ¶ added in v9.1.0 

func (p *MethodSlm) GetStatus() *slm_get_status.GetStatus

Get the snapshot lifecycle management status. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-status

func (*MethodSlm) PutLifecycle ¶ added in v9.1.0 

func (p *MethodSlm) PutLifecycle(policyid string) *slm_put_lifecycle.PutLifecycle

Create or update a policy. Create or update a snapshot lifecycle policy. If the policy already exists, this request increments the policy version. Only the latest version of a policy is stored. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-put-lifecycle

func (*MethodSlm) Start ¶ added in v9.1.0 

func (p *MethodSlm) Start() *slm_start.Start

Start snapshot lifecycle management. Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start

func (*MethodSlm) Stop ¶ added in v9.1.0 

func (p *MethodSlm) Stop() *slm_stop.Stop

Stop snapshot lifecycle management. Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. Stopping SLM does not stop any snapshots that are in progress. You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.

The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. Use the get snapshot lifecycle management status API to see if SLM is running. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-stop

type MethodSnapshot ¶ added in v9.1.0 

type MethodSnapshot struct {
	// contains filtered or unexported fields
}

func (*MethodSnapshot) CleanupRepository ¶ added in v9.1.0 

func (p *MethodSnapshot) CleanupRepository(repository string) *snapshot_cleanup_repository.CleanupRepository

Clean up the snapshot repository. Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-cleanup-repository

func (*MethodSnapshot) Clone ¶ added in v9.1.0 

func (p *MethodSnapshot) Clone(repository, snapshot, targetsnapshot string) *snapshot_clone.Clone

Clone a snapshot. Clone part of all of a snapshot into another snapshot in the same repository. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-clone

func (*MethodSnapshot) Create ¶ added in v9.1.0 

func (p *MethodSnapshot) Create(repository, snapshot string) *snapshot_create.Create

Create a snapshot. Take a snapshot of a cluster or of data streams and indices. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create

func (*MethodSnapshot) CreateRepository ¶ added in v9.1.0 

func (p *MethodSnapshot) CreateRepository(repository string) *snapshot_create_repository.CreateRepository

Create or update a snapshot repository. IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. To register a snapshot repository, the cluster's global metadata must be writeable. Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.

Several options for this API can be specified using a query parameter or a request body parameter. If both parameters are specified, only the query parameter is used. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create-repository

func (*MethodSnapshot) Delete ¶ added in v9.1.0 

func (p *MethodSnapshot) Delete(repository, snapshot string) *snapshot_delete.Delete

Delete snapshots. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete

func (*MethodSnapshot) DeleteRepository ¶ added in v9.1.0 

func (p *MethodSnapshot) DeleteRepository(repository string) *snapshot_delete_repository.DeleteRepository

Delete snapshot repositories. When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. The snapshots themselves are left untouched and in place. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete-repository

func (*MethodSnapshot) Get ¶ added in v9.1.0 

func (p *MethodSnapshot) Get(repository, snapshot string) *snapshot_get.Get

Get snapshot information.

NOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots. It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration. Snapshots concurrently created may be seen during an iteration. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get

func (*MethodSnapshot) GetRepository ¶ added in v9.1.0 

func (p *MethodSnapshot) GetRepository() *snapshot_get_repository.GetRepository

Get snapshot repository information. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-get-repository

func (*MethodSnapshot) RepositoryAnalyze ¶ added in v9.1.0 

func (p *MethodSnapshot) RepositoryAnalyze(repository string) *snapshot_repository_analyze.RepositoryAnalyze

Analyze a snapshot repository.

Performs operations on a snapshot repository in order to check for incorrect behaviour.

There are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch. Some storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do. This API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system.

The default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations. Run your first analysis with the default parameter values to check for simple problems. Some repositories may behave correctly when lightly loaded but incorrectly under production-like workloads. If the first analysis is successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`. Always specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion. Some repositories may behave correctly when accessed by a small number of Elasticsearch nodes but incorrectly when accessed concurrently by a production-scale cluster. Perform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once.

If the analysis fails, Elasticsearch detected that your repository behaved unexpectedly. This usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support. If so, this storage system is not suitable for use as a snapshot repository. Repository analysis triggers conditions that occur only rarely when taking snapshots in a production system. Snapshotting to unsuitable storage may appear to work correctly most of the time despite repository analysis failures. However your snapshot data is at risk if you store it in a snapshot repository that does not reliably pass repository analysis. You can demonstrate that the analysis failure is due to an incompatible storage implementation by verifying that Elasticsearch does not detect the same problem when analysing the reference implementation of the storage protocol you are using. For instance, if you are using storage that offers an API which the supplier claims to be compatible with AWS S3, verify that repositories in AWS S3 do not fail repository analysis. This allows you to demonstrate to your storage supplier that a repository analysis failure must only be caused by an incompatibility with AWS S3 and cannot be attributed to a problem in Elasticsearch. Please do not report Elasticsearch issues involving third-party storage systems unless you can demonstrate that the same issue exists when analysing a repository that uses the reference implementation of the same storage protocol. You will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects.

If the analysis is successful, the API returns details of the testing process, optionally including how long each operation took. You can use this information to determine the performance of your storage system. If any operation fails or returns an incorrect result, the API returns an error. If the API returns an error, it may not have removed all the data it wrote to the repository. The error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs. You should verify that this location has been cleaned up correctly. If there is still leftover data at the specified location, you should manually remove it.

If the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled. Some clients are configured to close their connection if no response is received within a certain timeout. An analysis takes a long time to complete so you might need to relax any such client-side timeouts. On cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all. The path to the leftover data is recorded in the Elasticsearch logs. You should verify that this location has been cleaned up correctly. If there is still leftover data at the specified location, you should manually remove it.

If the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed. The analysis attempts to detect common bugs but it does not offer 100% coverage. Additionally, it does not test the following:

* Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster. * Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted. * Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results.

IMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again. This consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself. You must ensure this load does not affect other users of these systems. Analyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume.

NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. The response exposes immplementation details of the analysis which may change from version to version.

NOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones. A storage system that passes repository analysis with one version of Elasticsearch may fail with a different version. This indicates it behaves incorrectly in ways that the former version did not detect. You must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch.

NOTE: This API may not work correctly in a mixed-version cluster.

*Implementation details*

NOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions. The request parameters and response format depend on details of the implementation so may also be different in newer versions.

The analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter. These tasks are distributed over the data and master-eligible nodes in the cluster for execution.

For most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote. The size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters. If any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires.

For some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes. These reads are permitted to fail, but must not return partial data. If any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires.

For some blob-level tasks, the executing node will overwrite the blob while its peers are reading it. In this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs. If any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites.

The executing node will use a variety of different methods to write the blob. For instance, where applicable, it will use both single-part and multi-part uploads. Similarly, the reading nodes will use a variety of different methods to read the data back again. For instance they may read the entire blob from start to end or may read only a subset of the data.

For some blob-level tasks, the executing node will cancel the write before it is complete. In this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob.

Linearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation. This operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time. The detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type. Repository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed. Repository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results. If an operation fails due to contention, Elasticsearch retries the operation until it succeeds. Most of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob. Some operations also verify the behavior on small blobs with sizes other than 8 bytes. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-analyze

func (*MethodSnapshot) RepositoryVerifyIntegrity ¶ added in v9.1.0 

func (p *MethodSnapshot) RepositoryVerifyIntegrity(repository string) *snapshot_repository_verify_integrity.RepositoryVerifyIntegrity

Verify the repository integrity. Verify the integrity of the contents of a snapshot repository.

This API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.

If you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity. Until you do so:

* It may not be possible to restore some snapshots from this repository. * Searchable snapshots may report errors when searched or may have unassigned shards. * Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored. * Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk. * Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents.

If the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage. The only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred. You must also identify what caused the damage and take action to prevent it from happening again.

If you cannot restore a repository backup, register a new repository and use this for all future snapshot operations. In some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository.

Avoid all operations which write to the repository while the verify repository integrity API is running. If something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes. It may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting.

NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.

NOTE: This API may not work correctly in a mixed-version cluster.

The default values for the parameters of this API are designed to limit the impact of the integrity verification on other activities in your cluster. For instance, by default it will only use at most half of the `snapshot_meta` threads to verify the integrity of each snapshot, allowing other snapshot operations to use the other half of this thread pool. If you modify these parameters to speed up the verification process, you risk disrupting other snapshot-related operations in your cluster. For large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API.

The response exposes implementation details of the analysis which may change from version to version. The response body format is therefore not considered stable and may be different in newer versions. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-repository-verify-integrity

func (*MethodSnapshot) Restore ¶ added in v9.1.0 

func (p *MethodSnapshot) Restore(repository, snapshot string) *snapshot_restore.Restore

Restore a snapshot. Restore a snapshot of a cluster or data streams and indices.

You can restore a snapshot only to a running cluster with an elected master node. The snapshot repository must be registered and available to the cluster. The snapshot and cluster versions must be compatible.

To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.

Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:

``` GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream ```

If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.

If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-restore

func (*MethodSnapshot) Status ¶ added in v9.1.0 

func (p *MethodSnapshot) Status() *snapshot_status.Status

Get the snapshot status. Get a detailed description of the current state for each shard participating in the snapshot.

Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.

If you omit the `<snapshot>` request path parameter, the request retrieves information only for currently running snapshots. This usage is preferred. If needed, you can specify `<repository>` and `<snapshot>` to retrieve information for specific snapshots, even if they're not currently running.

WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. The API requires a read from the repository for each shard in each snapshot. For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).

Depending on the latency of your storage, such requests can take an extremely long time to return results. These requests can also tax machine resources and, when using cloud storage, incur high processing costs. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-status

func (*MethodSnapshot) VerifyRepository ¶ added in v9.1.0 

func (p *MethodSnapshot) VerifyRepository(repository string) *snapshot_verify_repository.VerifyRepository

Verify a snapshot repository. Check for common misconfigurations in a snapshot repository. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-verify-repository

type MethodSql ¶ added in v9.1.0 

type MethodSql struct {
	// contains filtered or unexported fields
}

func (*MethodSql) ClearCursor ¶ added in v9.1.0 

func (p *MethodSql) ClearCursor() *sql_clear_cursor.ClearCursor

Clear an SQL search cursor. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-clear-cursor

func (*MethodSql) DeleteAsync ¶ added in v9.1.0 

func (p *MethodSql) DeleteAsync(id string) *sql_delete_async.DeleteAsync

Delete an async SQL search. Delete an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.

If the Elasticsearch security features are enabled, only the following users can use this API to delete a search:

* Users with the `cancel_task` cluster privilege. * The user who first submitted the search. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-delete-async

func (*MethodSql) GetAsync ¶ added in v9.1.0 

func (p *MethodSql) GetAsync(id string) *sql_get_async.GetAsync

Get async SQL search results. Get the current status and available results for an async SQL search or stored synchronous SQL search.

If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async

func (*MethodSql) GetAsyncStatus ¶ added in v9.1.0 

func (p *MethodSql) GetAsyncStatus(id string) *sql_get_async_status.GetAsyncStatus

Get the async SQL search status. Get the current status of an async SQL search or a stored synchronous SQL search. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-get-async-status

func (*MethodSql) Query ¶ added in v9.1.0 

func (p *MethodSql) Query() *sql_query.Query

Get SQL search results. Run an SQL request. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query

func (*MethodSql) Translate ¶ added in v9.1.0 

func (p *MethodSql) Translate() *sql_translate.Translate

Translate SQL into Elasticsearch queries. Translate an SQL search into a search API request containing Query DSL. It accepts the same request body parameters as the SQL search API, excluding `cursor`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-translate

type MethodSsl ¶ added in v9.1.0 

type MethodSsl struct {
	// contains filtered or unexported fields
}

func (*MethodSsl) Certificates ¶ added in v9.1.0 

func (p *MethodSsl) Certificates() *ssl_certificates.Certificates

Get SSL certificates.

Get information about the X.509 certificates that are used to encrypt communications in the cluster. The API returns a list that includes certificates from all TLS contexts including:

- Settings for transport and HTTP interfaces - TLS settings that are used within authentication realms - TLS settings for remote monitoring exporters

The list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings. It also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.

The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.

NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.

If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ssl-certificates

type MethodStreams ¶ added in v9.1.0 

type MethodStreams struct {
	// contains filtered or unexported fields
}

func (*MethodStreams) LogsDisable ¶ added in v9.1.0 

func (p *MethodStreams) LogsDisable() *streams_logs_disable.LogsDisable

Disable the Logs Streams feature for this cluster https://www.elastic.co/guide/en/elasticsearch/reference/current/streams-logs-disable.html

func (*MethodStreams) LogsEnable ¶ added in v9.1.0 

func (p *MethodStreams) LogsEnable() *streams_logs_enable.LogsEnable

Enable the Logs Streams feature for this cluster https://www.elastic.co/guide/en/elasticsearch/reference/current/streams-logs-enable.html

func (*MethodStreams) Status ¶ added in v9.1.0 

func (p *MethodStreams) Status() *streams_status.Status

Return the current status of the streams feature for each streams type https://www.elastic.co/guide/en/elasticsearch/reference/current/streams-status.html

type MethodSynonyms ¶ added in v9.1.0 

type MethodSynonyms struct {
	// contains filtered or unexported fields
}

func (*MethodSynonyms) DeleteSynonym ¶ added in v9.1.0 

func (p *MethodSynonyms) DeleteSynonym(id string) *synonyms_delete_synonym.DeleteSynonym

Delete a synonym set.

You can only delete a synonyms set that is not in use by any index analyzer.

Synonyms sets can be used in synonym graph token filters and synonym token filters. These synonym filters can be used as part of search analyzers.

Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open). Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.

If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available. To prevent that, synonyms sets that are used in analyzers can't be deleted. A delete request in this case will return a 400 response code.

To remove a synonyms set, you must first remove all indices that contain analyzers using it. You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data. Once finished, you can delete the index. When the synonyms set is not used in analyzers, you will be able to delete it. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym

func (*MethodSynonyms) DeleteSynonymRule ¶ added in v9.1.0 

func (p *MethodSynonyms) DeleteSynonymRule(setid, ruleid string) *synonyms_delete_synonym_rule.DeleteSynonymRule

Delete a synonym rule. Delete a synonym rule from a synonym set. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-delete-synonym-rule

func (*MethodSynonyms) GetSynonym ¶ added in v9.1.0 

func (p *MethodSynonyms) GetSynonym(id string) *synonyms_get_synonym.GetSynonym

Get a synonym set. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym

func (*MethodSynonyms) GetSynonymRule ¶ added in v9.1.0 

func (p *MethodSynonyms) GetSynonymRule(setid, ruleid string) *synonyms_get_synonym_rule.GetSynonymRule

Get a synonym rule. Get a synonym rule from a synonym set. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym-rule

func (*MethodSynonyms) GetSynonymsSets ¶ added in v9.1.0 

func (p *MethodSynonyms) GetSynonymsSets() *synonyms_get_synonyms_sets.GetSynonymsSets

Get all synonym sets. Get a summary of all defined synonym sets. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-get-synonym

func (*MethodSynonyms) PutSynonym ¶ added in v9.1.0 

func (p *MethodSynonyms) PutSynonym(id string) *synonyms_put_synonym.PutSynonym

Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets.

When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.

For practical examples of how to create or update a synonyms set, refer to the External documentation. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym

func (*MethodSynonyms) PutSynonymRule ¶ added in v9.1.0 

func (p *MethodSynonyms) PutSynonymRule(setid, ruleid string) *synonyms_put_synonym_rule.PutSynonymRule

Create or update a synonym rule. Create or update a synonym rule in a synonym set.

If any of the synonym rules included is invalid, the API returns an error.

When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-synonyms-put-synonym-rule

type MethodTasks ¶ added in v9.1.0 

type MethodTasks struct {
	// contains filtered or unexported fields
}

func (*MethodTasks) Cancel ¶ added in v9.1.0 

func (p *MethodTasks) Cancel() *tasks_cancel.Cancel

Cancel a task.

WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. The get task information API will continue to list these cancelled tasks until they complete. The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.

To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running. You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks

func (*MethodTasks) Get ¶ added in v9.1.0 

func (p *MethodTasks) Get(taskid string) *tasks_get.Get

Get task information. Get information about a task currently running in the cluster.

WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

If the task identifier is not found, a 404 response code indicates that there are no resources that match the request. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks

func (*MethodTasks) List ¶ added in v9.1.0 

func (p *MethodTasks) List() *tasks_list.List

Get all tasks. Get information about the tasks currently running on one or more nodes in the cluster.

WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

**Identifying running tasks**

The `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information. This enables you to track certain calls or associate certain tasks with the client that started them. For example:

``` curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents" ```

The API returns the following result:

``` HTTP/1.1 200 OK X-Opaque-Id: 123456 content-type: application/json; charset=UTF-8 content-length: 831 

{
  "tasks" : {
    "u5lcZHqcQhu-rUoFaqDphA:45" : {
      "node" : "u5lcZHqcQhu-rUoFaqDphA",
      "id" : 45,
      "type" : "transport",
      "action" : "cluster:monitor/tasks/lists",
      "start_time_in_millis" : 1513823752749,
      "running_time_in_nanos" : 293139,
      "cancellable" : false,
      "headers" : {
        "X-Opaque-Id" : "123456"
      },
      "children" : [
        {
          "node" : "u5lcZHqcQhu-rUoFaqDphA",
          "id" : 46,
          "type" : "direct",
          "action" : "cluster:monitor/tasks/lists[n]",
          "start_time_in_millis" : 1513823752750,
          "running_time_in_nanos" : 92133,
          "cancellable" : false,
          "parent_task_id" : "u5lcZHqcQhu-rUoFaqDphA:45",
          "headers" : {
            "X-Opaque-Id" : "123456"
          }
        }
      ]
    }
  }
 }

``` In this example, `X-Opaque-Id: 123456` is the ID as a part of the response header. The `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request. The `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks

type MethodTextStructure ¶ added in v9.1.0 

type MethodTextStructure struct {
	// contains filtered or unexported fields
}

func (*MethodTextStructure) FindFieldStructure ¶ added in v9.1.0 

func (p *MethodTextStructure) FindFieldStructure() *text_structure_find_field_structure.FindFieldStructure

Find the structure of a text field. Find the structure of a text field in an Elasticsearch index.

This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch. For example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field.

The response from the API contains:

* Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.

All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.

If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-text_structure

func (*MethodTextStructure) FindMessageStructure ¶ added in v9.1.0 

func (p *MethodTextStructure) FindMessageStructure() *text_structure_find_message_structure.FindMessageStructure

Find the structure of text messages. Find the structure of a list of text messages. The messages must contain data that is suitable to be ingested into Elasticsearch.

This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.

The response from the API contains:

* Sample messages. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.

All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.

If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. It helps determine why the returned structure was chosen. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-message-structure

func (*MethodTextStructure) FindStructure ¶ added in v9.1.0 

func (p *MethodTextStructure) FindStructure() *text_structure_find_structure.FindStructure

Find the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch.

This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format. It must, however, be text; binary text formats are not currently supported. The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.

The response from the API contains:

* A couple of messages from the beginning of the text. * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.

All this information can be calculated by the structure finder with no guidance. However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-structure

func (*MethodTextStructure) TestGrokPattern ¶ added in v9.1.0 

func (p *MethodTextStructure) TestGrokPattern() *text_structure_test_grok_pattern.TestGrokPattern

Test a Grok pattern. Test a Grok pattern on one or more lines of text. The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-test-grok-pattern

type MethodTransform ¶ added in v9.1.0 

type MethodTransform struct {
	// contains filtered or unexported fields
}

func (*MethodTransform) DeleteTransform ¶ added in v9.1.0 

func (p *MethodTransform) DeleteTransform(transformid string) *transform_delete_transform.DeleteTransform

Delete a transform. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-delete-transform

func (*MethodTransform) GetNodeStats ¶ added in v9.1.0 

func (p *MethodTransform) GetNodeStats() *transform_get_node_stats.GetNodeStats

Retrieves transform usage information for transform nodes. https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-node-stats.html

func (*MethodTransform) GetTransform ¶ added in v9.1.0 

func (p *MethodTransform) GetTransform() *transform_get_transform.GetTransform

Get transforms. Get configuration information for transforms. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform

func (*MethodTransform) GetTransformStats ¶ added in v9.1.0 

func (p *MethodTransform) GetTransformStats(transformid string) *transform_get_transform_stats.GetTransformStats

Get transform stats.

Get usage information for transforms. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-get-transform-stats

func (*MethodTransform) PreviewTransform ¶ added in v9.1.0 

func (p *MethodTransform) PreviewTransform() *transform_preview_transform.PreviewTransform

Preview a transform. Generates a preview of the results that you will get when you create a transform with the same configuration.

It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also generates a list of mappings and settings for the destination index. These values are determined based on the field types of the source index and the transform aggregations. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-preview-transform

func (*MethodTransform) PutTransform ¶ added in v9.1.0 

func (p *MethodTransform) PutTransform(transformid string) *transform_put_transform.PutTransform

Create a transform. Creates a transform.

A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a unique row per entity.

You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values in the latest object.

You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations.

NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not give users any privileges on `.data-frame-internal*` indices. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-put-transform

func (*MethodTransform) ResetTransform ¶ added in v9.1.0 

func (p *MethodTransform) ResetTransform(transformid string) *transform_reset_transform.ResetTransform

Reset a transform.

Before you can reset it, you must stop it; alternatively, use the `force` query parameter. If the destination index was created by the transform, it is deleted. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-reset-transform

func (*MethodTransform) ScheduleNowTransform ¶ added in v9.1.0 

func (p *MethodTransform) ScheduleNowTransform(transformid string) *transform_schedule_now_transform.ScheduleNowTransform

Schedule a transform to start now.

Instantly run a transform to process data. If you run this API, the transform will process the new data instantly, without waiting for the configured frequency interval. After the API is called, the transform will be processed again at `now + frequency` unless the API is called again in the meantime. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-schedule-now-transform

func (*MethodTransform) StartTransform ¶ added in v9.1.0 

func (p *MethodTransform) StartTransform(transformid string) *transform_start_transform.StartTransform

Start a transform.

When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping definitions for the destination index from the source indices and the transform aggregations. If fields in the destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings in a pivot transform.

When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you created the transform, they occur when you start the transform—​with the exception of privilege checks. When Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the time of creation and uses those same roles. If those roles do not have the required privileges on the source and destination indices, the transform fails when it attempts unauthorized operations. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-start-transform

func (*MethodTransform) StopTransform ¶ added in v9.1.0 

func (p *MethodTransform) StopTransform(transformid string) *transform_stop_transform.StopTransform

Stop transforms. Stops one or more transforms. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-stop-transform

func (*MethodTransform) UpdateTransform ¶ added in v9.1.0 

func (p *MethodTransform) UpdateTransform(transformid string) *transform_update_transform.UpdateTransform

Update a transform. Updates certain properties of a transform.

All updated properties except `description` do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-update-transform

func (*MethodTransform) UpgradeTransforms ¶ added in v9.1.0 

func (p *MethodTransform) UpgradeTransforms() *transform_upgrade_transforms.UpgradeTransforms

Upgrade all transforms.

Transforms are compatible across minor versions and between supported major versions. However, over time, the format of transform configuration information may change. This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. It also cleans up the internal data structures that store the transform state and checkpoints. The upgrade does not affect the source and destination indices. The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.

If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. Resolve the issue then re-run the process again. A summary is returned when the upgrade is finished.

To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. You may want to perform a recent cluster backup prior to the upgrade. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-upgrade-transforms

type MethodWatcher ¶ added in v9.1.0 

type MethodWatcher struct {
	// contains filtered or unexported fields
}

func (*MethodWatcher) AckWatch ¶ added in v9.1.0 

func (p *MethodWatcher) AckWatch(watchid string) *watcher_ack_watch.AckWatch

Acknowledge a watch. Acknowledging a watch enables you to manually throttle the execution of the watch's actions.

The acknowledgement state of an action is stored in the `status.actions.<id>.ack.state` structure.

IMPORTANT: If the specified watch is currently being executed, this API will return an error The reason for this behavior is to prevent overwriting the watch status from a watch execution.

Acknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`. This happens when the condition of the watch is not met (the condition evaluates to false). To demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-ack-watch

func (*MethodWatcher) ActivateWatch ¶ added in v9.1.0 

func (p *MethodWatcher) ActivateWatch(watchid string) *watcher_activate_watch.ActivateWatch

Activate a watch. A watch can be either active or inactive. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-activate-watch

func (*MethodWatcher) DeactivateWatch ¶ added in v9.1.0 

func (p *MethodWatcher) DeactivateWatch(watchid string) *watcher_deactivate_watch.DeactivateWatch

Deactivate a watch. A watch can be either active or inactive. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-deactivate-watch

func (*MethodWatcher) DeleteWatch ¶ added in v9.1.0 

func (p *MethodWatcher) DeleteWatch(id string) *watcher_delete_watch.DeleteWatch

Delete a watch. When the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again.

Deleting a watch does not delete any watch execution records related to this watch from the watch history.

IMPORTANT: Deleting a watch must be done by using only this API. Do not delete the watch directly from the `.watches` index using the Elasticsearch delete document API When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-delete-watch

func (*MethodWatcher) ExecuteWatch ¶ added in v9.1.0 

func (p *MethodWatcher) ExecuteWatch() *watcher_execute_watch.ExecuteWatch

Run a watch. This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.

For testing and debugging purposes, you also have fine-grained control on how the watch runs. You can run the watch without running all of its actions or alternatively by simulating them. You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs.

You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline. This serves as great tool for testing and debugging your watches prior to adding them to Watcher.

When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches. If your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch.

When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch. Refer to the external documentation for examples of watch execution requests, including existing, customized, and inline watches. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-execute-watch

func (*MethodWatcher) GetSettings ¶ added in v9.1.0 

func (p *MethodWatcher) GetSettings() *watcher_get_settings.GetSettings

Get Watcher index settings. Get settings for the Watcher internal index (`.watches`). Only a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-settings

func (*MethodWatcher) GetWatch ¶ added in v9.1.0 

func (p *MethodWatcher) GetWatch(id string) *watcher_get_watch.GetWatch

Get a watch. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-get-watch

func (*MethodWatcher) PutWatch ¶ added in v9.1.0 

func (p *MethodWatcher) PutWatch(id string) *watcher_put_watch.PutWatch

Create or update a watch. When a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine. Typically for the `schedule` trigger, the scheduler is the trigger engine.

IMPORTANT: You must use Kibana or this API to create a watch. Do not add a watch directly to the `.watches` index by using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index.

When you add a watch you can also define its initial active state by setting the *active* parameter.

When Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges. If the user is able to read index `a`, but not index `b`, the same will apply when the watch runs. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-put-watch

func (*MethodWatcher) QueryWatches ¶ added in v9.1.0 

func (p *MethodWatcher) QueryWatches() *watcher_query_watches.QueryWatches

Query watches. Get all registered watches in a paginated manner and optionally filter watches by a query.

Note that only the `_id` and `metadata.*` fields are queryable or sortable. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-query-watches

func (*MethodWatcher) Start ¶ added in v9.1.0 

func (p *MethodWatcher) Start() *watcher_start.Start

Start the watch service. Start the Watcher service if it is not already running. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-start

func (*MethodWatcher) Stats ¶ added in v9.1.0 

func (p *MethodWatcher) Stats() *watcher_stats.Stats

Get Watcher statistics. This API always returns basic metrics. You retrieve more metrics by using the metric parameter. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stats

func (*MethodWatcher) Stop ¶ added in v9.1.0 

func (p *MethodWatcher) Stop() *watcher_stop.Stop

Stop the watch service. Stop the Watcher service if it is running. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-stop

func (*MethodWatcher) UpdateSettings ¶ added in v9.1.0 

func (p *MethodWatcher) UpdateSettings() *watcher_update_settings.UpdateSettings

Update Watcher index settings. Update settings for the Watcher internal index (`.watches`). Only a subset of settings can be modified. This includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`, `index.routing.allocation.include.*` and `index.routing.allocation.require.*`. Modification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the Watcher shards must always be in the `data_content` tier. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-update-settings

type MethodXpack ¶ added in v9.1.0 

type MethodXpack struct {
	// contains filtered or unexported fields
}

func (*MethodXpack) Info ¶ added in v9.1.0 

func (p *MethodXpack) Info() *xpack_info.Info

Get information. The information provided by the API includes:

* Build information including the build number and timestamp. * License information about the currently installed license. * Feature information for the features that are currently enabled and available under the current license. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-info

func (*MethodXpack) Usage ¶ added in v9.1.0 

func (p *MethodXpack) Usage() *xpack_usage.Usage

Get usage information. Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics. https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-xpack

type Migration ¶ 

type Migration struct {
	Deprecations            migration_deprecations.NewDeprecations
	GetFeatureUpgradeStatus migration_get_feature_upgrade_status.NewGetFeatureUpgradeStatus
	PostFeatureUpgrade      migration_post_feature_upgrade.NewPostFeatureUpgrade
}

type Ml ¶ 

type Ml struct {
	ClearTrainedModelDeploymentCache ml_clear_trained_model_deployment_cache.NewClearTrainedModelDeploymentCache
	CloseJob                         ml_close_job.NewCloseJob
	DeleteCalendar                   ml_delete_calendar.NewDeleteCalendar
	DeleteCalendarEvent              ml_delete_calendar_event.NewDeleteCalendarEvent
	DeleteCalendarJob                ml_delete_calendar_job.NewDeleteCalendarJob
	DeleteDataFrameAnalytics         ml_delete_data_frame_analytics.NewDeleteDataFrameAnalytics
	DeleteDatafeed                   ml_delete_datafeed.NewDeleteDatafeed
	DeleteExpiredData                ml_delete_expired_data.NewDeleteExpiredData
	DeleteFilter                     ml_delete_filter.NewDeleteFilter
	DeleteForecast                   ml_delete_forecast.NewDeleteForecast
	DeleteJob                        ml_delete_job.NewDeleteJob
	DeleteModelSnapshot              ml_delete_model_snapshot.NewDeleteModelSnapshot
	DeleteTrainedModel               ml_delete_trained_model.NewDeleteTrainedModel
	DeleteTrainedModelAlias          ml_delete_trained_model_alias.NewDeleteTrainedModelAlias
	EstimateModelMemory              ml_estimate_model_memory.NewEstimateModelMemory
	EvaluateDataFrame                ml_evaluate_data_frame.NewEvaluateDataFrame
	ExplainDataFrameAnalytics        ml_explain_data_frame_analytics.NewExplainDataFrameAnalytics
	FlushJob                         ml_flush_job.NewFlushJob
	Forecast                         ml_forecast.NewForecast
	GetBuckets                       ml_get_buckets.NewGetBuckets
	GetCalendarEvents                ml_get_calendar_events.NewGetCalendarEvents
	GetCalendars                     ml_get_calendars.NewGetCalendars
	GetCategories                    ml_get_categories.NewGetCategories
	GetDataFrameAnalytics            ml_get_data_frame_analytics.NewGetDataFrameAnalytics
	GetDataFrameAnalyticsStats       ml_get_data_frame_analytics_stats.NewGetDataFrameAnalyticsStats
	GetDatafeedStats                 ml_get_datafeed_stats.NewGetDatafeedStats
	GetDatafeeds                     ml_get_datafeeds.NewGetDatafeeds
	GetFilters                       ml_get_filters.NewGetFilters
	GetInfluencers                   ml_get_influencers.NewGetInfluencers
	GetJobStats                      ml_get_job_stats.NewGetJobStats
	GetJobs                          ml_get_jobs.NewGetJobs
	GetMemoryStats                   ml_get_memory_stats.NewGetMemoryStats
	GetModelSnapshotUpgradeStats     ml_get_model_snapshot_upgrade_stats.NewGetModelSnapshotUpgradeStats
	GetModelSnapshots                ml_get_model_snapshots.NewGetModelSnapshots
	GetOverallBuckets                ml_get_overall_buckets.NewGetOverallBuckets
	GetRecords                       ml_get_records.NewGetRecords
	GetTrainedModels                 ml_get_trained_models.NewGetTrainedModels
	GetTrainedModelsStats            ml_get_trained_models_stats.NewGetTrainedModelsStats
	InferTrainedModel                ml_infer_trained_model.NewInferTrainedModel
	Info                             ml_info.NewInfo
	OpenJob                          ml_open_job.NewOpenJob
	PostCalendarEvents               ml_post_calendar_events.NewPostCalendarEvents
	PostData                         ml_post_data.NewPostData
	PreviewDataFrameAnalytics        ml_preview_data_frame_analytics.NewPreviewDataFrameAnalytics
	PreviewDatafeed                  ml_preview_datafeed.NewPreviewDatafeed
	PutCalendar                      ml_put_calendar.NewPutCalendar
	PutCalendarJob                   ml_put_calendar_job.NewPutCalendarJob
	PutDataFrameAnalytics            ml_put_data_frame_analytics.NewPutDataFrameAnalytics
	PutDatafeed                      ml_put_datafeed.NewPutDatafeed
	PutFilter                        ml_put_filter.NewPutFilter
	PutJob                           ml_put_job.NewPutJob
	PutTrainedModel                  ml_put_trained_model.NewPutTrainedModel
	PutTrainedModelAlias             ml_put_trained_model_alias.NewPutTrainedModelAlias
	PutTrainedModelDefinitionPart    ml_put_trained_model_definition_part.NewPutTrainedModelDefinitionPart
	PutTrainedModelVocabulary        ml_put_trained_model_vocabulary.NewPutTrainedModelVocabulary
	ResetJob                         ml_reset_job.NewResetJob
	RevertModelSnapshot              ml_revert_model_snapshot.NewRevertModelSnapshot
	SetUpgradeMode                   ml_set_upgrade_mode.NewSetUpgradeMode
	StartDataFrameAnalytics          ml_start_data_frame_analytics.NewStartDataFrameAnalytics
	StartDatafeed                    ml_start_datafeed.NewStartDatafeed
	StartTrainedModelDeployment      ml_start_trained_model_deployment.NewStartTrainedModelDeployment
	StopDataFrameAnalytics           ml_stop_data_frame_analytics.NewStopDataFrameAnalytics
	StopDatafeed                     ml_stop_datafeed.NewStopDatafeed
	StopTrainedModelDeployment       ml_stop_trained_model_deployment.NewStopTrainedModelDeployment
	UpdateDataFrameAnalytics         ml_update_data_frame_analytics.NewUpdateDataFrameAnalytics
	UpdateDatafeed                   ml_update_datafeed.NewUpdateDatafeed
	UpdateFilter                     ml_update_filter.NewUpdateFilter
	UpdateJob                        ml_update_job.NewUpdateJob
	UpdateModelSnapshot              ml_update_model_snapshot.NewUpdateModelSnapshot
	UpdateTrainedModelDeployment     ml_update_trained_model_deployment.NewUpdateTrainedModelDeployment
	UpgradeJobSnapshot               ml_upgrade_job_snapshot.NewUpgradeJobSnapshot
	Validate                         ml_validate.NewValidate
	ValidateDetector                 ml_validate_detector.NewValidateDetector
}

type Monitoring ¶ 

type Monitoring struct {
	Bulk monitoring_bulk.NewBulk
}

type Nodes ¶ 

type Nodes struct {
	ClearRepositoriesMeteringArchive nodes_clear_repositories_metering_archive.NewClearRepositoriesMeteringArchive
	GetRepositoriesMeteringInfo      nodes_get_repositories_metering_info.NewGetRepositoriesMeteringInfo
	HotThreads                       nodes_hot_threads.NewHotThreads
	Info                             nodes_info.NewInfo
	ReloadSecureSettings             nodes_reload_secure_settings.NewReloadSecureSettings
	Stats                            nodes_stats.NewStats
	Usage                            nodes_usage.NewUsage
}

type Profiling ¶ 

type Profiling struct {
	Flamegraph    profiling_flamegraph.NewFlamegraph
	Stacktraces   profiling_stacktraces.NewStacktraces
	Status        profiling_status.NewStatus
	TopnFunctions profiling_topn_functions.NewTopnFunctions
}

type QueryRules ¶ 

type QueryRules struct {
	DeleteRule    query_rules_delete_rule.NewDeleteRule
	DeleteRuleset query_rules_delete_ruleset.NewDeleteRuleset
	GetRule       query_rules_get_rule.NewGetRule
	GetRuleset    query_rules_get_ruleset.NewGetRuleset
	ListRulesets  query_rules_list_rulesets.NewListRulesets
	PutRule       query_rules_put_rule.NewPutRule
	PutRuleset    query_rules_put_ruleset.NewPutRuleset
	Test          query_rules_test.NewTest
}

type Request ¶ 

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

Request defines the TypedApi requests.

type Rollup ¶ 

type Rollup struct {
	DeleteJob          rollup_delete_job.NewDeleteJob
	GetJobs            rollup_get_jobs.NewGetJobs
	GetRollupCaps      rollup_get_rollup_caps.NewGetRollupCaps
	GetRollupIndexCaps rollup_get_rollup_index_caps.NewGetRollupIndexCaps
	PutJob             rollup_put_job.NewPutJob
	RollupSearch       rollup_rollup_search.NewRollupSearch
	StartJob           rollup_start_job.NewStartJob
	StopJob            rollup_stop_job.NewStopJob
}

type SearchApplication ¶ 

type SearchApplication struct {
	Delete                       search_application_delete.NewDelete
	DeleteBehavioralAnalytics    search_application_delete_behavioral_analytics.NewDeleteBehavioralAnalytics
	Get                          search_application_get.NewGet
	GetBehavioralAnalytics       search_application_get_behavioral_analytics.NewGetBehavioralAnalytics
	List                         search_application_list.NewList
	PostBehavioralAnalyticsEvent search_application_post_behavioral_analytics_event.NewPostBehavioralAnalyticsEvent
	Put                          search_application_put.NewPut
	PutBehavioralAnalytics       search_application_put_behavioral_analytics.NewPutBehavioralAnalytics
	RenderQuery                  search_application_render_query.NewRenderQuery
	Search                       search_application_search.NewSearch
}

type SearchableSnapshots ¶ 

type SearchableSnapshots struct {
	CacheStats searchable_snapshots_cache_stats.NewCacheStats
	ClearCache searchable_snapshots_clear_cache.NewClearCache
	Mount      searchable_snapshots_mount.NewMount
	Stats      searchable_snapshots_stats.NewStats
}

type Security ¶ 

type Security struct {
	ActivateUserProfile         security_activate_user_profile.NewActivateUserProfile
	Authenticate                security_authenticate.NewAuthenticate
	BulkDeleteRole              security_bulk_delete_role.NewBulkDeleteRole
	BulkPutRole                 security_bulk_put_role.NewBulkPutRole
	BulkUpdateApiKeys           security_bulk_update_api_keys.NewBulkUpdateApiKeys
	ChangePassword              security_change_password.NewChangePassword
	ClearApiKeyCache            security_clear_api_key_cache.NewClearApiKeyCache
	ClearCachedPrivileges       security_clear_cached_privileges.NewClearCachedPrivileges
	ClearCachedRealms           security_clear_cached_realms.NewClearCachedRealms
	ClearCachedRoles            security_clear_cached_roles.NewClearCachedRoles
	ClearCachedServiceTokens    security_clear_cached_service_tokens.NewClearCachedServiceTokens
	CreateApiKey                security_create_api_key.NewCreateApiKey
	CreateCrossClusterApiKey    security_create_cross_cluster_api_key.NewCreateCrossClusterApiKey
	CreateServiceToken          security_create_service_token.NewCreateServiceToken
	DelegatePki                 security_delegate_pki.NewDelegatePki
	DeletePrivileges            security_delete_privileges.NewDeletePrivileges
	DeleteRole                  security_delete_role.NewDeleteRole
	DeleteRoleMapping           security_delete_role_mapping.NewDeleteRoleMapping
	DeleteServiceToken          security_delete_service_token.NewDeleteServiceToken
	DeleteUser                  security_delete_user.NewDeleteUser
	DisableUser                 security_disable_user.NewDisableUser
	DisableUserProfile          security_disable_user_profile.NewDisableUserProfile
	EnableUser                  security_enable_user.NewEnableUser
	EnableUserProfile           security_enable_user_profile.NewEnableUserProfile
	EnrollKibana                security_enroll_kibana.NewEnrollKibana
	EnrollNode                  security_enroll_node.NewEnrollNode
	GetApiKey                   security_get_api_key.NewGetApiKey
	GetBuiltinPrivileges        security_get_builtin_privileges.NewGetBuiltinPrivileges
	GetPrivileges               security_get_privileges.NewGetPrivileges
	GetRole                     security_get_role.NewGetRole
	GetRoleMapping              security_get_role_mapping.NewGetRoleMapping
	GetServiceAccounts          security_get_service_accounts.NewGetServiceAccounts
	GetServiceCredentials       security_get_service_credentials.NewGetServiceCredentials
	GetSettings                 security_get_settings.NewGetSettings
	GetToken                    security_get_token.NewGetToken
	GetUser                     security_get_user.NewGetUser
	GetUserPrivileges           security_get_user_privileges.NewGetUserPrivileges
	GetUserProfile              security_get_user_profile.NewGetUserProfile
	GrantApiKey                 security_grant_api_key.NewGrantApiKey
	HasPrivileges               security_has_privileges.NewHasPrivileges
	HasPrivilegesUserProfile    security_has_privileges_user_profile.NewHasPrivilegesUserProfile
	InvalidateApiKey            security_invalidate_api_key.NewInvalidateApiKey
	InvalidateToken             security_invalidate_token.NewInvalidateToken
	OidcAuthenticate            security_oidc_authenticate.NewOidcAuthenticate
	OidcLogout                  security_oidc_logout.NewOidcLogout
	OidcPrepareAuthentication   security_oidc_prepare_authentication.NewOidcPrepareAuthentication
	PutPrivileges               security_put_privileges.NewPutPrivileges
	PutRole                     security_put_role.NewPutRole
	PutRoleMapping              security_put_role_mapping.NewPutRoleMapping
	PutUser                     security_put_user.NewPutUser
	QueryApiKeys                security_query_api_keys.NewQueryApiKeys
	QueryRole                   security_query_role.NewQueryRole
	QueryUser                   security_query_user.NewQueryUser
	SamlAuthenticate            security_saml_authenticate.NewSamlAuthenticate
	SamlCompleteLogout          security_saml_complete_logout.NewSamlCompleteLogout
	SamlInvalidate              security_saml_invalidate.NewSamlInvalidate
	SamlLogout                  security_saml_logout.NewSamlLogout
	SamlPrepareAuthentication   security_saml_prepare_authentication.NewSamlPrepareAuthentication
	SamlServiceProviderMetadata security_saml_service_provider_metadata.NewSamlServiceProviderMetadata
	SuggestUserProfiles         security_suggest_user_profiles.NewSuggestUserProfiles
	UpdateApiKey                security_update_api_key.NewUpdateApiKey
	UpdateCrossClusterApiKey    security_update_cross_cluster_api_key.NewUpdateCrossClusterApiKey
	UpdateSettings              security_update_settings.NewUpdateSettings
	UpdateUserProfileData       security_update_user_profile_data.NewUpdateUserProfileData
}

type Shutdown ¶ 

type Shutdown struct {
	DeleteNode shutdown_delete_node.NewDeleteNode
	GetNode    shutdown_get_node.NewGetNode
	PutNode    shutdown_put_node.NewPutNode
}

type Simulate ¶ 

type Simulate struct {
	Ingest simulate_ingest.NewIngest
}

type Slm ¶ 

type Slm struct {
	DeleteLifecycle  slm_delete_lifecycle.NewDeleteLifecycle
	ExecuteLifecycle slm_execute_lifecycle.NewExecuteLifecycle
	ExecuteRetention slm_execute_retention.NewExecuteRetention
	GetLifecycle     slm_get_lifecycle.NewGetLifecycle
	GetStats         slm_get_stats.NewGetStats
	GetStatus        slm_get_status.NewGetStatus
	PutLifecycle     slm_put_lifecycle.NewPutLifecycle
	Start            slm_start.NewStart
	Stop             slm_stop.NewStop
}

type Snapshot ¶ 

type Snapshot struct {
	CleanupRepository         snapshot_cleanup_repository.NewCleanupRepository
	Clone                     snapshot_clone.NewClone
	Create                    snapshot_create.NewCreate
	CreateRepository          snapshot_create_repository.NewCreateRepository
	Delete                    snapshot_delete.NewDelete
	DeleteRepository          snapshot_delete_repository.NewDeleteRepository
	Get                       snapshot_get.NewGet
	GetRepository             snapshot_get_repository.NewGetRepository
	RepositoryAnalyze         snapshot_repository_analyze.NewRepositoryAnalyze
	RepositoryVerifyIntegrity snapshot_repository_verify_integrity.NewRepositoryVerifyIntegrity
	Restore                   snapshot_restore.NewRestore
	Status                    snapshot_status.NewStatus
	VerifyRepository          snapshot_verify_repository.NewVerifyRepository
}

type Sql ¶ 

type Sql struct {
	ClearCursor    sql_clear_cursor.NewClearCursor
	DeleteAsync    sql_delete_async.NewDeleteAsync
	GetAsync       sql_get_async.NewGetAsync
	GetAsyncStatus sql_get_async_status.NewGetAsyncStatus
	Query          sql_query.NewQuery
	Translate      sql_translate.NewTranslate
}

type Ssl ¶ 

type Ssl struct {
	Certificates ssl_certificates.NewCertificates
}

type Streams ¶ added in v9.1.0 

type Streams struct {
	LogsDisable streams_logs_disable.NewLogsDisable
	LogsEnable  streams_logs_enable.NewLogsEnable
	Status      streams_status.NewStatus
}

type Synonyms ¶ 

type Synonyms struct {
	DeleteSynonym     synonyms_delete_synonym.NewDeleteSynonym
	DeleteSynonymRule synonyms_delete_synonym_rule.NewDeleteSynonymRule
	GetSynonym        synonyms_get_synonym.NewGetSynonym
	GetSynonymRule    synonyms_get_synonym_rule.NewGetSynonymRule
	GetSynonymsSets   synonyms_get_synonyms_sets.NewGetSynonymsSets
	PutSynonym        synonyms_put_synonym.NewPutSynonym
	PutSynonymRule    synonyms_put_synonym_rule.NewPutSynonymRule
}

type Tasks ¶ 

type Tasks struct {
	Cancel tasks_cancel.NewCancel
	Get    tasks_get.NewGet
	List   tasks_list.NewList
}

type TextStructure ¶ 

type TextStructure struct {
	FindFieldStructure   text_structure_find_field_structure.NewFindFieldStructure
	FindMessageStructure text_structure_find_message_structure.NewFindMessageStructure
	FindStructure        text_structure_find_structure.NewFindStructure
	TestGrokPattern      text_structure_test_grok_pattern.NewTestGrokPattern
}

type Transform ¶ 

type Transform struct {
	DeleteTransform      transform_delete_transform.NewDeleteTransform
	GetNodeStats         transform_get_node_stats.NewGetNodeStats
	GetTransform         transform_get_transform.NewGetTransform
	GetTransformStats    transform_get_transform_stats.NewGetTransformStats
	PreviewTransform     transform_preview_transform.NewPreviewTransform
	PutTransform         transform_put_transform.NewPutTransform
	ResetTransform       transform_reset_transform.NewResetTransform
	ScheduleNowTransform transform_schedule_now_transform.NewScheduleNowTransform
	StartTransform       transform_start_transform.NewStartTransform
	StopTransform        transform_stop_transform.NewStopTransform
	UpdateTransform      transform_update_transform.NewUpdateTransform
	UpgradeTransforms    transform_upgrade_transforms.NewUpgradeTransforms
}

type Watcher ¶ 

type Watcher struct {
	AckWatch        watcher_ack_watch.NewAckWatch
	ActivateWatch   watcher_activate_watch.NewActivateWatch
	DeactivateWatch watcher_deactivate_watch.NewDeactivateWatch
	DeleteWatch     watcher_delete_watch.NewDeleteWatch
	ExecuteWatch    watcher_execute_watch.NewExecuteWatch
	GetSettings     watcher_get_settings.NewGetSettings
	GetWatch        watcher_get_watch.NewGetWatch
	PutWatch        watcher_put_watch.NewPutWatch
	QueryWatches    watcher_query_watches.NewQueryWatches
	Start           watcher_start.NewStart
	Stats           watcher_stats.NewStats
	Stop            watcher_stop.NewStop
	UpdateSettings  watcher_update_settings.NewUpdateSettings
}

type Xpack ¶ 

type Xpack struct {
	Info  xpack_info.NewInfo
	Usage xpack_usage.NewUsage
}

Source Files ¶

View all Source files

Directories ¶

Path Synopsis
asyncsearch
delete
Delete an async search.
 Delete an async search.
get
Get async search results.
 Get async search results.
status
Get the async search status.
 Get the async search status.
submit
Run an async search.
 Run an async search.
autoscaling
deleteautoscalingpolicy
Delete an autoscaling policy.
 Delete an autoscaling policy.
getautoscalingcapacity
Get the autoscaling capacity.
 Get the autoscaling capacity.
getautoscalingpolicy
Get an autoscaling policy.
 Get an autoscaling policy.
putautoscalingpolicy
Create or update an autoscaling policy.
 Create or update an autoscaling policy.
Checks if the specified combination of method, API, parameters, and arbitrary capabilities are supported
 Checks if the specified combination of method, API, parameters, and arbitrary capabilities are supported
cat
aliases
Get aliases.
 Get aliases.
allocation
Get shard allocation information.
 Get shard allocation information.
componenttemplates
Get component templates.
 Get component templates.
count
Get a document count.
 Get a document count.
fielddata
Get field data cache information.
 Get field data cache information.
health
Get the cluster health status.
 Get the cluster health status.
help
Get CAT help.
 Get CAT help.
indices
Get index information.
 Get index information.
master
Get master node information.
 Get master node information.
mldatafeeds
Get datafeeds.
 Get datafeeds.
mldataframeanalytics
Get data frame analytics jobs.
 Get data frame analytics jobs.
mljobs
Get anomaly detection jobs.
 Get anomaly detection jobs.
mltrainedmodels
Get trained models.
 Get trained models.
nodeattrs
Get node attribute information.
 Get node attribute information.
nodes
Get node information.
 Get node information.
pendingtasks
Get pending task information.
 Get pending task information.
plugins
Get plugin information.
 Get plugin information.
recovery
Get shard recovery information.
 Get shard recovery information.
repositories
Get snapshot repository information.
 Get snapshot repository information.
segments
Get segment information.
 Get segment information.
shards
Get shard information.
 Get shard information.
snapshots
Get snapshot information.
 Get snapshot information.
tasks
Get task information.
 Get task information.
templates
Get index template information.
 Get index template information.
threadpool
Get thread pool statistics.
 Get thread pool statistics.
transforms
Get transform information.
 Get transform information.
ccr
deleteautofollowpattern
Delete auto-follow patterns.
 Delete auto-follow patterns.
follow
Create a follower.
 Create a follower.
followinfo
Get follower information.
 Get follower information.
followstats
Get follower stats.
 Get follower stats.
forgetfollower
Forget a follower.
 Forget a follower.
getautofollowpattern
Get auto-follow patterns.
 Get auto-follow patterns.
pauseautofollowpattern
Pause an auto-follow pattern.
 Pause an auto-follow pattern.
pausefollow
Pause a follower.
 Pause a follower.
putautofollowpattern
Create or update auto-follow patterns.
 Create or update auto-follow patterns.
resumeautofollowpattern
Resume an auto-follow pattern.
 Resume an auto-follow pattern.
resumefollow
Resume a follower.
 Resume a follower.
stats
Get cross-cluster replication stats.
 Get cross-cluster replication stats.
unfollow
Unfollow an index.
 Unfollow an index.
cluster
allocationexplain
Explain the shard allocations.
 Explain the shard allocations.
deletecomponenttemplate
Delete component templates.
 Delete component templates.
deletevotingconfigexclusions
Clear cluster voting config exclusions.
 Clear cluster voting config exclusions.
existscomponenttemplate
Check component templates.
 Check component templates.
getcomponenttemplate
Get component templates.
 Get component templates.
getsettings
Get cluster-wide settings.
 Get cluster-wide settings.
health
Get the cluster health status.
 Get the cluster health status.
info
Get cluster info.
 Get cluster info.
pendingtasks
Get the pending cluster tasks.
 Get the pending cluster tasks.
postvotingconfigexclusions
Update voting configuration exclusions.
 Update voting configuration exclusions.
putcomponenttemplate
Create or update a component template.
 Create or update a component template.
putsettings
Update the cluster settings.
 Update the cluster settings.
remoteinfo
Get remote cluster information.
 Get remote cluster information.
reroute
Reroute the cluster.
 Reroute the cluster.
state
Get the cluster state.
 Get the cluster state.
stats
Get cluster statistics.
 Get cluster statistics.
connector
checkin
Check in a connector.
 Check in a connector.
delete
Delete a connector.
 Delete a connector.
get
Get a connector.
 Get a connector.
lastsync
Update the connector last sync stats.
 Update the connector last sync stats.
list
Get all connectors.
 Get all connectors.
post
Create a connector.
 Create a connector.
put
Create or update a connector.
 Create or update a connector.
secretpost
Creates a secret for a Connector.
 Creates a secret for a Connector.
syncjobcancel
Cancel a connector sync job.
 Cancel a connector sync job.
syncjobcheckin
Check in a connector sync job.
 Check in a connector sync job.
syncjobclaim
Claim a connector sync job.
 Claim a connector sync job.
syncjobdelete
Delete a connector sync job.
 Delete a connector sync job.
syncjoberror
Set a connector sync job error.
 Set a connector sync job error.
syncjobget
Get a connector sync job.
 Get a connector sync job.
syncjoblist
Get all connector sync jobs.
 Get all connector sync jobs.
syncjobpost
Create a connector sync job.
 Create a connector sync job.
syncjobupdatestats
Set the connector sync job stats.
 Set the connector sync job stats.
updateactivefiltering
Activate the connector draft filter.
 Activate the connector draft filter.
updateapikeyid
Update the connector API key ID.
 Update the connector API key ID.
updateconfiguration
Update the connector configuration.
 Update the connector configuration.
updateerror
Update the connector error field.
 Update the connector error field.
updatefeatures
Update the connector features.
 Update the connector features.
updatefiltering
Update the connector filtering.
 Update the connector filtering.
updatefilteringvalidation
Update the connector draft filtering validation.
 Update the connector draft filtering validation.
updateindexname
Update the connector index name.
 Update the connector index name.
updatename
Update the connector name and description.
 Update the connector name and description.
updatenative
Update the connector is_native flag.
 Update the connector is_native flag.
updatepipeline
Update the connector pipeline.
 Update the connector pipeline.
updatescheduling
Update the connector scheduling.
 Update the connector scheduling.
updateservicetype
Update the connector service type.
 Update the connector service type.
updatestatus
Update the connector status.
 Update the connector status.
core
bulk
Bulk index or delete documents.
 Bulk index or delete documents.
clearscroll
Clear a scrolling search.
 Clear a scrolling search.
closepointintime
Close a point in time.
 Close a point in time.
count
Count search results.
 Count search results.
create
Create a new document in the index.
 Create a new document in the index.
delete
Delete a document.
 Delete a document.
deletebyquery
Delete documents.
 Delete documents.
deletebyqueryrethrottle
Throttle a delete by query operation.
 Throttle a delete by query operation.
deletescript
Delete a script or search template.
 Delete a script or search template.
exists
Check a document.
 Check a document.
existssource
Check for a document source.
 Check for a document source.
explain
Explain a document match result.
 Explain a document match result.
fieldcaps
Get the field capabilities.
 Get the field capabilities.
get
Get a document by its ID.
 Get a document by its ID.
getscript
Get a script or search template.
 Get a script or search template.
getscriptcontext
Get script contexts.
 Get script contexts.
getscriptlanguages
Get script languages.
 Get script languages.
getsource
Get a document's source.
 Get a document's source.
healthreport
Get the cluster health.
 Get the cluster health.
index
Create or update a document in an index.
 Create or update a document in an index.
info
Get cluster info.
 Get cluster info.
mget
Get multiple documents.
 Get multiple documents.
msearch
Run multiple searches.
 Run multiple searches.
msearchtemplate
Run multiple templated searches.
 Run multiple templated searches.
mtermvectors
Get multiple term vectors.
 Get multiple term vectors.
openpointintime
Open a point in time.
 Open a point in time.
ping
Ping the cluster.
 Ping the cluster.
putscript
Create or update a script or search template.
 Create or update a script or search template.
rankeval
Evaluate ranked search results.
 Evaluate ranked search results.
reindex
Reindex documents.
 Reindex documents.
reindexrethrottle
Throttle a reindex operation.
 Throttle a reindex operation.
rendersearchtemplate
Render a search template.
 Render a search template.
scriptspainlessexecute
Run a script.
 Run a script.
scroll
Run a scrolling search.
 Run a scrolling search.
search
Run a search.
 Run a search.
searchmvt
Search a vector tile.
 Search a vector tile.
searchshards
Get the search shards.
 Get the search shards.
searchtemplate
Run a search with a search template.
 Run a search with a search template.
termsenum
Get terms in an index.
 Get terms in an index.
termvectors
Get term vector information.
 Get term vector information.
update
Update a document.
 Update a document.
updatebyquery
Update documents.
 Update documents.
updatebyqueryrethrottle
Throttle an update by query operation.
 Throttle an update by query operation.
danglingindices
deletedanglingindex
Delete a dangling index.
 Delete a dangling index.
importdanglingindex
Import a dangling index.
 Import a dangling index.
listdanglingindices
Get the dangling indices.
 Get the dangling indices.
enrich
deletepolicy
Delete an enrich policy.
 Delete an enrich policy.
executepolicy
Run an enrich policy.
 Run an enrich policy.
getpolicy
Get an enrich policy.
 Get an enrich policy.
putpolicy
Create an enrich policy.
 Create an enrich policy.
stats
Get enrich stats.
 Get enrich stats.
eql
delete
Delete an async EQL search.
 Delete an async EQL search.
get
Get async EQL search results.
 Get async EQL search results.
getstatus
Get the async EQL status.
 Get the async EQL status.
search
Get EQL search results.
 Get EQL search results.
esql
asyncquery
Run an async ES|QL query.
 Run an async ES|QL query.
asyncquerydelete
Delete an async ES|QL query.
 Delete an async ES|QL query.
asyncqueryget
Get async ES|QL query results.
 Get async ES|QL query results.
asyncquerystop
Stop async ES|QL query.
 Stop async ES|QL query.
getquery
Get a specific running ES|QL query information.
 Get a specific running ES|QL query information.
listqueries
Get running ES|QL queries information.
 Get running ES|QL queries information.
query
Run an ES|QL query.
 Run an ES|QL query.
features
getfeatures
Get the features.
 Get the features.
resetfeatures
Reset the features.
 Reset the features.
fleet
globalcheckpoints
Get global checkpoints.
 Get global checkpoints.
msearch
Run multiple Fleet searches.
 Run multiple Fleet searches.
postsecret
Creates a secret stored by Fleet.
 Creates a secret stored by Fleet.
search
Run a Fleet search.
 Run a Fleet search.
graph
explore
Explore graph analytics.
 Explore graph analytics.
ilm
deletelifecycle
Delete a lifecycle policy.
 Delete a lifecycle policy.
explainlifecycle
Explain the lifecycle state.
 Explain the lifecycle state.
getlifecycle
Get lifecycle policies.
 Get lifecycle policies.
getstatus
Get the ILM status.
 Get the ILM status.
migratetodatatiers
Migrate to data tiers routing.
 Migrate to data tiers routing.
movetostep
Move to a lifecycle step.
 Move to a lifecycle step.
putlifecycle
Create or update a lifecycle policy.
 Create or update a lifecycle policy.
removepolicy
Remove policies from an index.
 Remove policies from an index.
retry
Retry a policy.
 Retry a policy.
start
Start the ILM plugin.
 Start the ILM plugin.
stop
Stop the ILM plugin.
 Stop the ILM plugin.
indices
addblock
Add an index block.
 Add an index block.
analyze
Get tokens from text analysis.
 Get tokens from text analysis.
cancelmigratereindex
Cancel a migration reindex operation.
 Cancel a migration reindex operation.
clearcache
Clear the cache.
 Clear the cache.
clone
Clone an index.
 Clone an index.
close
Close an index.
 Close an index.
create
Create an index.
 Create an index.
createdatastream
Create a data stream.
 Create a data stream.
createfrom
Create an index from a source index.
 Create an index from a source index.
datastreamsstats
Get data stream stats.
 Get data stream stats.
delete
Delete indices.
 Delete indices.
deletealias
Delete an alias.
 Delete an alias.
deletedatalifecycle
Delete data stream lifecycles.
 Delete data stream lifecycles.
deletedatastream
Delete data streams.
 Delete data streams.
deletedatastreamoptions
Delete data stream options.
 Delete data stream options.
deleteindextemplate
Delete an index template.
 Delete an index template.
deletetemplate
Delete a legacy index template.
 Delete a legacy index template.
diskusage
Analyze the index disk usage.
 Analyze the index disk usage.
downsample
Downsample an index.
 Downsample an index.
exists
Check indices.
 Check indices.
existsalias
Check aliases.
 Check aliases.
existsindextemplate
Check index templates.
 Check index templates.
existstemplate
Check existence of index templates.
 Check existence of index templates.
explaindatalifecycle
Get the status for a data stream lifecycle.
 Get the status for a data stream lifecycle.
fieldusagestats
Get field usage stats.
 Get field usage stats.
flush
Flush data streams or indices.
 Flush data streams or indices.
forcemerge
Force a merge.
 Force a merge.
get
Get index information.
 Get index information.
getalias
Get aliases.
 Get aliases.
getdatalifecycle
Get data stream lifecycles.
 Get data stream lifecycles.
getdatalifecyclestats
Get data stream lifecycle stats.
 Get data stream lifecycle stats.
getdatastream
Get data streams.
 Get data streams.
getdatastreamoptions
Get data stream options.
 Get data stream options.
getdatastreamsettings
Get data stream settings.
 Get data stream settings.
getfieldmapping
Get mapping definitions.
 Get mapping definitions.
getindextemplate
Get index templates.
 Get index templates.
getmapping
Get mapping definitions.
 Get mapping definitions.
getmigratereindexstatus
Get the migration reindexing status.
 Get the migration reindexing status.
getsettings
Get index settings.
 Get index settings.
gettemplate
Get legacy index templates.
 Get legacy index templates.
migratereindex
Reindex legacy backing indices.
 Reindex legacy backing indices.
migratetodatastream
Convert an index alias to a data stream.
 Convert an index alias to a data stream.
modifydatastream
Update data streams.
 Update data streams.
open
Open a closed index.
 Open a closed index.
promotedatastream
Promote a data stream.
 Promote a data stream.
putalias
Create or update an alias.
 Create or update an alias.
putdatalifecycle
Update data stream lifecycles.
 Update data stream lifecycles.
putdatastreamoptions
Update data stream options.
 Update data stream options.
putdatastreamsettings
Update data stream settings.
 Update data stream settings.
putindextemplate
Create or update an index template.
 Create or update an index template.
putmapping
Update field mappings.
 Update field mappings.
putsettings
Update index settings.
 Update index settings.
puttemplate
Create or update a legacy index template.
 Create or update a legacy index template.
recovery
Get index recovery information.
 Get index recovery information.
refresh
Refresh an index.
 Refresh an index.
reloadsearchanalyzers
Reload search analyzers.
 Reload search analyzers.
removeblock
Remove an index block.
 Remove an index block.
resolvecluster
Resolve the cluster.
 Resolve the cluster.
resolveindex
Resolve indices.
 Resolve indices.
rollover
Roll over to a new index.
 Roll over to a new index.
segments
Get index segments.
 Get index segments.
shardstores
Get index shard stores.
 Get index shard stores.
shrink
Shrink an index.
 Shrink an index.
simulateindextemplate
Simulate an index.
 Simulate an index.
simulatetemplate
Simulate an index template.
 Simulate an index template.
split
Split an index.
 Split an index.
stats
Get index statistics.
 Get index statistics.
updatealiases
Create or update an alias.
 Create or update an alias.
validatequery
Validate a query.
 Validate a query.
Perform inference on the service.
 Perform inference on the service.
chatcompletionunified
Perform chat completion inference
 Perform chat completion inference
completion
Perform completion inference on the service
 Perform completion inference on the service
delete
Delete an inference endpoint
 Delete an inference endpoint
get
Get an inference endpoint
 Get an inference endpoint
put
Create an inference endpoint.
 Create an inference endpoint.
putalibabacloud
Create an AlibabaCloud AI Search inference endpoint.
 Create an AlibabaCloud AI Search inference endpoint.
putamazonbedrock
Create an Amazon Bedrock inference endpoint.
 Create an Amazon Bedrock inference endpoint.
putamazonsagemaker
Create an Amazon SageMaker inference endpoint.
 Create an Amazon SageMaker inference endpoint.
putanthropic
Create an Anthropic inference endpoint.
 Create an Anthropic inference endpoint.
putazureaistudio
Create an Azure AI studio inference endpoint.
 Create an Azure AI studio inference endpoint.
putazureopenai
Create an Azure OpenAI inference endpoint.
 Create an Azure OpenAI inference endpoint.
putcohere
Create a Cohere inference endpoint.
 Create a Cohere inference endpoint.
putcustom
Create a custom inference endpoint.
 Create a custom inference endpoint.
putdeepseek
Create a DeepSeek inference endpoint.
 Create a DeepSeek inference endpoint.
putelasticsearch
Create an Elasticsearch inference endpoint.
 Create an Elasticsearch inference endpoint.
putelser
Create an ELSER inference endpoint.
 Create an ELSER inference endpoint.
putgoogleaistudio
Create an Google AI Studio inference endpoint.
 Create an Google AI Studio inference endpoint.
putgooglevertexai
Create a Google Vertex AI inference endpoint.
 Create a Google Vertex AI inference endpoint.
puthuggingface
Create a Hugging Face inference endpoint.
 Create a Hugging Face inference endpoint.
putjinaai
Create an JinaAI inference endpoint.
 Create an JinaAI inference endpoint.
putmistral
Create a Mistral inference endpoint.
 Create a Mistral inference endpoint.
putopenai
Create an OpenAI inference endpoint.
 Create an OpenAI inference endpoint.
putvoyageai
Create a VoyageAI inference endpoint.
 Create a VoyageAI inference endpoint.
putwatsonx
Create a Watsonx inference endpoint.
 Create a Watsonx inference endpoint.
rerank
Perform reranking inference on the service
 Perform reranking inference on the service
sparseembedding
Perform sparse embedding inference on the service
 Perform sparse embedding inference on the service
streamcompletion
Perform streaming inference.
 Perform streaming inference.
textembedding
Perform text embedding inference on the service
 Perform text embedding inference on the service
update
Update an inference endpoint.
 Update an inference endpoint.
ingest
deletegeoipdatabase
Delete GeoIP database configurations.
 Delete GeoIP database configurations.
deleteiplocationdatabase
Delete IP geolocation database configurations.
 Delete IP geolocation database configurations.
deletepipeline
Delete pipelines.
 Delete pipelines.
geoipstats
Get GeoIP statistics.
 Get GeoIP statistics.
getgeoipdatabase
Get GeoIP database configurations.
 Get GeoIP database configurations.
getiplocationdatabase
Get IP geolocation database configurations.
 Get IP geolocation database configurations.
getpipeline
Get pipelines.
 Get pipelines.
processorgrok
Run a grok processor.
 Run a grok processor.
putgeoipdatabase
Create or update a GeoIP database configuration.
 Create or update a GeoIP database configuration.
putiplocationdatabase
Create or update an IP geolocation database configuration.
 Create or update an IP geolocation database configuration.
putpipeline
Create or update a pipeline.
 Create or update a pipeline.
simulate
Simulate a pipeline.
 Simulate a pipeline.
license
delete
Delete the license.
 Delete the license.
get
Get license information.
 Get license information.
getbasicstatus
Get the basic license status.
 Get the basic license status.
gettrialstatus
Get the trial status.
 Get the trial status.
post
Update the license.
 Update the license.
poststartbasic
Start a basic license.
 Start a basic license.
poststarttrial
Start a trial.
 Start a trial.
logstash
deletepipeline
Delete a Logstash pipeline.
 Delete a Logstash pipeline.
getpipeline
Get Logstash pipelines.
 Get Logstash pipelines.
putpipeline
Create or update a Logstash pipeline.
 Create or update a Logstash pipeline.
migration
deprecations
Get deprecation information.
 Get deprecation information.
getfeatureupgradestatus
Get feature migration information.
 Get feature migration information.
postfeatureupgrade
Start the feature migration.
 Start the feature migration.
ml
cleartrainedmodeldeploymentcache
Clear trained model deployment cache.
 Clear trained model deployment cache.
closejob
Close anomaly detection jobs.
 Close anomaly detection jobs.
deletecalendar
Delete a calendar.
 Delete a calendar.
deletecalendarevent
Delete events from a calendar.
 Delete events from a calendar.
deletecalendarjob
Delete anomaly jobs from a calendar.
 Delete anomaly jobs from a calendar.
deletedatafeed
Delete a datafeed.
 Delete a datafeed.
deletedataframeanalytics
Delete a data frame analytics job.
 Delete a data frame analytics job.
deleteexpireddata
Delete expired ML data.
 Delete expired ML data.
deletefilter
Delete a filter.
 Delete a filter.
deleteforecast
Delete forecasts from a job.
 Delete forecasts from a job.
deletejob
Delete an anomaly detection job.
 Delete an anomaly detection job.
deletemodelsnapshot
Delete a model snapshot.
 Delete a model snapshot.
deletetrainedmodel
Delete an unreferenced trained model.
 Delete an unreferenced trained model.
deletetrainedmodelalias
Delete a trained model alias.
 Delete a trained model alias.
estimatemodelmemory
Estimate job model memory usage.
 Estimate job model memory usage.
evaluatedataframe
Evaluate data frame analytics.
 Evaluate data frame analytics.
explaindataframeanalytics
Explain data frame analytics config.
 Explain data frame analytics config.
flushjob
Force buffered data to be processed.
 Force buffered data to be processed.
forecast
Predict future behavior of a time series.
 Predict future behavior of a time series.
getbuckets
Get anomaly detection job results for buckets.
 Get anomaly detection job results for buckets.
getcalendarevents
Get info about events in calendars.
 Get info about events in calendars.
getcalendars
Get calendar configuration info.
 Get calendar configuration info.
getcategories
Get anomaly detection job results for categories.
 Get anomaly detection job results for categories.
getdatafeeds
Get datafeeds configuration info.
 Get datafeeds configuration info.
getdatafeedstats
Get datafeed stats.
 Get datafeed stats.
getdataframeanalytics
Get data frame analytics job configuration info.
 Get data frame analytics job configuration info.
getdataframeanalyticsstats
Get data frame analytics job stats.
 Get data frame analytics job stats.
getfilters
Get filters.
 Get filters.
getinfluencers
Get anomaly detection job results for influencers.
 Get anomaly detection job results for influencers.
getjobs
Get anomaly detection jobs configuration info.
 Get anomaly detection jobs configuration info.
getjobstats
Get anomaly detection job stats.
 Get anomaly detection job stats.
getmemorystats
Get machine learning memory usage info.
 Get machine learning memory usage info.
getmodelsnapshots
Get model snapshots info.
 Get model snapshots info.
getmodelsnapshotupgradestats
Get anomaly detection job model snapshot upgrade usage info.
 Get anomaly detection job model snapshot upgrade usage info.
getoverallbuckets
Get overall bucket results.
 Get overall bucket results.
getrecords
Get anomaly records for an anomaly detection job.
 Get anomaly records for an anomaly detection job.
gettrainedmodels
Get trained model configuration info.
 Get trained model configuration info.
gettrainedmodelsstats
Get trained models usage info.
 Get trained models usage info.
infertrainedmodel
Evaluate a trained model.
 Evaluate a trained model.
info
Get machine learning information.
 Get machine learning information.
openjob
Open anomaly detection jobs.
 Open anomaly detection jobs.
postcalendarevents
Add scheduled events to the calendar.
 Add scheduled events to the calendar.
postdata
Send data to an anomaly detection job for analysis.
 Send data to an anomaly detection job for analysis.
previewdatafeed
Preview a datafeed.
 Preview a datafeed.
previewdataframeanalytics
Preview features used by data frame analytics.
 Preview features used by data frame analytics.
putcalendar
Create a calendar.
 Create a calendar.
putcalendarjob
Add anomaly detection job to calendar.
 Add anomaly detection job to calendar.
putdatafeed
Create a datafeed.
 Create a datafeed.
putdataframeanalytics
Create a data frame analytics job.
 Create a data frame analytics job.
putfilter
Create a filter.
 Create a filter.
putjob
Create an anomaly detection job.
 Create an anomaly detection job.
puttrainedmodel
Create a trained model.
 Create a trained model.
puttrainedmodelalias
Create or update a trained model alias.
 Create or update a trained model alias.
puttrainedmodeldefinitionpart
Create part of a trained model definition.
 Create part of a trained model definition.
puttrainedmodelvocabulary
Create a trained model vocabulary.
 Create a trained model vocabulary.
resetjob
Reset an anomaly detection job.
 Reset an anomaly detection job.
revertmodelsnapshot
Revert to a snapshot.
 Revert to a snapshot.
setupgrademode
Set upgrade_mode for ML indices.
 Set upgrade_mode for ML indices.
startdatafeed
Start datafeeds.
 Start datafeeds.
startdataframeanalytics
Start a data frame analytics job.
 Start a data frame analytics job.
starttrainedmodeldeployment
Start a trained model deployment.
 Start a trained model deployment.
stopdatafeed
Stop datafeeds.
 Stop datafeeds.
stopdataframeanalytics
Stop data frame analytics jobs.
 Stop data frame analytics jobs.
stoptrainedmodeldeployment
Stop a trained model deployment.
 Stop a trained model deployment.
updatedatafeed
Update a datafeed.
 Update a datafeed.
updatedataframeanalytics
Update a data frame analytics job.
 Update a data frame analytics job.
updatefilter
Update a filter.
 Update a filter.
updatejob
Update an anomaly detection job.
 Update an anomaly detection job.
updatemodelsnapshot
Update a snapshot.
 Update a snapshot.
updatetrainedmodeldeployment
Update a trained model deployment.
 Update a trained model deployment.
upgradejobsnapshot
Upgrade a snapshot.
 Upgrade a snapshot.
validate
Validate an anomaly detection job.
 Validate an anomaly detection job.
validatedetector
Validate an anomaly detection job.
 Validate an anomaly detection job.
monitoring
bulk
Send monitoring data.
 Send monitoring data.
nodes
clearrepositoriesmeteringarchive
Clear the archived repositories metering.
 Clear the archived repositories metering.
getrepositoriesmeteringinfo
Get cluster repositories metering.
 Get cluster repositories metering.
hotthreads
Get the hot threads for nodes.
 Get the hot threads for nodes.
info
Get node information.
 Get node information.
reloadsecuresettings
Reload the keystore on nodes in the cluster.
 Reload the keystore on nodes in the cluster.
stats
Get node statistics.
 Get node statistics.
usage
Get feature usage information.
 Get feature usage information.
profiling
flamegraph
Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.
 Extracts a UI-optimized structure to render flamegraphs from Universal Profiling.
stacktraces
Extracts raw stacktrace information from Universal Profiling.
 Extracts raw stacktrace information from Universal Profiling.
status
Returns basic information about the status of Universal Profiling.
 Returns basic information about the status of Universal Profiling.
topnfunctions
Extracts a list of topN functions from Universal Profiling.
 Extracts a list of topN functions from Universal Profiling.
queryrules
deleterule
Delete a query rule.
 Delete a query rule.
deleteruleset
Delete a query ruleset.
 Delete a query ruleset.
getrule
Get a query rule.
 Get a query rule.
getruleset
Get a query ruleset.
 Get a query ruleset.
listrulesets
Get all query rulesets.
 Get all query rulesets.
putrule
Create or update a query rule.
 Create or update a query rule.
putruleset
Create or update a query ruleset.
 Create or update a query ruleset.
test
Test a query ruleset.
 Test a query ruleset.
rollup
deletejob
Delete a rollup job.
 Delete a rollup job.
getjobs
Get rollup job information.
 Get rollup job information.
getrollupcaps
Get the rollup job capabilities.
 Get the rollup job capabilities.
getrollupindexcaps
Get the rollup index capabilities.
 Get the rollup index capabilities.
putjob
Create a rollup job.
 Create a rollup job.
rollupsearch
Search rolled-up data.
 Search rolled-up data.
startjob
Start rollup jobs.
 Start rollup jobs.
stopjob
Stop rollup jobs.
 Stop rollup jobs.
searchablesnapshots
cachestats
Get cache statistics.
 Get cache statistics.
clearcache
Clear the cache.
 Clear the cache.
mount
Mount a snapshot.
 Mount a snapshot.
stats
Get searchable snapshot statistics.
 Get searchable snapshot statistics.
searchapplication
delete
Delete a search application.
 Delete a search application.
deletebehavioralanalytics
Delete a behavioral analytics collection.
 Delete a behavioral analytics collection.
get
Get search application details.
 Get search application details.
getbehavioralanalytics
Get behavioral analytics collections.
 Get behavioral analytics collections.
list
Get search applications.
 Get search applications.
postbehavioralanalyticsevent
Create a behavioral analytics collection event.
 Create a behavioral analytics collection event.
put
Create or update a search application.
 Create or update a search application.
putbehavioralanalytics
Create a behavioral analytics collection.
 Create a behavioral analytics collection.
renderquery
Render a search application query.
 Render a search application query.
search
Run a search application search.
 Run a search application search.
security
activateuserprofile
Activate a user profile.
 Activate a user profile.
authenticate
Authenticate a user.
 Authenticate a user.
bulkdeleterole
Bulk delete roles.
 Bulk delete roles.
bulkputrole
Bulk create or update roles.
 Bulk create or update roles.
bulkupdateapikeys
Bulk update API keys.
 Bulk update API keys.
changepassword
Change passwords.
 Change passwords.
clearapikeycache
Clear the API key cache.
 Clear the API key cache.
clearcachedprivileges
Clear the privileges cache.
 Clear the privileges cache.
clearcachedrealms
Clear the user cache.
 Clear the user cache.
clearcachedroles
Clear the roles cache.
 Clear the roles cache.
clearcachedservicetokens
Clear service account token caches.
 Clear service account token caches.
createapikey
Create an API key.
 Create an API key.
createcrossclusterapikey
Create a cross-cluster API key.
 Create a cross-cluster API key.
createservicetoken
Create a service account token.
 Create a service account token.
delegatepki
Delegate PKI authentication.
 Delegate PKI authentication.
deleteprivileges
Delete application privileges.
 Delete application privileges.
deleterole
Delete roles.
 Delete roles.
deleterolemapping
Delete role mappings.
 Delete role mappings.
deleteservicetoken
Delete service account tokens.
 Delete service account tokens.
deleteuser
Delete users.
 Delete users.
disableuser
Disable users.
 Disable users.
disableuserprofile
Disable a user profile.
 Disable a user profile.
enableuser
Enable users.
 Enable users.
enableuserprofile
Enable a user profile.
 Enable a user profile.
enrollkibana
Enroll Kibana.
 Enroll Kibana.
enrollnode
Enroll a node.
 Enroll a node.
getapikey
Get API key information.
 Get API key information.
getbuiltinprivileges
Get builtin privileges.
 Get builtin privileges.
getprivileges
Get application privileges.
 Get application privileges.
getrole
Get roles.
 Get roles.
getrolemapping
Get role mappings.
 Get role mappings.
getserviceaccounts
Get service accounts.
 Get service accounts.
getservicecredentials
Get service account credentials.
 Get service account credentials.
getsettings
Get security index settings.
 Get security index settings.
gettoken
Get a token.
 Get a token.
getuser
Get users.
 Get users.
getuserprivileges
Get user privileges.
 Get user privileges.
getuserprofile
Get a user profile.
 Get a user profile.
grantapikey
Grant an API key.
 Grant an API key.
hasprivileges
Check user privileges.
 Check user privileges.
hasprivilegesuserprofile
Check user profile privileges.
 Check user profile privileges.
invalidateapikey
Invalidate API keys.
 Invalidate API keys.
invalidatetoken
Invalidate a token.
 Invalidate a token.
oidcauthenticate
Authenticate OpenID Connect.
 Authenticate OpenID Connect.
oidclogout
Logout of OpenID Connect.
 Logout of OpenID Connect.
oidcprepareauthentication
Prepare OpenID connect authentication.
 Prepare OpenID connect authentication.
putprivileges
Create or update application privileges.
 Create or update application privileges.
putrole
Create or update roles.
 Create or update roles.
putrolemapping
Create or update role mappings.
 Create or update role mappings.
putuser
Create or update users.
 Create or update users.
queryapikeys
Find API keys with a query.
 Find API keys with a query.
queryrole
Find roles with a query.
 Find roles with a query.
queryuser
Find users with a query.
 Find users with a query.
samlauthenticate
Authenticate SAML.
 Authenticate SAML.
samlcompletelogout
Logout of SAML completely.
 Logout of SAML completely.
samlinvalidate
Invalidate SAML.
 Invalidate SAML.
samllogout
Logout of SAML.
 Logout of SAML.
samlprepareauthentication
Prepare SAML authentication.
 Prepare SAML authentication.
samlserviceprovidermetadata
Create SAML service provider metadata.
 Create SAML service provider metadata.
suggestuserprofiles
Suggest a user profile.
 Suggest a user profile.
updateapikey
Update an API key.
 Update an API key.
updatecrossclusterapikey
Update a cross-cluster API key.
 Update a cross-cluster API key.
updatesettings
Update security index settings.
 Update security index settings.
updateuserprofiledata
Update user profile data.
 Update user profile data.
shutdown
deletenode
Cancel node shutdown preparations.
 Cancel node shutdown preparations.
getnode
Get the shutdown status.
 Get the shutdown status.
putnode
Prepare a node to be shut down.
 Prepare a node to be shut down.
simulate
ingest
Simulate data ingestion.
 Simulate data ingestion.
slm
deletelifecycle
Delete a policy.
 Delete a policy.
executelifecycle
Run a policy.
 Run a policy.
executeretention
Run a retention policy.
 Run a retention policy.
getlifecycle
Get policy information.
 Get policy information.
getstats
Get snapshot lifecycle management statistics.
 Get snapshot lifecycle management statistics.
getstatus
Get the snapshot lifecycle management status.
 Get the snapshot lifecycle management status.
putlifecycle
Create or update a policy.
 Create or update a policy.
start
Start snapshot lifecycle management.
 Start snapshot lifecycle management.
stop
Stop snapshot lifecycle management.
 Stop snapshot lifecycle management.
snapshot
cleanuprepository
Clean up the snapshot repository.
 Clean up the snapshot repository.
clone
Clone a snapshot.
 Clone a snapshot.
create
Create a snapshot.
 Create a snapshot.
createrepository
Create or update a snapshot repository.
 Create or update a snapshot repository.
delete
Delete snapshots.
 Delete snapshots.
deleterepository
Delete snapshot repositories.
 Delete snapshot repositories.
get
Get snapshot information.
 Get snapshot information.
getrepository
Get snapshot repository information.
 Get snapshot repository information.
repositoryanalyze
Analyze a snapshot repository.
 Analyze a snapshot repository.
repositoryverifyintegrity
Verify the repository integrity.
 Verify the repository integrity.
restore
Restore a snapshot.
 Restore a snapshot.
status
Get the snapshot status.
 Get the snapshot status.
verifyrepository
Verify a snapshot repository.
 Verify a snapshot 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
Clear an SQL search cursor.
 Clear an SQL search cursor.
deleteasync
Delete an async SQL search.
 Delete an async SQL search.
getasync
Get async SQL search results.
 Get async SQL search results.
getasyncstatus
Get the async SQL search status.
 Get the async SQL search status.
query
Get SQL search results.
 Get SQL search results.
translate
Translate SQL into Elasticsearch queries.
 Translate SQL into Elasticsearch queries.
ssl
certificates
Get SSL certificates.
 Get SSL certificates.
streams
logsdisable
Disable the Logs Streams feature for this cluster
 Disable the Logs Streams feature for this cluster
logsenable
Enable the Logs Streams feature for this cluster
 Enable the Logs Streams feature for this cluster
status
Return the current status of the streams feature for each streams type
 Return the current status of the streams feature for each streams type
synonyms
deletesynonym
Delete a synonym set.
 Delete a synonym set.
deletesynonymrule
Delete a synonym rule.
 Delete a synonym rule.
getsynonym
Get a synonym set.
 Get a synonym set.
getsynonymrule
Get a synonym rule.
 Get a synonym rule.
getsynonymssets
Get all synonym sets.
 Get all synonym sets.
putsynonym
Create or update a synonym set.
 Create or update a synonym set.
putsynonymrule
Create or update a synonym rule.
 Create or update a synonym rule.
tasks
cancel
Cancel a task.
 Cancel a task.
get
Get task information.
 Get task information.
list
Get all tasks.
 Get all tasks.
textstructure
findfieldstructure
Find the structure of a text field.
 Find the structure of a text field.
findmessagestructure
Find the structure of text messages.
 Find the structure of text messages.
findstructure
Find the structure of a text file.
 Find the structure of a text file.
testgrokpattern
Test a Grok pattern.
 Test a Grok pattern.
transform
deletetransform
Delete a transform.
 Delete a transform.
getnodestats
Retrieves transform usage information for transform nodes.
 Retrieves transform usage information for transform nodes.
gettransform
Get transforms.
 Get transforms.
gettransformstats
Get transform stats.
 Get transform stats.
previewtransform
Preview a transform.
 Preview a transform.
puttransform
Create a transform.
 Create a transform.
resettransform
Reset a transform.
 Reset a transform.
schedulenowtransform
Schedule a transform to start now.
 Schedule a transform to start now.
starttransform
Start a transform.
 Start a transform.
stoptransform
Stop transforms.
 Stop transforms.
updatetransform
Update a transform.
 Update a transform.
upgradetransforms
Upgrade all transforms.
 Upgrade 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/alibabacloudservicetype
Package alibabacloudservicetype
 Package alibabacloudservicetype
enums/alibabacloudtasktype
Package alibabacloudtasktype
 Package alibabacloudtasktype
enums/allocationexplaindecision
Package allocationexplaindecision
 Package allocationexplaindecision
enums/amazonbedrockservicetype
Package amazonbedrockservicetype
 Package amazonbedrockservicetype
enums/amazonbedrocktasktype
Package amazonbedrocktasktype
 Package amazonbedrocktasktype
enums/amazonsagemakerapi
Package amazonsagemakerapi
 Package amazonsagemakerapi
enums/amazonsagemakerservicetype
Package amazonsagemakerservicetype
 Package amazonsagemakerservicetype
enums/anthropicservicetype
Package anthropicservicetype
 Package anthropicservicetype
enums/anthropictasktype
Package anthropictasktype
 Package anthropictasktype
enums/apikeygranttype
Package apikeygranttype
 Package apikeygranttype
enums/apikeytype
Package apikeytype
 Package apikeytype
enums/appliesto
Package appliesto
 Package appliesto
enums/azureaistudioservicetype
Package azureaistudioservicetype
 Package azureaistudioservicetype
enums/azureaistudiotasktype
Package azureaistudiotasktype
 Package azureaistudiotasktype
enums/azureopenaiservicetype
Package azureopenaiservicetype
 Package azureopenaiservicetype
enums/azureopenaitasktype
Package azureopenaitasktype
 Package azureopenaitasktype
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/catnodecolumn
Package catnodecolumn
 Package catnodecolumn
enums/catrecoverycolumn
Package catrecoverycolumn
 Package catrecoverycolumn
enums/catsegmentscolumn
Package catsegmentscolumn
 Package catsegmentscolumn
enums/catshardcolumn
Package catshardcolumn
 Package catshardcolumn
enums/catsnapshotscolumn
Package catsnapshotscolumn
 Package catsnapshotscolumn
enums/catthreadpoolcolumn
Package catthreadpoolcolumn
 Package catthreadpoolcolumn
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/cjkbigramignoredscript
Package cjkbigramignoredscript
 Package cjkbigramignoredscript
enums/clusterinfotarget
Package clusterinfotarget
 Package clusterinfotarget
enums/clusterprivilege
Package clusterprivilege
 Package clusterprivilege
enums/clustersearchstatus
Package clustersearchstatus
 Package clustersearchstatus
enums/cohereembeddingtype
Package cohereembeddingtype
 Package cohereembeddingtype
enums/cohereinputtype
Package cohereinputtype
 Package cohereinputtype
enums/cohereservicetype
Package cohereservicetype
 Package cohereservicetype
enums/coheresimilaritytype
Package coheresimilaritytype
 Package coheresimilaritytype
enums/coheretasktype
Package coheretasktype
 Package coheretasktype
enums/coheretruncatetype
Package coheretruncatetype
 Package coheretruncatetype
enums/combinedfieldsoperator
Package combinedfieldsoperator
 Package combinedfieldsoperator
enums/combinedfieldszeroterms
Package combinedfieldszeroterms
 Package combinedfieldszeroterms
enums/conditionop
Package conditionop
 Package conditionop
enums/conditionoperator
Package conditionoperator
 Package conditionoperator
enums/conditiontype
Package conditiontype
 Package conditiontype
enums/conflicts
Package conflicts
 Package conflicts
enums/connectionscheme
Package connectionscheme
 Package connectionscheme
enums/connectorfieldtype
Package connectorfieldtype
 Package connectorfieldtype
enums/connectorstatus
Package connectorstatus
 Package connectorstatus
enums/converttype
Package converttype
 Package converttype
enums/customservicetype
Package customservicetype
 Package customservicetype
enums/customtasktype
Package customtasktype
 Package customtasktype
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/deepseekservicetype
Package deepseekservicetype
 Package deepseekservicetype
enums/delimitedpayloadencoding
Package delimitedpayloadencoding
 Package delimitedpayloadencoding
enums/densevectorelementtype
Package densevectorelementtype
 Package densevectorelementtype
enums/densevectorindexoptionstype
Package densevectorindexoptionstype
 Package densevectorindexoptionstype
enums/densevectorsimilarity
Package densevectorsimilarity
 Package densevectorsimilarity
enums/deploymentallocationstate
Package deploymentallocationstate
 Package deploymentallocationstate
enums/deploymentassignmentstate
Package deploymentassignmentstate
 Package deploymentassignmentstate
enums/deprecationlevel
Package deprecationlevel
 Package deprecationlevel
enums/dfiindependencemeasure
Package dfiindependencemeasure
 Package dfiindependencemeasure
enums/dfraftereffect
Package dfraftereffect
 Package dfraftereffect
enums/dfrbasicmodel
Package dfrbasicmodel
 Package dfrbasicmodel
enums/displaytype
Package displaytype
 Package displaytype
enums/distanceunit
Package distanceunit
 Package distanceunit
enums/dynamicmapping
Package dynamicmapping
 Package dynamicmapping
enums/ecscompatibilitytype
Package ecscompatibilitytype
 Package ecscompatibilitytype
enums/edgengramside
Package edgengramside
 Package edgengramside
enums/elasticsearchservicetype
Package elasticsearchservicetype
 Package elasticsearchservicetype
enums/elasticsearchtasktype
Package elasticsearchtasktype
 Package elasticsearchtasktype
enums/elserservicetype
Package elserservicetype
 Package elserservicetype
enums/elsertasktype
Package elsertasktype
 Package elsertasktype
enums/emailpriority
Package emailpriority
 Package emailpriority
enums/enrichpolicyphase
Package enrichpolicyphase
 Package enrichpolicyphase
enums/esqlclusterstatus
Package esqlclusterstatus
 Package esqlclusterstatus
enums/esqlformat
Package esqlformat
 Package esqlformat
enums/eventtype
Package eventtype
 Package eventtype
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/failurestorestatus
Package failurestorestatus
 Package failurestorestatus
enums/feature
Package feature
 Package feature
enums/fieldsortnumerictype
Package fieldsortnumerictype
 Package fieldsortnumerictype
enums/fieldtype
Package fieldtype
 Package fieldtype
enums/fieldvaluefactormodifier
Package fieldvaluefactormodifier
 Package fieldvaluefactormodifier
enums/filteringpolicy
Package filteringpolicy
 Package filteringpolicy
enums/filteringrulerule
Package filteringrulerule
 Package filteringrulerule
enums/filteringvalidationstate
Package filteringvalidationstate
 Package filteringvalidationstate
enums/filtertype
Package filtertype
 Package filtertype
enums/fingerprintdigest
Package fingerprintdigest
 Package fingerprintdigest
enums/followerindexstatus
Package followerindexstatus
 Package followerindexstatus
enums/formattype
Package formattype
 Package formattype
enums/functionboostmode
Package functionboostmode
 Package functionboostmode
enums/functionscoremode
Package functionscoremode
 Package functionscoremode
enums/gappolicy
Package gappolicy
 Package gappolicy
enums/geodistancetype
Package geodistancetype
 Package geodistancetype
enums/geoexecution
Package geoexecution
 Package geoexecution
enums/geogridtargetformat
Package geogridtargetformat
 Package geogridtargetformat
enums/geogridtiletype
Package geogridtiletype
 Package geogridtiletype
enums/geoorientation
Package geoorientation
 Package geoorientation
enums/geopointmetrictype
Package geopointmetrictype
 Package geopointmetrictype
enums/geoshaperelation
Package geoshaperelation
 Package geoshaperelation
enums/geostrategy
Package geostrategy
 Package geostrategy
enums/geovalidationmethod
Package geovalidationmethod
 Package geovalidationmethod
enums/googleaiservicetype
Package googleaiservicetype
 Package googleaiservicetype
enums/googleaistudiotasktype
Package googleaistudiotasktype
 Package googleaistudiotasktype
enums/googlevertexaiservicetype
Package googlevertexaiservicetype
 Package googlevertexaiservicetype
enums/googlevertexaitasktype
Package googlevertexaitasktype
 Package googlevertexaitasktype
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/huggingfaceservicetype
Package huggingfaceservicetype
 Package huggingfaceservicetype
enums/huggingfacetasktype
Package huggingfacetasktype
 Package huggingfacetasktype
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/indexmode
Package indexmode
 Package indexmode
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/jinaaiservicetype
Package jinaaiservicetype
 Package jinaaiservicetype
enums/jinaaisimilaritytype
Package jinaaisimilaritytype
 Package jinaaisimilaritytype
enums/jinaaitasktype
Package jinaaitasktype
 Package jinaaitasktype
enums/jinaaitextembeddingtask
Package jinaaitextembeddingtask
 Package jinaaitextembeddingtask
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/level
Package level
 Package level
enums/licensestatus
Package licensestatus
 Package licensestatus
enums/licensetype
Package licensetype
 Package licensetype
enums/lifecycleoperationmode
Package lifecycleoperationmode
 Package lifecycleoperationmode
enums/lowercasetokenfilterlanguages
Package lowercasetokenfilterlanguages
 Package lowercasetokenfilterlanguages
enums/managedby
Package managedby
 Package managedby
enums/matchtype
Package matchtype
 Package matchtype
enums/memorystatus
Package memorystatus
 Package memorystatus
enums/metric
Package metric
 Package metric
enums/migrationstatus
Package migrationstatus
 Package migrationstatus
enums/minimuminterval
Package minimuminterval
 Package minimuminterval
enums/missingorder
Package missingorder
 Package missingorder
enums/mistralservicetype
Package mistralservicetype
 Package mistralservicetype
enums/mistraltasktype
Package mistraltasktype
 Package mistraltasktype
enums/modeenum
Package modeenum
 Package modeenum
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/openaiservicetype
Package openaiservicetype
 Package openaiservicetype
enums/openaitasktype
Package openaitasktype
 Package openaitasktype
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/painlesscontext
Package painlesscontext
 Package painlesscontext
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/pipelinesimulationstatusoptions
Package pipelinesimulationstatusoptions
 Package pipelinesimulationstatusoptions
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/rankvectorelementtype
Package rankvectorelementtype
 Package rankvectorelementtype
enums/ratemode
Package ratemode
 Package ratemode
enums/refresh
Package refresh
 Package refresh
enums/remoteclusterprivilege
Package remoteclusterprivilege
 Package remoteclusterprivilege
enums/responsecontenttype
Package responsecontenttype
 Package responsecontenttype
enums/restrictionworkflow
Package restrictionworkflow
 Package restrictionworkflow
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/scorenormalizer
Package scorenormalizer
 Package scorenormalizer
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/shardstate
Package shardstate
 Package shardstate
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/snapshotstate
Package snapshotstate
 Package snapshotstate
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/sourcemode
Package sourcemode
 Package sourcemode
enums/sqlformat
Package sqlformat
 Package sqlformat
enums/statslevel
Package statslevel
 Package statslevel
enums/stopwordlanguage
Package stopwordlanguage
 Package stopwordlanguage
enums/storagetype
Package storagetype
 Package storagetype
enums/stringdistance
Package stringdistance
 Package stringdistance
enums/subobjects
Package subobjects
 Package subobjects
enums/suggestmode
Package suggestmode
 Package suggestmode
enums/suggestsort
Package suggestsort
 Package suggestsort
enums/syncjobtriggermethod
Package syncjobtriggermethod
 Package syncjobtriggermethod
enums/syncjobtype
Package syncjobtype
 Package syncjobtype
enums/syncstatus
Package syncstatus
 Package syncstatus
enums/synonymformat
Package synonymformat
 Package synonymformat
enums/syntheticsourcekeepenum
Package syntheticsourcekeepenum
 Package syntheticsourcekeepenum
enums/tasktype
Package tasktype
 Package tasktype
enums/tasktypealibabacloudai
Package tasktypealibabacloudai
 Package tasktypealibabacloudai
enums/tasktypeamazonbedrock
Package tasktypeamazonbedrock
 Package tasktypeamazonbedrock
enums/tasktypeamazonsagemaker
Package tasktypeamazonsagemaker
 Package tasktypeamazonsagemaker
enums/tasktypeanthropic
Package tasktypeanthropic
 Package tasktypeanthropic
enums/tasktypeazureaistudio
Package tasktypeazureaistudio
 Package tasktypeazureaistudio
enums/tasktypeazureopenai
Package tasktypeazureopenai
 Package tasktypeazureopenai
enums/tasktypecohere
Package tasktypecohere
 Package tasktypecohere
enums/tasktypecustom
Package tasktypecustom
 Package tasktypecustom
enums/tasktypedeepseek
Package tasktypedeepseek
 Package tasktypedeepseek
enums/tasktypeelasticsearch
Package tasktypeelasticsearch
 Package tasktypeelasticsearch
enums/tasktypeelser
Package tasktypeelser
 Package tasktypeelser
enums/tasktypegoogleaistudio
Package tasktypegoogleaistudio
 Package tasktypegoogleaistudio
enums/tasktypegooglevertexai
Package tasktypegooglevertexai
 Package tasktypegooglevertexai
enums/tasktypehuggingface
Package tasktypehuggingface
 Package tasktypehuggingface
enums/tasktypejinaai
Package tasktypejinaai
 Package tasktypejinaai
enums/tasktypemistral
Package tasktypemistral
 Package tasktypemistral
enums/tasktypeopenai
Package tasktypeopenai
 Package tasktypeopenai
enums/tasktypevoyageai
Package tasktypevoyageai
 Package tasktypevoyageai
enums/tasktypewatsonx
Package tasktypewatsonx
 Package tasktypewatsonx
enums/tdigestexecutionhint
Package tdigestexecutionhint
 Package tdigestexecutionhint
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/voyageaiservicetype
Package voyageaiservicetype
 Package voyageaiservicetype
enums/voyageaitasktype
Package voyageaitasktype
 Package voyageaitasktype
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/watsonxservicetype
Package watsonxservicetype
 Package watsonxservicetype
enums/watsonxtasktype
Package watsonxtasktype
 Package watsonxtasktype
enums/xpackcategory
Package xpackcategory
 Package xpackcategory
enums/zerotermsquery
Package zerotermsquery
 Package zerotermsquery
watcher
ackwatch
Acknowledge a watch.
 Acknowledge a watch.
activatewatch
Activate a watch.
 Activate a watch.
deactivatewatch
Deactivate a watch.
 Deactivate a watch.
deletewatch
Delete a watch.
 Delete a watch.
executewatch
Run a watch.
 Run a watch.
getsettings
Get Watcher index settings.
 Get Watcher index settings.
getwatch
Get a watch.
 Get a watch.
putwatch
Create or update a watch.
 Create or update a watch.
querywatches
Query watches.
 Query watches.
start
Start the watch service.
 Start the watch service.
stats
Get Watcher statistics.
 Get Watcher statistics.
stop
Stop the watch service.
 Stop the watch service.
updatesettings
Update Watcher index settings.
 Update Watcher index settings.
xpack
info
Get information.
 Get information.
usage
Get usage information.
 Get usage information.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.