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 @@ -522,6 +522,17 @@ public CompletableFuture<HelpResponse> 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 @@ -559,6 +570,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 @@ -597,6 +619,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 @@ -525,6 +525,17 @@ public HelpResponse 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 @@ -562,6 +573,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 @@ -600,6 +622,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
Original file line number Diff line number Diff line change
Expand Up @@ -197,8 +197,9 @@ public final Long primaryTerm() {
}

/**
* The result of the operation. Successful values are <code>created</code>,
* <code>deleted</code>, and <code>updated</code>.
* The result of the operation. Possible values are <code>created</code>,
* <code>updated</code>, <code>deleted</code>, <code>noop</code>, and
* <code>not_found</code>.
* <p>
* API name: {@code result}
*/
Expand Down Expand Up @@ -475,8 +476,9 @@ public final Builder primaryTerm(@Nullable Long value) {
}

/**
* The result of the operation. Successful values are <code>created</code>,
* <code>deleted</code>, and <code>updated</code>.
* The result of the operation. Possible values are <code>created</code>,
* <code>updated</code>, <code>deleted</code>, <code>noop</code>, and
* <code>not_found</code>.
* <p>
* API name: {@code result}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1137,7 +1137,7 @@
'cat.help.Request': 'cat/help/CatHelpRequest.ts#L22-L39',
'cat.help.Response': 'cat/help/CatHelpResponse.ts#L20-L25',
'cat.indices.IndicesRecord': 'cat/indices/types.ts#L20-L808',
'cat.indices.Request': 'cat/indices/CatIndicesRequest.ts#L30-L107',
'cat.indices.Request': 'cat/indices/CatIndicesRequest.ts#L30-L111',
'cat.indices.Response': 'cat/indices/CatIndicesResponse.ts#L22-L25',
'cat.master.MasterRecord': 'cat/master/types.ts#L20-L39',
'cat.master.Request': 'cat/master/CatMasterRequest.ts#L24-L69',
Expand Down Expand Up @@ -2812,42 +2812,42 @@
'security._types.ApiKey': 'security/_types/ApiKey.ts#L27-L113',
'security._types.ApiKeyManagedBy': 'security/_types/ApiKey.ts#L120-L123',
'security._types.ApiKeyType': 'security/_types/ApiKey.ts#L115-L118',
'security._types.ApplicationGlobalUserPrivileges': 'security/_types/Privileges.ts#L436-L438',
'security._types.ApplicationPrivileges': 'security/_types/Privileges.ts#L27-L40',
'security._types.ApplicationGlobalUserPrivileges': 'security/_types/Privileges.ts#L400-L402',
'security._types.ApplicationPrivileges': 'security/_types/Privileges.ts#L28-L41',
'security._types.BulkError': 'security/_types/Bulk.ts#L24-L33',
'security._types.ClusterNode': 'security/_types/ClusterNode.ts#L22-L24',
'security._types.ClusterPrivilege': 'security/_types/Privileges.ts#L42-L201',
'security._types.ClusterPrivilege': 'security/_types/Privileges.ts#L43-L202',
'security._types.CreatedStatus': 'security/_types/CreatedStatus.ts#L20-L22',
'security._types.FieldSecurity': 'security/_types/FieldSecurity.ts#L22-L25',
'security._types.GlobalPrivilege': 'security/_types/Privileges.ts#L432-L434',
'security._types.GlobalPrivilege': 'security/_types/Privileges.ts#L396-L398',
'security._types.GrantType': 'security/_types/GrantType.ts#L20-L30',
'security._types.IndexPrivilege': 'security/_types/Privileges.ts#L388-L430',
'security._types.IndicesPrivileges': 'security/_types/Privileges.ts#L218-L244',
'security._types.IndicesPrivilegesQuery': 'security/_types/Privileges.ts#L343-L351',
'security._types.ManageUserPrivileges': 'security/_types/Privileges.ts#L440-L442',
'security._types.IndexPrivilege': 'security/_types/Privileges.ts#L352-L394',
'security._types.IndicesPrivileges': 'security/_types/Privileges.ts#L246-L246',
'security._types.IndicesPrivilegesQuery': 'security/_types/Privileges.ts#L307-L315',
'security._types.ManageUserPrivileges': 'security/_types/Privileges.ts#L404-L406',
'security._types.NodeSecurityStats': 'security/_types/NodeSecurityStats.ts#L22-L27',
'security._types.RealmInfo': 'security/_types/RealmInfo.ts#L22-L25',
'security._types.RemoteClusterPrivilege': 'security/_types/Privileges.ts#L203-L215',
'security._types.RemoteClusterPrivileges': 'security/_types/Privileges.ts#L280-L292',
'security._types.RemoteIndicesPrivileges': 'security/_types/Privileges.ts#L246-L278',
'security._types.RemoteUserIndicesPrivileges': 'security/_types/Privileges.ts#L318-L341',
'security._types.ReplicationAccess': 'security/_types/Privileges.ts#L444-L454',
'security._types.RemoteClusterPrivilege': 'security/_types/Privileges.ts#L204-L216',
'security._types.RemoteClusterPrivileges': 'security/_types/Privileges.ts#L260-L272',
'security._types.RemoteIndicesPrivileges': 'security/_types/Privileges.ts#L248-L258',
'security._types.RemoteUserIndicesPrivileges': 'security/_types/Privileges.ts#L301-L305',
'security._types.ReplicationAccess': 'security/_types/Privileges.ts#L408-L418',
'security._types.Restriction': 'security/_types/RoleDescriptor.ts#L90-L96',
'security._types.RestrictionWorkflow': 'security/_types/RoleDescriptor.ts#L98-L101',
'security._types.RoleDescriptor': 'security/_types/RoleDescriptor.ts#L33-L83',
'security._types.RoleDescriptorRead': 'security/_types/RoleDescriptor.ts#L85-L88',
'security._types.RoleMapping': 'security/_types/RoleMapping.ts#L25-L33',
'security._types.RoleMappingRule': 'security/_types/RoleMappingRule.ts#L23-L31',
'security._types.RoleTemplate': 'security/_types/RoleTemplate.ts#L28-L31',
'security._types.RoleTemplateInlineQuery': 'security/_types/Privileges.ts#L385-L386',
'security._types.RoleTemplateQuery': 'security/_types/Privileges.ts#L353-L363',
'security._types.RoleTemplateScript': 'security/_types/Privileges.ts#L365-L383',
'security._types.RoleTemplateInlineQuery': 'security/_types/Privileges.ts#L349-L350',
'security._types.RoleTemplateQuery': 'security/_types/Privileges.ts#L317-L327',
'security._types.RoleTemplateScript': 'security/_types/Privileges.ts#L329-L347',
'security._types.RolesStats': 'security/_types/NodeSecurityStats.ts#L29-L34',
'security._types.SearchAccess': 'security/_types/Privileges.ts#L456-L476',
'security._types.SearchAccess': 'security/_types/Privileges.ts#L420-L440',
'security._types.SecuritySettings': 'security/_types/SecuritySettings.ts#L22-L24',
'security._types.TemplateFormat': 'security/_types/RoleTemplate.ts#L22-L25',
'security._types.User': 'security/_types/User.ts#L23-L31',
'security._types.UserIndicesPrivileges': 'security/_types/Privileges.ts#L294-L316',
'security._types.UserIndicesPrivileges': 'security/_types/Privileges.ts#L298-L299',
'security._types.UserProfile': 'security/_types/UserProfile.ts#L41-L47',
'security._types.UserProfileHitMetadata': 'security/_types/UserProfile.ts#L27-L30',
'security._types.UserProfileUser': 'security/_types/UserProfile.ts#L32-L39',
Expand Down Expand Up @@ -3197,10 +3197,10 @@
'transform._types.PivotGroupByContainer': 'transform/_types/Transform.ts#L70-L78',
'transform._types.RetentionPolicy': 'transform/_types/Transform.ts#L88-L96',
'transform._types.RetentionPolicyContainer': 'transform/_types/Transform.ts#L80-L86',
'transform._types.Settings': 'transform/_types/Transform.ts#L98-L154',
'transform._types.Source': 'transform/_types/Transform.ts#L156-L175',
'transform._types.SyncContainer': 'transform/_types/Transform.ts#L179-L185',
'transform._types.TimeSync': 'transform/_types/Transform.ts#L187-L199',
'transform._types.Settings': 'transform/_types/Transform.ts#L98-L166',
'transform._types.Source': 'transform/_types/Transform.ts#L168-L187',
'transform._types.SyncContainer': 'transform/_types/Transform.ts#L191-L197',
'transform._types.TimeSync': 'transform/_types/Transform.ts#L199-L211',
'transform.delete_transform.Request': 'transform/delete_transform/DeleteTransformRequest.ts#L24-L66',
'transform.delete_transform.Response': 'transform/delete_transform/DeleteTransformResponse.ts#L22-L25',
'transform.get_node_stats.Request': 'transform/get_node_stats/GetNodeStatsRequest.ts#L23-L40',
Expand Down Expand Up @@ -3442,10 +3442,10 @@
if (hash.length > 1) {
hash = hash.substring(1);
}
window.location = "https://github.com/elastic/elasticsearch-specification/tree/58d568d71a372deb7872cb34e82f0a2631d52bb3/specification/" + (paths[hash] || "");
window.location = "https://github.com/elastic/elasticsearch-specification/tree/49022a2c08d291955de83e26c583b7dc628fb558/specification/" + (paths[hash] || "");
</script>
</head>
<body>
Please see the <a href="https://github.com/elastic/elasticsearch-specification/tree/58d568d71a372deb7872cb34e82f0a2631d52bb3/specification/">Elasticsearch API specification</a>.
Please see the <a href="https://github.com/elastic/elasticsearch-specification/tree/49022a2c08d291955de83e26c583b7dc628fb558/specification/">Elasticsearch API specification</a>.
</body>
</html>
Loading
Loading