Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -45,48 +45,123 @@
*/
@JsonpDeserializable
public enum CommonStatsFlag implements JsonEnum {
/**
* Return all statistics.
*/
All("_all"),

/**
* Size of the index in byte units.
*/
Store("store"),

/**
* Indexing statistics.
*/
Indexing("indexing"),

/**
* Get statistics, including missing stats.
*/
Get("get"),

/**
* Search statistics including suggest statistics. You can include statistics
* for custom groups by adding an extra <code>groups</code> parameter (search
* operations can be associated with one or more groups). The
* <code>groups</code> parameter accepts a comma-separated list of group names.
* Use <code>_all</code> to return statistics for all groups.
*/
Search("search"),

/**
* Merge statistics.
*/
Merge("merge"),

/**
* Flush statistics.
*/
Flush("flush"),

/**
* Refresh statistics.
*/
Refresh("refresh"),

/**
* Query cache statistics.
*/
QueryCache("query_cache"),

/**
* Fielddata statistics.
*/
Fielddata("fielddata"),

/**
* Number of documents and deleted docs not yet merged out. Index refreshes can
* affect this statistic.
*/
Docs("docs"),

/**
* Index warming statistics.
*/
Warmer("warmer"),

/**
* Completion suggester statistics.
*/
Completion("completion"),

/**
* Memory use of all open segments. If the
* <code>include_segment_file_sizes</code> parameter is <code>true</code>, this
* metric includes the aggregated disk usage of each Lucene index file.
*/
Segments("segments"),

/**
* Translog statistics.
*/
Translog("translog"),

/**
* Shard request cache statistics.
*/
RequestCache("request_cache"),

/**
* Recovery statistics.
*/
Recovery("recovery"),

/**
* Bulk operations statistics.
*/
Bulk("bulk"),

/**
* Shard statistics, including the total number of shards.
*/
ShardStats("shard_stats"),

/**
* Mapping statistics, including the total count and estimated overhead.
*/
Mappings("mappings"),

/**
* Total number of dense vectors indexed. Index refreshes can affect this
* statistic.
*/
DenseVector("dense_vector"),

/**
* Total number of sparse vectors indexed. Index refreshes can affect this
* statistic.
*/
SparseVector("sparse_vector"),

;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,29 @@
*/
@JsonpDeserializable
public enum ThreadType implements JsonEnum {
/**
* Threads that consume the most CPU time.
*/
Cpu("cpu"),

/**
* Threads that have been in a waiting state the longest.
*/
Wait("wait"),

/**
* Threads that have been blocked the longest.
*/
Block("block"),

/**
* Threads that consume the most GPU time.
*/
Gpu("gpu"),

/**
* Threads that allocate the most memory.
*/
Mem("mem"),

;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@
* 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.
* <p>
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
* <code>POST</code> method. This is primarily intended for project routing in
* serverless environments.
*
* @see <a href="../doc-files/api-spec.html#cat.count.Request">API
* specification</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,10 @@ public CompletableFuture<ComponentTemplatesResponse> componentTemplates() {
* 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.
* <p>
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
* <code>POST</code> method. This is primarily intended for project routing in
* serverless environments.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count">Documentation
Expand All @@ -301,6 +305,10 @@ public CompletableFuture<CountResponse> count(CountRequest request) {
* 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.
* <p>
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
* <code>POST</code> method. This is primarily intended for project routing in
* serverless environments.
*
* @param fn
* a function that initializes a builder to create the
Expand All @@ -325,6 +333,10 @@ public final CompletableFuture<CountResponse> count(
* 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.
* <p>
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
* <code>POST</code> method. This is primarily intended for project routing in
* serverless environments.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count">Documentation
Expand Down Expand Up @@ -523,6 +535,17 @@ public CompletableFuture<TextResponse> help() {
* include hidden nested documents. To get an accurate count of Elasticsearch
* documents, use the cat count or count APIs.
* <p>
* NOTE: Storage metrics reported by this API reflect the post-compression size
* of the indices on disk. Because these values are calculated after
* Elasticsearch compresses the data and processes deletions, they are typically
* significantly smaller than the raw, uncompressed data volume ingested.
* <p>
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
* uncompressed data volume, not the post-compression metrics reported here. To
* learn more, refer to <a href=
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
* billing dimensions</a>.
* <p>
* 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.
Expand Down Expand Up @@ -560,6 +583,17 @@ public CompletableFuture<IndicesResponse> indices(IndicesRequest request) {
* include hidden nested documents. To get an accurate count of Elasticsearch
* documents, use the cat count or count APIs.
* <p>
* NOTE: Storage metrics reported by this API reflect the post-compression size
* of the indices on disk. Because these values are calculated after
* Elasticsearch compresses the data and processes deletions, they are typically
* significantly smaller than the raw, uncompressed data volume ingested.
* <p>
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
* uncompressed data volume, not the post-compression metrics reported here. To
* learn more, refer to <a href=
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
* billing dimensions</a>.
* <p>
* 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.
Expand Down Expand Up @@ -598,6 +632,17 @@ public final CompletableFuture<IndicesResponse> indices(
* include hidden nested documents. To get an accurate count of Elasticsearch
* documents, use the cat count or count APIs.
* <p>
* NOTE: Storage metrics reported by this API reflect the post-compression size
* of the indices on disk. Because these values are calculated after
* Elasticsearch compresses the data and processes deletions, they are typically
* significantly smaller than the raw, uncompressed data volume ingested.
* <p>
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
* uncompressed data volume, not the post-compression metrics reported here. To
* learn more, refer to <a href=
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
* billing dimensions</a>.
* <p>
* 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,10 @@ public ComponentTemplatesResponse componentTemplates() throws IOException, Elast
* 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.
* <p>
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
* <code>POST</code> method. This is primarily intended for project routing in
* serverless environments.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count">Documentation
Expand All @@ -304,6 +308,10 @@ public CountResponse count(CountRequest request) throws IOException, Elasticsear
* 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.
* <p>
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
* <code>POST</code> method. This is primarily intended for project routing in
* serverless environments.
*
* @param fn
* a function that initializes a builder to create the
Expand All @@ -328,6 +336,10 @@ public final CountResponse count(Function<CountRequest.Builder, ObjectBuilder<Co
* 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.
* <p>
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
* <code>POST</code> method. This is primarily intended for project routing in
* serverless environments.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count">Documentation
Expand Down Expand Up @@ -526,6 +538,17 @@ public TextResponse help() throws IOException, ElasticsearchException {
* include hidden nested documents. To get an accurate count of Elasticsearch
* documents, use the cat count or count APIs.
* <p>
* NOTE: Storage metrics reported by this API reflect the post-compression size
* of the indices on disk. Because these values are calculated after
* Elasticsearch compresses the data and processes deletions, they are typically
* significantly smaller than the raw, uncompressed data volume ingested.
* <p>
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
* uncompressed data volume, not the post-compression metrics reported here. To
* learn more, refer to <a href=
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
* billing dimensions</a>.
* <p>
* 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.
Expand Down Expand Up @@ -563,6 +586,17 @@ public IndicesResponse indices(IndicesRequest request) throws IOException, Elast
* include hidden nested documents. To get an accurate count of Elasticsearch
* documents, use the cat count or count APIs.
* <p>
* NOTE: Storage metrics reported by this API reflect the post-compression size
* of the indices on disk. Because these values are calculated after
* Elasticsearch compresses the data and processes deletions, they are typically
* significantly smaller than the raw, uncompressed data volume ingested.
* <p>
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
* uncompressed data volume, not the post-compression metrics reported here. To
* learn more, refer to <a href=
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
* billing dimensions</a>.
* <p>
* 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.
Expand Down Expand Up @@ -601,6 +635,17 @@ public final IndicesResponse indices(Function<IndicesRequest.Builder, ObjectBuil
* include hidden nested documents. To get an accurate count of Elasticsearch
* documents, use the cat count or count APIs.
* <p>
* NOTE: Storage metrics reported by this API reflect the post-compression size
* of the indices on disk. Because these values are calculated after
* Elasticsearch compresses the data and processes deletions, they are typically
* significantly smaller than the raw, uncompressed data volume ingested.
* <p>
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
* uncompressed data volume, not the post-compression metrics reported here. To
* learn more, refer to <a href=
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
* billing dimensions</a>.
* <p>
* 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,17 @@
* include hidden nested documents. To get an accurate count of Elasticsearch
* documents, use the cat count or count APIs.
* <p>
* NOTE: Storage metrics reported by this API reflect the post-compression size
* of the indices on disk. Because these values are calculated after
* Elasticsearch compresses the data and processes deletions, they are typically
* significantly smaller than the raw, uncompressed data volume ingested.
* <p>
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
* uncompressed data volume, not the post-compression metrics reported here. To
* learn more, refer to <a href=
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
* billing dimensions</a>.
* <p>
* 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.
Expand Down
Loading
Loading