OpenSearch/docs/reference/redirects.asciidoc

879 lines
20 KiB
Plaintext
Raw Normal View History

["appendix",role="exclude",id="redirects"]
= Deleted pages
The following pages have moved or been deleted.
[role="exclude",id="indices-upgrade"]
=== Upgrade API
The `_upgrade` API is no longer useful and will be removed. Instead, see
<<reindex-upgrade>>.
[role="exclude",id="mapping-parent-field"]
=== `_parent` field
The `_parent` field has been removed in favour of the <<parent-join,`join` field>>.
[role="exclude",id="indices-warmers"]
=== Warmers
Warmers have been removed. There have been significant improvements to the
index that make warmers not necessary anymore.
[role="exclude",id="xpack-commands"]
=== X-Pack commands
See <<commands>>.
[role="exclude",id="xpack-api"]
=== X-Pack APIs
{es} {xpack} APIs are now documented in <<rest-apis, REST APIs>>.
[role="exclude",id="ml-calendar-resource"]]
=== Calendar resources
See <<ml-get-calendar>> and
{ml-docs}/ml-calendars.html[Calendars and scheduled events].
[role="exclude",id="ml-filter-resource"]
=== Filter resources
See <<ml-get-filter>> and
{ml-docs}/ml-rules.html[Machine learning custom rules].
[role="exclude",id="ml-event-resource"]
=== Scheduled event resources
See <<ml-get-calendar-event>> and
{ml-docs}/ml-calendars.html[Calendars and scheduled events].
[role="exclude",id="index-apis"]
=== Index APIs
{es} index APIs are now documented in <<indices>>.
[role="exclude",id="search-request-docvalue-fields"]
=== Doc value fields parameter for request body search API
See <<request-body-search-docvalue-fields>>.
[role="exclude",id="search-request-explain"]
=== Explain parameter for request body search API
See <<request-body-search-explain>>.
[role="exclude",id="search-request-collapse"]
=== Collapse parameter for request body search API
See <<request-body-search-collapse>>.
[role="exclude",id="search-request-from-size"]
=== From and size parameters for request body search API
See <<request-body-search-from-size>>.
[role="exclude",id="search-request-highlighting"]
=== Highlight parameter for request body search API
See <<request-body-search-highlighting>>.
[role="exclude",id="search-request-index-boost"]
=== Index boost parameter for request body search API
See <<request-body-search-index-boost>>.
[role="exclude",id="search-request-inner-hits"]
=== Inner hits parameter for request body search API
See <<request-body-search-inner-hits>>.
[role="exclude",id="search-request-min-score"]
=== Minimum score parameter for request body search API
See <<request-body-search-min-score>>.
[role="exclude",id="search-request-named-queries-and-filters"]
=== Named query parameter for request body search API
See <<request-body-search-queries-and-filters>>.
[role="exclude",id="search-request-post-filter"]
=== Post filter parameter for request body search API
See <<request-body-search-post-filter>>.
[role="exclude",id="search-request-preference"]
=== Preference parameter for request body search API
See <<request-body-search-preference>>.
[role="exclude",id="search-request-query"]
=== Query parameter for request body search API
See <<request-body-search-query>>.
[role="exclude",id="search-request-rescore"]
=== Rescoring parameter for request body search API
See <<request-body-search-rescore>>.
[role="exclude",id="search-request-script-fields"]
=== Script fields parameter for request body search API
See <<request-body-search-script-fields>>.
[role="exclude",id="search-request-scroll"]
=== Scroll parameter for request body search API
See <<request-body-search-scroll>>.
[role="exclude",id="search-request-search-after"]
=== Search after parameter for request body search API
See <<request-body-search-search-after>>.
[role="exclude",id="search-request-search-type"]
=== Search type parameter for request body search API
See <<request-body-search-search-type>>.
[role="exclude",id="search-request-seq-no-primary-term"]
=== Sequence numbers and primary terms parameter for request body search API
See <<request-body-search-search-type>>.
[role="exclude",id="search-request-sort"]
=== Sort parameter for request body search API
See <<request-body-search-sort>>.
[role="exclude",id="search-request-source-filtering"]
=== Source filtering parameter for request body search API
See <<request-body-search-source-filtering>>.
[role="exclude",id="search-request-stored-fields"]
=== Stored fields parameter for request body search API
See <<request-body-search-stored-fields>>.
[role="exclude",id="search-request-track-total-hits"]
=== Track total hits parameter for request body search API
See <<request-body-search-track-total-hits>>.
[role="exclude",id="search-request-version"]
=== Version parameter for request body search API
See <<request-body-search-version>>.
[role="exclude",id="search-suggesters-term"]
=== Term suggester
See <<term-suggester>>.
[role="exclude",id="search-suggesters-phrase"]
=== Phrase suggester
See <<phrase-suggester>>.
[role="exclude",id="search-suggesters-completion"]
=== Completion suggester
See <<completion-suggester>>.
[role="exclude",id="suggester-context"]
=== Context suggester
See <<context-suggester>>.
[role="exclude",id="returning-suggesters-type"]
=== Return suggester type
See <<return-suggesters-type>>.
[role="exclude",id="search-profile-queries"]
=== Profiling queries
See <<profiling-queries>>.
[role="exclude",id="search-profile-aggregations"]
=== Profiling aggregations
See <<profiling-aggregations>>.
[role="exclude",id="search-profile-considerations"]
=== Profiling considerations
See <<profiling-considerations>>.
[role="exclude",id="_explain_analyze"]
=== Explain analyze API
See <<explain-analyze-api>>.
[role="exclude",id="indices-synced-flush"]
=== Synced flush API
See <<indices-synced-flush-api>>.
[role="exclude",id="_repositories"]
=== Snapshot repositories
See <<snapshots-repositories>>.
[role="exclude",id="_snapshot"]
=== Snapshot
See <<snapshots-take-snapshot>>.
[role="exclude",id="getting-started-explore"]
=== Exploring your cluster
See <<cat>>.
[role="exclude",id="getting-started-cluster-health"]
=== Cluster health
See <<cat-health>>.
[role="exclude", id="getting-started-list-indices"]
=== List all indices
See <<cat-indices>>.
[role="exclude", id="getting-started-create-index"]
=== Create an index
See <<indices-create-index>>.
[role="exclude", id="getting-started-query-document"]
=== Index and query a document
See <<getting-started-index>>.
[role="exclude", id="getting-started-delete-index"]
=== Delete an index
See <<indices-delete-index>>.
[role="exclude", id="getting-started-modify-data"]
== Modifying your data
See <<docs-update>>.
[role="exclude", id="indexing-replacing-documents"]
=== Indexing/replacing documents
See <<docs-index_>>.
[role="exclude", id="getting-started-explore-data"]
=== Exploring your data
See <<getting-started-search>>.
[role="exclude", id="getting-started-search-API"]
=== Search API
See <<getting-started-search>>.
[role="exclude", id="getting-started-conclusion"]
=== Conclusion
See <<getting-started-next-steps>>.
[role="exclude",id="ccs-reduction"]
=== {ccs-cap} reduction
See <<ccs-works>>.
[role="exclude",id="administer-elasticsearch"]
=== Administering {es}
See <<high-availability>>.
[role="exclude",id="slm-api"]
=== Snapshot lifecycle management API
See <<snapshot-lifecycle-management-api>>.
[role="exclude",id="delete-data-frame-transform"]
=== Delete {transforms} API
See <<delete-transform>>.
[role="exclude",id="get-data-frame-transform-stats"]
=== Get {transform} statistics API
See <<get-transform-stats>>.
[role="exclude",id="get-data-frame-transform"]
=== Get {transforms} API
See <<get-transform>>.
[role="exclude",id="preview-data-frame-transform"]
=== Preview {transforms} API
See <<preview-transform>>.
[role="exclude",id="put-data-frame-transform"]
=== Create {transforms} API
See <<put-transform>>.
[role="exclude",id="start-data-frame-transform"]
=== Start {transforms} API
See <<start-transform>>.
[role="exclude",id="stop-data-frame-transform"]
=== Stop {transforms} API
See <<stop-transform>>.
[role="exclude",id="update-data-frame-transform"]
=== Update {transforms} API
See <<update-transform>>.
[role="exclude",id="data-frame-apis"]
=== {transform-cap} APIs
See <<transform-apis>>.
[role="exclude",id="data-frame-transform-resource"]
=== {transform-cap} resources
See <<transform-resource>>.
[role="exclude",id="data-frame-transform-dest"]
=== Dest objects
See <<transform-resource>>.
[role="exclude",id="data-frame-transform-source"]
==== Source objects
See <<transform-resource>>.
[role="exclude",id="data-frame-transform-pivot"]
==== Pivot objects
See <<transform-resource>>.
[role="exclude",id="configuring-monitoring"]
=== Configuring monitoring
See <<monitoring-overview>>.
[role="exclude",id="es-monitoring"]
=== Monitoring {es}
See <<monitor-elasticsearch-cluster>>.
[role="exclude",id="docker-cli-run"]
=== Docker Run
See <<docker-cli-run-dev-mode>>.
[role="exclude",id="auditing"]
=== Audit logging
See <<enable-audit-logging>>.
[role="exclude",id="analysis-compound-word-tokenfilter"]
=== Compound word token filters
See <<analysis-dict-decomp-tokenfilter>> and
<<analysis-hyp-decomp-tokenfilter>>.
[role="exclude",id="configuring-native-realm"]
=== Configuring a native realm
See <<native-realm-configuration>>.
[role="exclude",id="native-settings"]
==== Native realm settings
See <<ref-native-settings>>.
[role="exclude",id="configuring-saml-realm"]
=== Configuring a SAML realm
See <<saml-guide>>.
[role="exclude",id="saml-settings"]
==== SAML realm settings
See <<ref-saml-settings>>.
[role="exclude",id="_saml_realm_signing_settings"]
==== SAML realm signing settings
See <<ref-saml-signing-settings>>.
[role="exclude",id="_saml_realm_encryption_settings"]
==== SAML realm encryption settings
See <<ref-saml-encryption-settings>>.
[role="exclude",id="_saml_realm_ssl_settings"]
==== SAML realm SSL settings
See <<ref-saml-ssl-settings>>.
[role="exclude",id="configuring-file-realm"]
=== Configuring a file realm
See <<file-realm-configuration>>.
[role="exclude",id="ldap-user-search"]
=== User search mode and user DN templates mode
See <<ldap-realm-configuration>>.
[role="exclude",id="configuring-ldap-realm"]
=== Configuring an LDAP realm
See <<ldap-realm-configuration>>.
[role="exclude",id="ldap-settings"]
=== LDAP realm settings
See <<ref-ldap-settings>>.
[role="exclude",id="ldap-ssl"]
=== Setting up SSL between Elasticsearch and LDAP
See <<tls-ldap>>.
[role="exclude",id="configuring-kerberos-realm"]
=== Configuring a Kerberos realm
See <<kerberos-realm-configuration>>.
[role="exclude",id="beats"]
=== Beats and Security
See:
* {auditbeat-ref}/securing-auditbeat.html[{auditbeat}]
* {filebeat-ref}/securing-filebeat.html[{filebeat}]
* {heartbeat-ref}/securing-heartbeat.html[{heartbeat}]
* {metricbeat-ref}/securing-metricbeat.html[{metricbeat}]
* {packetbeat-ref}/securing-packetbeat.html[{packetbeat}]
* {winlogbeat-ref}/securing-winlogbeat.html[{winlogbeat}]
[role="exclude",id="configuring-pki-realm"]
=== Configuring a PKI realm
See <<pki-realm>>.
[role="exclude",id="pki-settings"]
==== PKI realm settings
See <<ref-pki-settings>>.
[role="exclude",id="configuring-ad-realm"]
=== Configuring an Active Directory realm
See <<ad-realm-configuration>>.
[role="exclude",id="ad-settings"]
=== Active Directory realm settings
See <<ref-ad-settings>>.
[role="exclude",id="mapping-roles-ad"]
=== Mapping Active Directory users and groups to roles
See <<ad-realm-configuration>>.
[role="exclude",id="how-security-works"]
=== How security works
See <<elasticsearch-security>>.
[role="exclude",id="rollup-job-config"]
=== Rollup job configuration
See <<rollup-put-job-api-request-body>>.
[role="exclude",id="transform-resource"]
=== {transform-cap} resources
This page was deleted.
See <<put-transform>>, <<preview-transform>>, <<update-transform>>,
<<get-transform>>.
[role="exclude",id="ml-job-resource"]
=== Job resources
This page was deleted.
[[ml-analysisconfig]]
See the details in
[[ml-apimodelplotconfig]]
<<ml-put-job>>, <<ml-update-job>>, and <<ml-get-job>>.
[role="exclude",id="ml-datafeed-resource"]
=== {dfeed-cap} resources
This page was deleted.
[[ml-datafeed-chunking-config]]
See the details in <<ml-put-datafeed>>, <<ml-update-datafeed>>,
[[ml-datafeed-delayed-data-check-config]]
<<ml-get-datafeed>>,
[[ml-datafeed-counts]]
<<ml-get-datafeed-stats>>.
[role="exclude",id="ml-jobstats"]
=== Job statistics
This
[[ml-datacounts]]
page
[[ml-modelsizestats]]
was
[[ml-forecastsstats]]
deleted.
[[ml-timingstats]]
See
[[ml-stats-node]]
the details in <<ml-get-job-stats>>.
[role="exclude",id="ml-snapshot-resource"]
=== Model snapshot resources
This page was deleted.
[[ml-snapshot-stats]]
See <<ml-update-snapshot>> and <<ml-get-snapshot>>.
[role="exclude",id="ml-dfanalytics-resources"]
=== {dfanalytics-cap} job resources
This page was deleted.
See <<put-dfanalytics>>.
[role="exclude",id="ml-dfa-analysis-objects"]
=== Analysis configuration objects
This page was deleted.
See <<put-dfanalytics>>.
[role="exclude",id="data-frames-settings"]
=== {transforms-cap} settings in Elasticsearch
See <<transform-settings>>.
[role="exclude",id="general-data-frames-settings"]
==== General {transforms} settings
See <<general-transform-settings>>.
[role="exclude",id="ml-results-resource"]
=== Results resources
This page was deleted.
[[ml-results-buckets]]
See <<ml-get-bucket>>,
[[ml-results-bucket-influencers]]
<<ml-get-bucket>>,
[[ml-results-influencers]]
<<ml-get-influencer>>,
[[ml-results-records]]
<<ml-get-record>>,
[[ml-results-categories]]
<<ml-get-category>>, and
[[ml-results-overall-buckets]]
<<ml-get-overall-buckets>>.
[role="exclude",id="modules-snapshots"]
=== Snapshot module
See <<snapshot-restore>>.
[role="exclude",id="_repository_plugins"]
==== Repository plugins
See <<snapshots-repository-plugins>>.
[role="exclude",id="restore-snapshot"]
=== Restore snapshot
See <<snapshots-restore-snapshot>>.
[role="exclude",id="snapshots-repositories"]
=== Snapshot repositories
See <<snapshots-register-repository>>.
[role="exclude",id="slm-api-delete"]
=== {slm-init} delete policy API
See <<slm-api-delete-policy>>.
[role="exclude",id="slm-api-execute"]
=== {slm-init} execute lifecycle API
See <<slm-api-execute-lifecycle>>.
[role="exclude",id="slm-api-execute-policy"]
=== {slm-init} execute lifecycle API
See <<slm-api-execute-lifecycle>>.
[role="exclude",id="slm-api-get"]
=== {slm-init} get policy API
See <<slm-api-get-policy>>.
[role="exclude",id="slm-get-stats"]
=== {slm-init} get stats API
See <<slm-api-get-stats>>.
[role="exclude",id="slm-get-status"]
=== {slm-init} status API
See <<slm-api-get-status>>.
[role="exclude",id="slm-api-put"]
=== {slm-init} put policy API
See <<slm-api-put-policy>>.
[role="exclude",id="slm-start"]
=== Start {slm} API
See <<slm-api-start>>.
[role="exclude",id="slm-stop"]
=== Stop {slm} API
See <<slm-api-stop>>.
[role="exclude",id="ccs-works"]
=== How {ccs} works
See <<ccs-gateway-seed-nodes>> and <<ccs-min-roundtrips>>.
Cumulative backport of async search changes (#53635) * Submit async search to work only with POST (#53368) Currently the submit async search API can be called using both GET and POST at REST, but given that it submits a call and creates internal state, POST should be the only allowed method. * Refine SearchProgressListener internal API (#53373) The following cumulative improvements have been made: - rename `onReduce` and `notifyReduce` to `onFinalReduce` and `notifyFinalReduce` - add unit test for `SearchShard` - on* methods in `SearchProgressListener` shouldn't need to be public as they should never be called directly, they only need to be overridden hence they can be made protected. They are actually called directly from a test which required some adapting, like making `AsyncSearchTask.Listener` class package private instead of private - Instead of overriding `getProgressListener` in `AsyncSearchTask`, as it feels weird to override a getter method, added a specific method that allows to retrieve the Listener directly without needing to cast it. Made the getter and setter for the listener final in the base class. - rename `SearchProgressListener#searchShards` methods to `buildSearchShards` and make it static given that it accesses no instance members - make `SearchShard` and `SearchShardTask` classes final * Move async search yaml tests to x-pack yaml test folder (#53537) The yaml tests for async search currently sit in its qa folder. There is no reason though for them to live in a separate folder as they don't require particular setup. This commit moves them to the main folder together with the other x-pack yaml tests so that they will be run by the client test runners too. * [DOCS] Add temporary redirect for async-search (#53454) The following API spec files contain a link to a not-yet-created async search docs page: * [async_search.delete.json][0] * [async_search.get.json][1] * [async_search.submit.json][2] The Elaticsearch-js client uses these spec files to create their docs. This created a broken link in the Elaticsearch-js docs, which has broken the docs build. This PR adds a temporary redirect for the docs page. This redirect should be removed when the actual API docs are added. [0]: https://github.com/elastic/elasticsearch/blob/master/x-pack/plugin/src/test/resources/rest-api-spec/api/async_search.delete.json [1]: https://github.com/elastic/elasticsearch/blob/master/x-pack/plugin/src/test/resources/rest-api-spec/api/async_search.get.json [2]: https://github.com/elastic/elasticsearch/blob/master/x-pack/plugin/src/test/resources/rest-api-spec/api/async_search.submit.json Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2020-03-16 19:08:17 -04:00
[role="exclude",id="data-streams"]
=== Data stream APIs
2020-05-15 10:37:45 -04:00
See <<indices-create-data-stream>>, <<indices-get-data-stream>>, and
<<indices-delete-data-stream>>.
[role="exclude",id="modules-indices"]
=== Indices module
See:
* <<circuit-breaker>>
* <<indexing-buffer>>
* <<modules-fielddata>>
* <<query-cache>>
* <<recovery>>
* <<search-settings>>
* <<shard-request-cache>>
[role="exclude",id="cat-transform"]
=== cat transform API
See <<cat-transforms>>.
[role="exclude",id="testing"]
=== Testing
This page was deleted.
[role="exclude",id="testing-framework"]
=== Java testing framework
This page was deleted.
[role="exclude",id="why-randomized-testing"]
=== Why randomized testing?
This page was deleted.
[role="exclude",id="using-elasticsearch-test-classes"]
=== Using the {es} test classes
This page was deleted.
[role="exclude",id="unit-tests"]
=== Unit tests
This page was deleted.
[role="exclude",id="integration-tests"]
=== Integration tests
This page was deleted.
[role="exclude",id="number-of-shards"]
==== Number of shards
This section was deleted.
[role="exclude",id="helper-methods"]
==== Generic helper methods
This section was deleted.
[role="exclude",id="test-cluster-methods"]
==== Test cluster methods
This section was deleted.
[role="exclude",id="changing-node-settings"]
==== Changing node settings
This section was deleted.
[role="exclude",id="accessing-clients"]
==== Accessing clients
This section was deleted.
[role="exclude",id="scoping"]
==== Scoping
This section was deleted.
[role="exclude",id="changing-node-configuration"]
==== Changing plugins via configuration
This section was deleted.
[role="exclude",id="randomized-testing"]
=== Randomized testing
This page was deleted.
[role="exclude",id="generating-random-data"]
==== Generating random data
This section was deleted.
[role="exclude",id="assertions"]
=== Assertions
This page was deleted.
[role="exclude",id="_actions"]
=== {ilm-init} actions
See <<ilm-actions>>.
[role="exclude",id="ilm-policy-definition"]
=== {ilm-init} policy definition
See <<ilm-index-lifecycle>>.
[role="exclude",id="modules-gateway-dangling-indices"]
=== Dangling indices
See <<dangling-indices>>.
[role="exclude",id="shards-allocation"]
=== Cluster-level shard allocation
See <<cluster-shard-allocation-settings>>.
[role="exclude",id="disk-allocator"]
=== Disk-based shard allocation
See <<disk-based-shard-allocation>>.
[role="exclude",id="allocation-awareness"]
=== Shard allocation awareness
See <<shard-allocation-awareness>>.
[role="exclude",id="allocation-filtering"]
=== Cluster-level shard allocation filtering
See <<cluster-shard-allocation-filtering>>.
[role="exclude",id="misc-cluster"]
=== Miscellaneous cluster settings
See <<misc-cluster-settings>>.
[role="exclude",id="modules"]
=== Modules
This page has been removed.
See <<settings,Configuring Elasticsearch>> for settings information:
* <<circuit-breaker>>
* <<modules-cluster>>
* <<modules-discovery-settings>>
* <<modules-fielddata>>
* <<modules-http>>
* <<recovery>>
* <<indexing-buffer>>
* <<modules-gateway>>
* <<modules-network>>
* <<query-cache>>
* <<search-settings>>
* <<shard-request-cache>>
For other information, see:
* <<modules-transport>>
* <<modules-threadpool>>
* <<modules-node>>
* <<modules-plugins>>
* <<modules-remote-clusters>>
[role="exclude",id="modules-discovery-adding-removing-nodes"]
=== Adding and removing nodes
See <<add-elasticsearch-nodes>>.
[role="exclude",id="_timing"]
=== Timing
See <<ilm-phase-transitions>>.
[role="exclude",id="_installation"]
=== Installation
See <<install-elasticsearch>>.
[role="exclude",id="mapping-ttl-field"]
=== `_ttl` mappings
The `_ttl` mappings have been removed. As a replacement for `_ttl`
mappings, we recommend using <<index-lifecycle-management,{ilm-init}>> to create
time-based indices.
[role="exclude",id="setup-service"]
=== Running as a service on Linux
See <<starting-elasticsearch>>.
[role="exclude",id="modules-scripting-painless-syntax"]
=== Painless syntax
See {painless}/painless-lang-spec.html[Painless language specification].
[role="exclude",id="using-policies-rollover"]
=== Using policies to manage index rollover
See <<ilm-configure-rollover>>.
[role="exclude",id="_applying_a_policy_to_our_index"]
=== Applying a policy to our index
See <<ilm-gs-apply-policy>>.
[role="exclude",id="setup-dir-layout"]
=== Directory layout
See <<settings>>.
[role="exclude",id="scan-scroll"]
=== Scan and scroll
See <<request-body-search-scroll>>.
[role="exclude",id="mapping-dynamic-mapping"]
=== Dynamic mapping
See <<dynamic-mapping>>.
[role="exclude",id="applying-policy-to-template"]
=== Applying a policy to an index template
See <<ilm-gs-apply-policy>>.
[role="exclude",id="indices-status"]
=== Index status API
The index `_status` API has been replaced with the <<indices-stats,index
stats>> and <<indices-recovery,index recovery>> APIs.
[role="exclude",id="search-facets"]
=== Search facets
See <<search-aggregations>>.
[role="exclude",id="_executing_searches"]
=== Executing searches
See <<getting-started-search>>.
[role="exclude",id="mapping-root-object-type"]
=== Mapping root object type
Mapping types have been removed. See <<mapping>>.
[role="exclude",id="query-dsl-filters"]
=== Query DSL filters
See <<query-filter-context>>.
[role="exclude",id="esms"]
=== {esms}
We have stopped adding new customers to our {esms}.
2020-05-29 16:40:23 -04:00
If you are interested in similar capabilities, contact
https://support.elastic.co[Elastic Support] to discuss available options.