# Constants
Version returns the package version as a string.
# Structs
API contains the Elasticsearch APIs
.
BulkRequest configures the Bulk API request.
Cat contains the Cat APIs.
CatAliasesRequest configures the Cat Aliases API request.
CatAllocationRequest configures the Cat Allocation API request.
CatCountRequest configures the Cat Count API request.
CatFielddataRequest configures the Cat Fielddata API request.
CatHealthRequest configures the Cat Health API request.
CatHelpRequest configures the Cat Help API request.
CatIndicesRequest configures the Cat Indices API request.
CatMasterRequest configures the Cat Master API request.
CatNodeattrsRequest configures the Cat Nodeattrs API request.
CatNodesRequest configures the Cat Nodes API request.
CatPendingTasksRequest configures the Cat Pending Tasks API request.
CatPluginsRequest configures the Cat Plugins API request.
CatRecoveryRequest configures the Cat Recovery API request.
CatRepositoriesRequest configures the Cat Repositories API request.
CatSegmentsRequest configures the Cat Segments API request.
CatShardsRequest configures the Cat Shards API request.
CatSnapshotsRequest configures the Cat Snapshots API request.
CatTasksRequest configures the Cat Tasks API request.
CatTemplatesRequest configures the Cat Templates API request.
CatThreadPoolRequest configures the Cat Thread Pool API request.
ClearScrollRequest configures the Clear Scroll API request.
Cluster contains the Cluster APIs.
ClusterAllocationExplainRequest configures the Cluster Allocation Explain API request.
ClusterGetSettingsRequest configures the Cluster Get Settings API request.
ClusterHealthRequest configures the Cluster Health API request.
ClusterPendingTasksRequest configures the Cluster Pending Tasks API request.
ClusterPutSettingsRequest configures the Cluster Put Settings API request.
ClusterRemoteInfoRequest configures the Cluster Remote Info API request.
ClusterRerouteRequest configures the Cluster Reroute API request.
ClusterStateRequest configures the Cluster State API request.
ClusterStatsRequest configures the Cluster Stats API request.
CountPercolateRequest configures the Count Percolate API request.
CountRequest configures the Count API request.
CreateRequest configures the Create API request.
DeleteByQueryRequest configures the Delete By Query API request.
DeleteByQueryRethrottleRequest configures the Delete By Query Rethrottle API request.
DeleteRequest configures the Delete API request.
DeleteScriptRequest configures the Delete Script API request.
DeleteTemplateRequest configures the Delete Template API request.
ExistsRequest configures the Exists API request.
ExistsSourceRequest configures the Exists Source API request.
ExplainRequest configures the Explain API request.
FieldCapsRequest configures the Field Caps API request.
FieldStatsRequest configures the Field Stats API request.
GetRequest configures the Get API request.
GetScriptRequest configures the Get Script API request.
GetSourceRequest configures the Get Source API request.
GetTemplateRequest configures the Get Template API request.
IndexRequest configures the Index API request.
Indices contains the Indices APIs.
IndicesAnalyzeRequest configures the Indices Analyze API request.
IndicesClearCacheRequest configures the Indices Clear Cache API request.
IndicesCloseRequest configures the Indices Close API request.
IndicesCreateRequest configures the Indices Create API request.
IndicesDeleteAliasRequest configures the Indices Delete Alias API request.
IndicesDeleteRequest configures the Indices Delete API request.
IndicesDeleteTemplateRequest configures the Indices Delete Template API request.
IndicesExistsAliasRequest configures the Indices Exists Alias API request.
IndicesExistsDocumentTypeRequest configures the Indices Exists Document Type API request.
IndicesExistsRequest configures the Indices Exists API request.
IndicesExistsTemplateRequest configures the Indices Exists Template API request.
IndicesFlushRequest configures the Indices Flush API request.
IndicesFlushSyncedRequest configures the Indices Flush Synced API request.
IndicesForcemergeRequest configures the Indices Forcemerge API request.
IndicesGetAliasRequest configures the Indices Get Alias API request.
IndicesGetFieldMappingRequest configures the Indices Get Field Mapping API request.
IndicesGetMappingRequest configures the Indices Get Mapping API request.
IndicesGetRequest configures the Indices Get API request.
IndicesGetSettingsRequest configures the Indices Get Settings API request.
IndicesGetTemplateRequest configures the Indices Get Template API request.
IndicesGetUpgradeRequest configures the Indices Get Upgrade API request.
IndicesOpenRequest configures the Indices Open API request.
IndicesPutAliasRequest configures the Indices Put Alias API request.
IndicesPutMappingRequest configures the Indices Put Mapping API request.
IndicesPutSettingsRequest configures the Indices Put Settings API request.
IndicesPutTemplateRequest configures the Indices Put Template API request.
IndicesRecoveryRequest configures the Indices Recovery API request.
IndicesRefreshRequest configures the Indices Refresh API request.
IndicesRolloverRequest configures the Indices Rollover API request.
IndicesSegmentsRequest configures the Indices Segments API request.
IndicesShardStoresRequest configures the Indices Shard Stores API request.
IndicesShrinkRequest configures the Indices Shrink API request.
IndicesSplitRequest configures the Indices Split API request.
IndicesStatsRequest configures the Indices Stats API request.
IndicesUpdateAliasesRequest configures the Indices Update Aliases API request.
IndicesUpgradeRequest configures the Indices Upgrade API request.
IndicesValidateQueryRequest configures the Indices Validate Query API request.
InfoRequest configures the Info API request.
Ingest contains the Ingest APIs.
IngestDeletePipelineRequest configures the Ingest Delete Pipeline API request.
IngestGetPipelineRequest configures the Ingest Get Pipeline API request.
IngestProcessorGrokRequest configures the Ingest Processor Grok API request.
IngestPutPipelineRequest configures the Ingest Put Pipeline API request.
IngestSimulateRequest configures the Ingest Simulate API request.
MgetRequest configures the Mget API request.
MpercolateRequest configures the Mpercolate API request.
MsearchRequest configures the Msearch API request.
MsearchTemplateRequest configures the Msearch Template API request.
MtermvectorsRequest configures the Mtermvectors API request.
Nodes contains the Nodes APIs.
NodesHotThreadsRequest configures the Nodes Hot Threads API request.
NodesInfoRequest configures the Nodes Info API request.
NodesReloadSecureSettingsRequest configures the Nodes Reload Secure Settings API request.
NodesStatsRequest configures the Nodes Stats API request.
NodesUsageRequest configures the Nodes Usage API request.
PercolateRequest configures the Percolate API request.
PingRequest configures the Ping API request.
PutScriptRequest configures the Put Script API request.
PutTemplateRequest configures the Put Template API request.
RankEvalRequest configures the Rank Eval API request.
ReindexRequest configures the Reindex API request.
ReindexRethrottleRequest configures the Reindex Rethrottle API request.
Remote contains the Remote APIs.
RenderSearchTemplateRequest configures the Render Search Template API request.
Response represents the API response.
ScriptsPainlessExecuteRequest configures the Scripts Painless Execute API request.
ScrollRequest configures the Scroll API request.
SearchRequest configures the Search API request.
SearchShardsRequest configures the Search Shards API request.
SearchTemplateRequest configures the Search Template API request.
Snapshot contains the Snapshot APIs.
SnapshotCreateRepositoryRequest configures the Snapshot Create Repository API request.
SnapshotCreateRequest configures the Snapshot Create API request.
SnapshotDeleteRepositoryRequest configures the Snapshot Delete Repository API request.
SnapshotDeleteRequest configures the Snapshot Delete API request.
SnapshotGetRepositoryRequest configures the Snapshot Get Repository API request.
SnapshotGetRequest configures the Snapshot Get API request.
SnapshotRestoreRequest configures the Snapshot Restore API request.
SnapshotStatusRequest configures the Snapshot Status API request.
SnapshotVerifyRepositoryRequest configures the Snapshot Verify Repository API request.
SuggestRequest configures the Suggest API request.
Tasks contains the Tasks APIs.
TasksCancelRequest configures the Tasks Cancel API request.
TasksGetRequest configures the Tasks Get API request.
TasksListRequest configures the Tasks List API request.
TermvectorsRequest configures the Termvectors API request.
UpdateByQueryRequest configures the Update By Query API request.
UpdateByQueryRethrottleRequest configures the Update By Query Rethrottle API request.
UpdateRequest configures the Update API request.
# Type aliases
Bulk allows to perform multiple index/update/delete operations in a single request.
CatAliases shows information about currently configured aliases to indices including filter and routing infos.
CatAllocation provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
CatCount provides quick access to the document count of the entire cluster, or individual indices.
CatFielddata shows how much heap memory is currently being used by fielddata on every data node in the cluster.
CatHealth returns a concise representation of the cluster health.
CatHelp returns help for the Cat APIs.
CatIndices returns information about indices: number of primaries and replicas, document counts, disk size, ..
CatMaster returns information about the master node.
CatNodeattrs returns information about custom node attributes.
CatNodes returns basic statistics about performance of cluster nodes.
CatPendingTasks returns a concise representation of the cluster pending tasks.
CatPlugins returns information about installed plugins across nodes node.
CatRecovery returns information about index shard recoveries, both on-going completed.
CatRepositories returns information about snapshot repositories registered in the cluster.
CatSegments provides low-level information about the segments in the shards of an index.
CatShards provides a detailed view of shard allocation on nodes.
CatSnapshots returns all snapshots in a specific repository.
CatTasks returns information about the tasks currently executing on one or more nodes in the cluster.
CatTemplates returns information about existing templates.
CatThreadPool returns cluster-wide thread pool statistics per node.
ClearScroll explicitly clears the search context for a scroll.
ClusterAllocationExplain provides explanations for shard allocations in the cluster.
ClusterGetSettings returns cluster settings.
ClusterHealth returns basic information about the health of the cluster.
ClusterPendingTasks returns a list of any cluster-level changes (e.g.
ClusterPutSettings updates the cluster settings.
ClusterRemoteInfo returns the information about configured remote clusters.
ClusterReroute allows to manually change the allocation of individual shards in the cluster.
ClusterState returns a comprehensive information about the state of the cluster.
ClusterStats returns high-level overview of cluster statistics.
Count returns number of documents matching a query.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html.
Create creates a new document in the index.
Delete removes a document from the index.
DeleteByQuery deletes documents matching the provided query.
DeleteByQueryRethrottle changes the number of requests per second for a particular Delete By Query operation.
DeleteScript deletes a script.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html.
Exists returns information about whether a document exists in an index.
ExistsSource returns information about whether a document source exists in an index.
Explain returns information about why a specific matches (or doesn't match) a query.
FieldCaps returns the information about the capabilities of fields among multiple indices.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html.
Get returns a document.
GetScript returns a script.
GetSource returns the source of a document.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html.
Index creates or updates a document in an index.
IndicesAnalyze performs the analysis process on a text and return the tokens breakdown of the text.
IndicesClearCache clears all or specific caches for one or more indices.
IndicesClose closes an index.
IndicesCreate creates an index with optional settings and mappings.
IndicesDelete deletes an index.
IndicesDeleteAlias deletes an alias.
IndicesDeleteTemplate deletes an index template.
IndicesExists returns information about whether a particular index exists.
IndicesExistsAlias returns information about whether a particular alias exists.
IndicesExistsDocumentType returns information about whether a particular document type exists.
IndicesExistsTemplate returns information about whether a particular index template exists.
IndicesFlush performs the flush operation on one or more indices.
IndicesFlushSynced performs a synced flush operation on one or more indices.
IndicesForcemerge performs the force merge operation on one or more indices.
IndicesGet returns information about one or more indices.
IndicesGetAlias returns an alias.
IndicesGetFieldMapping returns mapping for one or more fields.
IndicesGetMapping returns mappings for one or more indices.
IndicesGetSettings returns settings for one or more indices.
IndicesGetTemplate returns an index template.
IndicesGetUpgrade the _upgrade API is no longer useful and will be removed.
IndicesOpen opens an index.
IndicesPutAlias creates or updates an alias.
IndicesPutMapping updates the index mappings.
IndicesPutSettings updates the index settings.
IndicesPutTemplate creates or updates an index template.
IndicesRecovery returns information about ongoing index shard recoveries.
IndicesRefresh performs the refresh operation in one or more indices.
IndicesRollover updates an alias to point to a new index when the existing index is considered to be too large or too old.
IndicesSegments provides low-level information about segments in a Lucene index.
IndicesShardStores provides store information for shard copies of indices.
IndicesShrink allow to shrink an existing index into a new index with fewer primary shards.
IndicesSplit allows you to split an existing index into a new index with more primary shards.
IndicesStats provides statistics on operations happening in an index.
IndicesUpdateAliases updates index aliases.
IndicesUpgrade the _upgrade API is no longer useful and will be removed.
IndicesValidateQuery allows a user to validate a potentially expensive query without executing it.
Info returns basic information about the cluster.
IngestDeletePipeline deletes a pipeline.
IngestGetPipeline returns a pipeline.
IngestProcessorGrok returns a list of the built-in patterns.
IngestPutPipeline creates or updates a pipeline.
IngestSimulate allows to simulate a pipeline with example documents.
Mget allows to get multiple documents in one request.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html.
Msearch allows to execute several search operations in one request.
MsearchTemplate allows to execute several search template operations in one request.
Mtermvectors returns multiple termvectors in one request.
NodesHotThreads returns information about hot threads on each node in the cluster.
NodesInfo returns information about nodes in the cluster.
NodesReloadSecureSettings reloads secure settings.
NodesStats returns statistical information about nodes in the cluster.
NodesUsage returns low-level information about REST actions usage on nodes.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html.
Ping returns whether the cluster is running.
PutScript creates or updates a script.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html.
RankEval allows to evaluate the quality of ranked search results over a set of typical search queries
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html.
Reindex allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
ReindexRethrottle changes the number of requests per second for a particular Reindex operation.
RenderSearchTemplate allows to use the Mustache language to pre-render a search definition.
ScriptsPainlessExecute allows an arbitrary script to be executed and a result to be returned
See full documentation at https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html.
Scroll allows to retrieve a large numbers of results from a single search request.
Search returns results matching a query.
SearchShards returns information about the indices and shards that a search request would be executed against.
SearchTemplate allows to use the Mustache language to pre-render a search definition.
SnapshotCreate creates a snapshot in a repository.
SnapshotCreateRepository creates a repository.
SnapshotDelete deletes a snapshot.
SnapshotDeleteRepository deletes a repository.
SnapshotGet returns information about a snapshot.
SnapshotGetRepository returns information about a repository.
SnapshotRestore restores a snapshot.
SnapshotStatus returns information about the status of a snapshot.
SnapshotVerifyRepository verifies a repository.
See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html.
TasksCancel cancels a task, if it can be cancelled through an API.
TasksGet returns information about a task.
TasksList returns a list of tasks.
Termvectors returns information and statistics about terms in the fields of a particular document.
Update updates a document with a script or partial document.
UpdateByQuery performs an update on every document in the index without changing the source, for example to pick up a mapping change.
UpdateByQueryRethrottle changes the number of requests per second for a particular Update By Query operation.