mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
[DOCS] Replace put
with create or update
in API names (#70330)
Co-authored-by: debadair <debadair@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
This commit is contained in:
parent
eee4fe2a86
commit
5c75d004fa
83 changed files with 296 additions and 333 deletions
|
@ -5,13 +5,13 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Follow API
|
=== Create follower API
|
||||||
|
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Request
|
==== Request
|
||||||
|
|
||||||
The Put Follow API allows creates a follower index and make that index follow a leader index.
|
Creates a follower index and makes that index follow a leader index.
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -19,15 +19,14 @@ include-tagged::{doc-tests-file}[{api}-request]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
<1> The name of the remote cluster alias.
|
<1> The name of the remote cluster alias.
|
||||||
<2> The name of the leader in the remote cluster.
|
<2> The name of the leader in the remote cluster.
|
||||||
<3> The name of the follower index that gets created as part of the put follow API call.
|
<3> The name of the follower index to create.
|
||||||
<4> The number of active shard copies to wait for before the put follow API returns a
|
<4> The number of shard copies that must be active before the call returns.
|
||||||
response, as an `ActiveShardCount`
|
|
||||||
<5> The settings overrides for the follower index.
|
<5> The settings overrides for the follower index.
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ indicates if the put follow request was received.
|
The +{response}+ indicates if the request was received.
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -38,5 +37,3 @@ include-tagged::{doc-tests-file}[{api}-response]
|
||||||
<3> Whether the follower index started following the leader index.
|
<3> Whether the follower index started following the leader index.
|
||||||
|
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -5,12 +5,12 @@
|
||||||
--
|
--
|
||||||
|
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Component Template API
|
=== Create or update component template API
|
||||||
|
|
||||||
The Put Component Template API allows to create or change a component template.
|
Creates or updates a component template.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put Component Template Request
|
==== Request
|
||||||
|
|
||||||
A +{request}+ specifies the name of the component template and the template definition,
|
A +{request}+ specifies the name of the component template and the template definition,
|
||||||
which can consist of the settings, mappings or aliases, together with a version (which
|
which can consist of the settings, mappings or aliases, together with a version (which
|
||||||
|
@ -52,7 +52,7 @@ include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Put Component Templates Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ allows to retrieve information about the
|
The returned +{response}+ allows to retrieve information about the
|
||||||
executed operation as follows:
|
executed operation as follows:
|
||||||
|
|
|
@ -5,12 +5,12 @@
|
||||||
--
|
--
|
||||||
|
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Policy API
|
=== Create or update enrich policy API
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Request
|
==== Request
|
||||||
|
|
||||||
The Put Policy API stores an enrich policy in Elasticsearch.
|
Creates or updates an enrich policy.
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -20,12 +20,12 @@ include-tagged::{doc-tests-file}[{api}-request]
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ indicates if the put policy request was acknowledged.
|
The +{response}+ indicates if the request was acknowledged.
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
include-tagged::{doc-tests-file}[{api}-response]
|
include-tagged::{doc-tests-file}[{api}-response]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
<1> Whether put policy request was acknowledged.
|
<1> Whether the request was acknowledged.
|
||||||
|
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
|
@ -5,14 +5,13 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Lifecycle Policy API
|
=== Create or update lifecycle policy API
|
||||||
|
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Request
|
==== Request
|
||||||
|
|
||||||
The Put Lifecycle Policy API allows you to add an Index Lifecycle Management
|
Creates or updates an index lifecycle management policy.
|
||||||
Policy to the cluster.
|
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -25,14 +24,13 @@ include-tagged::{doc-tests-file}[{api}-request]
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ indicates if the put lifecycle policy request was received.
|
The +{response}+ indicates if the request was received.
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
include-tagged::{doc-tests-file}[{api}-response]
|
include-tagged::{doc-tests-file}[{api}-response]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
<1> Whether or not the put lifecycle policy was acknowledged.
|
<1> Whether or not the request was acknowledged.
|
||||||
|
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -5,14 +5,13 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Snapshot Lifecycle Policy API
|
=== Create or update snapshot lifecycle policy API
|
||||||
|
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Request
|
==== Request
|
||||||
|
|
||||||
The Put Snapshot Lifecycle Policy API allows you to add of update the definition of a Snapshot
|
Creates or updates a snapshot lifecycle management policy.
|
||||||
Lifecycle Management Policy in the cluster.
|
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -22,14 +21,13 @@ include-tagged::{doc-tests-file}[{api}-request]
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ indicates if the put snapshot lifecycle policy request was received.
|
The +{response}+ indicates if the request was received.
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
include-tagged::{doc-tests-file}[{api}-response]
|
include-tagged::{doc-tests-file}[{api}-response]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
<1> Whether or not the put snapshot lifecycle policy was acknowledged.
|
<1> Whether or not the request was acknowledged.
|
||||||
|
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -5,10 +5,10 @@
|
||||||
--
|
--
|
||||||
|
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Composable Index Template API
|
=== Create or update composable index template API
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put Composable Index Template Request
|
==== Request
|
||||||
|
|
||||||
A +{request}+ specifies the `name` of a template and the index template configuration
|
A +{request}+ specifies the `name` of a template and the index template configuration
|
||||||
which consists of the `patterns` that control whether the template should be applied
|
which consists of the `patterns` that control whether the template should be applied
|
||||||
|
@ -108,7 +108,7 @@ include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Put Composable Index Template Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ allows to retrieve information about the
|
The returned +{response}+ allows to retrieve information about the
|
||||||
executed operation as follows:
|
executed operation as follows:
|
||||||
|
|
|
@ -5,10 +5,13 @@
|
||||||
--
|
--
|
||||||
|
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Mapping API
|
=== Update mapping API
|
||||||
|
|
||||||
|
Adds new fields to an existing data stream or index. You can also use the API to
|
||||||
|
change the search settings of existing fields.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put Mapping Request
|
==== Request
|
||||||
|
|
||||||
A +{request}+ requires an `index` argument:
|
A +{request}+ requires an `index` argument:
|
||||||
|
|
||||||
|
@ -63,7 +66,7 @@ include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Put Mapping Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ allows to retrieve information about the executed
|
The returned +{response}+ allows to retrieve information about the executed
|
||||||
operation as follows:
|
operation as follows:
|
||||||
|
|
|
@ -5,10 +5,10 @@
|
||||||
--
|
--
|
||||||
|
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Template API
|
=== Create or update index template API
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put Index Template Request
|
==== Request
|
||||||
|
|
||||||
A +{request}+ specifies the `name` of a template and `patterns`
|
A +{request}+ specifies the `name` of a template and `patterns`
|
||||||
which controls whether the template should be applied to the new index.
|
which controls whether the template should be applied to the new index.
|
||||||
|
@ -120,7 +120,7 @@ include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Put Index Template Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ allows to retrieve information about the
|
The returned +{response}+ allows to retrieve information about the
|
||||||
executed operation as follows:
|
executed operation as follows:
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
[[java-rest-high-ingest-put-pipeline]]
|
[[java-rest-high-ingest-put-pipeline]]
|
||||||
=== Put Pipeline API
|
=== Create or update pipeline API
|
||||||
|
|
||||||
[[java-rest-high-ingest-put-pipeline-request]]
|
[[java-rest-high-ingest-put-pipeline-request]]
|
||||||
==== Put Pipeline Request
|
==== Request
|
||||||
|
|
||||||
A `PutPipelineRequest` requires an `id` argument, a source and a `XContentType`. The source consists
|
A `PutPipelineRequest` requires an `id` argument, a source and a `XContentType`. The source consists
|
||||||
of a description and a list of `Processor` objects.
|
of a description and a list of `Processor` objects.
|
||||||
|
@ -44,9 +44,9 @@ include-tagged::{doc-tests}/IngestClientDocumentationIT.java[put-pipeline-execut
|
||||||
[[java-rest-high-ingest-put-pipeline-async]]
|
[[java-rest-high-ingest-put-pipeline-async]]
|
||||||
==== Asynchronous Execution
|
==== Asynchronous Execution
|
||||||
|
|
||||||
The asynchronous execution of a put pipeline request requires both the `PutPipelineRequest`
|
The asynchronous execution of a create or update pipeline request requires both
|
||||||
instance and an `ActionListener` instance to be passed to the asynchronous
|
the `PutPipelineRequest` instance and an `ActionListener` instance to be passed
|
||||||
method:
|
to the asynchronous method:
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -71,7 +71,7 @@ provided as an argument
|
||||||
<2> Called in case of failure. The raised exception is provided as an argument
|
<2> Called in case of failure. The raised exception is provided as an argument
|
||||||
|
|
||||||
[[java-rest-high-ingest-put-pipeline-response]]
|
[[java-rest-high-ingest-put-pipeline-response]]
|
||||||
==== Put Pipeline Response
|
==== Response
|
||||||
|
|
||||||
The returned `WritePipelineResponse` allows to retrieve information about the executed
|
The returned `WritePipelineResponse` allows to retrieve information about the executed
|
||||||
operation as follows:
|
operation as follows:
|
||||||
|
|
|
@ -5,14 +5,14 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put {anomaly-jobs} in calendar API
|
=== Add {anomaly-jobs} to calendar API
|
||||||
|
|
||||||
Adds {anomaly-jobs} jobs to an existing {ml} calendar.
|
Adds {anomaly-jobs} jobs to an existing {ml} calendar.
|
||||||
The API accepts a +{request}+ and responds
|
The API accepts a +{request}+ and responds
|
||||||
with a +{response}+ object.
|
with a +{response}+ object.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put {anomaly-jobs} in calendar request
|
==== Request
|
||||||
|
|
||||||
A +{request}+ is constructed referencing a non-null
|
A +{request}+ is constructed referencing a non-null
|
||||||
calendar ID, and JobIDs to which to add to the calendar
|
calendar ID, and JobIDs to which to add to the calendar
|
||||||
|
@ -25,7 +25,7 @@ include-tagged::{doc-tests-file}[{api}-request]
|
||||||
<2> The JobIds to add to the calendar
|
<2> The JobIds to add to the calendar
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Put {anomaly-jobs} in calendar response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ contains the updated calendar:
|
The returned +{response}+ contains the updated calendar:
|
||||||
|
|
||||||
|
|
|
@ -5,14 +5,14 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put calendars API
|
=== Create calendars API
|
||||||
|
|
||||||
Creates a new {ml} calendar.
|
Creates a new {ml} calendar.
|
||||||
The API accepts a +{request}+ and responds
|
The API accepts a +{request}+ and responds
|
||||||
with a +{response}+ object.
|
with a +{response}+ object.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put calendars request
|
==== Request
|
||||||
|
|
||||||
A +{request}+ is constructed with a calendar object
|
A +{request}+ is constructed with a calendar object
|
||||||
|
|
||||||
|
@ -24,7 +24,7 @@ include-tagged::{doc-tests-file}[{api}-request]
|
||||||
|
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Put calendars response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ contains the created calendar:
|
The returned +{response}+ contains the created calendar:
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put {dfanalytics-jobs} API
|
=== Create {dfanalytics-jobs} API
|
||||||
|
|
||||||
beta::[]
|
beta::[]
|
||||||
|
|
||||||
|
@ -13,7 +13,7 @@ Creates a new {dfanalytics-job}.
|
||||||
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put {dfanalytics-jobs} request
|
==== Request
|
||||||
|
|
||||||
A +{request}+ requires the following argument:
|
A +{request}+ requires the following argument:
|
||||||
|
|
||||||
|
|
|
@ -5,13 +5,13 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put datafeeds API
|
=== Create datafeeds API
|
||||||
|
|
||||||
Creates a new {ml} datafeed in the cluster. The API accepts a +{request}+ object
|
Creates a new {ml} datafeed in the cluster. The API accepts a +{request}+ object
|
||||||
as a request and returns a +{response}+.
|
as a request and returns a +{response}+.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put datafeeds request
|
==== Request
|
||||||
|
|
||||||
A +{request}+ requires the following argument:
|
A +{request}+ requires the following argument:
|
||||||
|
|
||||||
|
|
|
@ -5,13 +5,13 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put filters API
|
=== Create filters API
|
||||||
|
|
||||||
Creates a new {ml} filter in the cluster. The API accepts a +{request}+ object
|
Creates a new {ml} filter in the cluster. The API accepts a +{request}+ object
|
||||||
as a request and returns a +{response}+.
|
as a request and returns a +{response}+.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put filters request
|
==== Request
|
||||||
|
|
||||||
A +{request}+ requires the following argument:
|
A +{request}+ requires the following argument:
|
||||||
|
|
||||||
|
|
|
@ -5,13 +5,13 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put {anomaly-jobs} API
|
=== Create {anomaly-jobs} API
|
||||||
|
|
||||||
Creates a new {anomaly-job} in the cluster. The API accepts a +{request}+ object
|
Creates a new {anomaly-job} in the cluster. The API accepts a +{request}+ object
|
||||||
as a request and returns a +{response}+.
|
as a request and returns a +{response}+.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put {anomaly-jobs} request
|
==== Request
|
||||||
|
|
||||||
A +{request}+ requires the following argument:
|
A +{request}+ requires the following argument:
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put trained model alias API
|
=== Create or update trained model alias API
|
||||||
|
|
||||||
beta::[]
|
beta::[]
|
||||||
|
|
||||||
|
@ -15,7 +15,7 @@ The created trained model alias can then be used for other APIs in the stack
|
||||||
instead of the referenced model id.
|
instead of the referenced model id.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put trained model alias request
|
==== Request
|
||||||
|
|
||||||
A +{request}+ requires the following arguments:
|
A +{request}+ requires the following arguments:
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put trained models API
|
=== Create trained models API
|
||||||
|
|
||||||
beta::[]
|
beta::[]
|
||||||
|
|
||||||
|
@ -13,7 +13,7 @@ Creates a new trained model for inference.
|
||||||
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put trained models request
|
==== Request
|
||||||
|
|
||||||
A +{request}+ requires the following argument:
|
A +{request}+ requires the following argument:
|
||||||
|
|
||||||
|
|
|
@ -1,15 +1,15 @@
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[[java-rest-high-x-pack-rollup-put-job]]
|
[[java-rest-high-x-pack-rollup-put-job]]
|
||||||
=== Put Rollup Job API
|
=== Create or update rollup job API
|
||||||
|
|
||||||
experimental::[]
|
experimental::[]
|
||||||
|
|
||||||
The Put Rollup Job API can be used to create a new Rollup job
|
Creates a new Rollup job or updates an existing one.
|
||||||
in the cluster. The API accepts a `PutRollupJobRequest` object
|
The API accepts a `PutRollupJobRequest` object
|
||||||
as a request and returns a `PutRollupJobResponse`.
|
as a request and returns a `PutRollupJobResponse`.
|
||||||
|
|
||||||
[[java-rest-high-x-pack-rollup-put-rollup-job-request]]
|
[[java-rest-high-x-pack-rollup-put-rollup-job-request]]
|
||||||
==== Put Rollup Job Request
|
==== Request
|
||||||
|
|
||||||
A `PutRollupJobRequest` requires the following argument:
|
A `PutRollupJobRequest` requires the following argument:
|
||||||
|
|
||||||
|
@ -126,7 +126,7 @@ include-tagged::{doc-tests}/RollupDocumentationIT.java[x-pack-rollup-put-rollup-
|
||||||
[[java-rest-high-x-pack-rollup-put-rollup-job-execution]]
|
[[java-rest-high-x-pack-rollup-put-rollup-job-execution]]
|
||||||
==== Execution
|
==== Execution
|
||||||
|
|
||||||
The Put Rollup Job API can be executed through a `RollupClient`
|
The API can be called through a `RollupClient`
|
||||||
instance. Such instance can be retrieved from a `RestHighLevelClient`
|
instance. Such instance can be retrieved from a `RestHighLevelClient`
|
||||||
using the `rollup()` method:
|
using the `rollup()` method:
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
[[java-rest-high-put-stored-script]]
|
[[java-rest-high-put-stored-script]]
|
||||||
=== Put Stored Script API
|
=== Create or update stored script API
|
||||||
|
|
||||||
[[java-rest-high-put-stored-script-request]]
|
[[java-rest-high-put-stored-script-request]]
|
||||||
==== Put Stored Script Request
|
==== Request
|
||||||
|
|
||||||
A `PutStoredScriptRequest` requires an `id` and `content`:
|
A `PutStoredScriptRequest` requires an `id` and `content`:
|
||||||
|
|
||||||
|
@ -65,8 +65,9 @@ include-tagged::{doc-tests}/StoredScriptsDocumentationIT.java[put-stored-script-
|
||||||
[[java-rest-high-put-stored-script-async]]
|
[[java-rest-high-put-stored-script-async]]
|
||||||
==== Asynchronous Execution
|
==== Asynchronous Execution
|
||||||
|
|
||||||
The asynchronous execution of a put stored script request requires both the `PutStoredScriptRequest`
|
The asynchronous execution of a create or update stored script request requires
|
||||||
instance and an `ActionListener` instance to be passed to the asynchronous method:
|
both the `PutStoredScriptRequest` instance and an `ActionListener` instance to
|
||||||
|
be passed to the asynchronous method:
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -94,7 +95,7 @@ provided as an argument
|
||||||
<2> Called in case of failure. The raised exception is provided as an argument
|
<2> Called in case of failure. The raised exception is provided as an argument
|
||||||
|
|
||||||
[[java-rest-high-put-stored-script-response]]
|
[[java-rest-high-put-stored-script-response]]
|
||||||
==== Put Stored Script Response
|
==== Response
|
||||||
|
|
||||||
The returned `AcknowledgedResponse` allows to retrieve information about the
|
The returned `AcknowledgedResponse` allows to retrieve information about the
|
||||||
executed operation as follows:
|
executed operation as follows:
|
||||||
|
|
|
@ -5,12 +5,12 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Privileges API
|
=== Create or update privileges API
|
||||||
|
|
||||||
Application privileges can be created or updated using this API.
|
Application privileges can be created or updated using this API.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put Privileges Request
|
==== Request
|
||||||
A +{request}+ contains list of application privileges that
|
A +{request}+ contains list of application privileges that
|
||||||
need to be created or updated. Each application privilege
|
need to be created or updated. Each application privilege
|
||||||
consists of an application name, application privilege,
|
consists of an application name, application privilege,
|
||||||
|
@ -24,7 +24,7 @@ include-tagged::{doc-tests-file}[{api}-request]
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Put Privileges Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ contains the information about the status
|
The returned +{response}+ contains the information about the status
|
||||||
for each privilege present in the +{request}+. The status would be
|
for each privilege present in the +{request}+. The status would be
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[[java-rest-high-security-put-role-mapping]]
|
[[java-rest-high-security-put-role-mapping]]
|
||||||
=== Put Role Mapping API
|
=== Create or update role mapping API
|
||||||
|
|
||||||
[[java-rest-high-security-put-role-mapping-execution]]
|
[[java-rest-high-security-put-role-mapping-execution]]
|
||||||
==== Execution
|
==== Execution
|
||||||
|
|
|
@ -6,15 +6,15 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Role API
|
=== Create or update role API
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put Role Request
|
==== Request
|
||||||
|
|
||||||
The +{request}+ class is used to create or update a role in the Native Roles
|
The +{request}+ class is used to create or update a role in the Native Roles
|
||||||
Store. The request contains a single role, which encapsulates privileges over
|
Store. The request contains a single role, which encapsulates privileges over
|
||||||
resources. A role can be assigned to an user using the
|
resources. A role can be assigned to an user using the
|
||||||
<<{upid}-put-role-mapping, Put Role Mapping API>>.
|
<<{upid}-put-role-mapping,Create or update role mapping API>>.
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -24,7 +24,7 @@ include-tagged::{doc-tests-file}[{api}-request]
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Put Role Response
|
==== Response
|
||||||
|
|
||||||
The returned +{response}+ contains a single field, `created`. This field
|
The returned +{response}+ contains a single field, `created`. This field
|
||||||
serves as an indication if the role was created or if an existing entry was
|
serves as an indication if the role was created or if an existing entry was
|
||||||
|
|
|
@ -5,10 +5,10 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put User API
|
=== Create or update user API
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put User Request
|
==== Request
|
||||||
|
|
||||||
The +{request}+ class is used to create or update a user in the Native Realm.
|
The +{request}+ class is used to create or update a user in the Native Realm.
|
||||||
There are 3 different factory methods for creating a request.
|
There are 3 different factory methods for creating a request.
|
||||||
|
@ -46,7 +46,7 @@ include-tagged::{doc-tests-file}[{api}-update-request]
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Put User Response
|
==== Response
|
||||||
|
|
||||||
The returned `PutUserResponse` contains a single field, `created`. This field
|
The returned `PutUserResponse` contains a single field, `created`. This field
|
||||||
serves as an indication if a user was created or if an existing entry was updated.
|
serves as an indication if a user was created or if an existing entry was updated.
|
||||||
|
|
|
@ -5,14 +5,14 @@
|
||||||
--
|
--
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put {transform} API
|
=== Create {transform} API
|
||||||
|
|
||||||
Creates a new {transform}.
|
Creates a new {transform}.
|
||||||
|
|
||||||
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
The API accepts a +{request}+ object as a request and returns a +{response}+.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put {transform} request
|
==== Create {transform} request
|
||||||
|
|
||||||
A +{request}+ requires the following argument:
|
A +{request}+ requires the following argument:
|
||||||
|
|
||||||
|
|
|
@ -7,9 +7,9 @@
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Execute watch API
|
=== Execute watch API
|
||||||
|
|
||||||
The execute watch API allows clients to immediately execute a watch, either
|
The execute watch API allows clients to immediately execute a watch, either one
|
||||||
one that has been previously added via the
|
that has been previously added via the {ref}/watcher-api-put-watch.html[create
|
||||||
{ref}/watcher-api-put-watch.html[Put Watch API] or inline as part of the request.
|
or update watch API] or inline as part of the request.
|
||||||
|
|
||||||
[id="{upid}-{api}-request-by-id"]
|
[id="{upid}-{api}-request-by-id"]
|
||||||
==== Execute by id
|
==== Execute by id
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[[java-rest-high-x-pack-watcher-put-watch]]
|
[[java-rest-high-x-pack-watcher-put-watch]]
|
||||||
=== Put watch API
|
=== Create or update watch API
|
||||||
|
|
||||||
[[java-rest-high-x-pack-watcher-put-watch-execution]]
|
[[java-rest-high-x-pack-watcher-put-watch-execution]]
|
||||||
==== Execution
|
==== Execution
|
||||||
|
|
|
@ -12,12 +12,13 @@ You can use the following APIs to perform autoscaling operations.
|
||||||
=== Top-Level
|
=== Top-Level
|
||||||
|
|
||||||
* <<autoscaling-get-autoscaling-capacity,Get autoscaling capacity>>
|
* <<autoscaling-get-autoscaling-capacity,Get autoscaling capacity>>
|
||||||
|
* <<autoscaling-put-autoscaling-policy,Create or update autoscaling policy>>
|
||||||
* <<autoscaling-delete-autoscaling-policy,Delete autoscaling policy>>
|
* <<autoscaling-delete-autoscaling-policy,Delete autoscaling policy>>
|
||||||
* <<autoscaling-get-autoscaling-policy,Get autoscaling policy>>
|
* <<autoscaling-get-autoscaling-policy,Get autoscaling policy>>
|
||||||
* <<autoscaling-put-autoscaling-policy,Put autoscaling policy>>
|
|
||||||
|
|
||||||
// top-level
|
// top-level
|
||||||
|
include::put-autoscaling-policy.asciidoc[]
|
||||||
include::get-autoscaling-capacity.asciidoc[]
|
include::get-autoscaling-capacity.asciidoc[]
|
||||||
include::delete-autoscaling-policy.asciidoc[]
|
include::delete-autoscaling-policy.asciidoc[]
|
||||||
include::get-autoscaling-policy.asciidoc[]
|
include::get-autoscaling-policy.asciidoc[]
|
||||||
include::put-autoscaling-policy.asciidoc[]
|
|
||||||
|
|
|
@ -1,14 +1,14 @@
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[testenv="enterprise"]
|
[testenv="enterprise"]
|
||||||
[[autoscaling-put-autoscaling-policy]]
|
[[autoscaling-put-autoscaling-policy]]
|
||||||
=== Put autoscaling policy API
|
=== Create or update autoscaling policy API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Put autoscaling policy</titleabbrev>
|
<titleabbrev>Create or update autoscaling policy</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
include::../autoscaling-designed-for-note.asciidoc[]
|
include::../autoscaling-designed-for-note.asciidoc[]
|
||||||
|
|
||||||
Put autoscaling policy.
|
Creates or updates an autoscaling policy.
|
||||||
|
|
||||||
[[autoscaling-put-autoscaling-policy-request]]
|
[[autoscaling-put-autoscaling-policy-request]]
|
||||||
==== {api-request-title}
|
==== {api-request-title}
|
||||||
|
|
|
@ -93,7 +93,7 @@ field mapping is added to future backing indices created for the stream.
|
||||||
For example, `my-data-stream-template` is an existing index template used by
|
For example, `my-data-stream-template` is an existing index template used by
|
||||||
`my-data-stream`.
|
`my-data-stream`.
|
||||||
|
|
||||||
The following <<index-templates,put index template>> request adds a mapping
|
The following <<index-templates,create or update index template>> request adds a mapping
|
||||||
for a new field, `message`, to the template.
|
for a new field, `message`, to the template.
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
|
@ -117,12 +117,12 @@ PUT /_index_template/my-data-stream-template
|
||||||
<1> Adds a mapping for the new `message` field.
|
<1> Adds a mapping for the new `message` field.
|
||||||
--
|
--
|
||||||
|
|
||||||
. Use the <<indices-put-mapping,put mapping API>> to add the new field mapping
|
. Use the <<indices-put-mapping,update mapping API>> to add the new field mapping
|
||||||
to the data stream. By default, this adds the mapping to the stream's existing
|
to the data stream. By default, this adds the mapping to the stream's existing
|
||||||
backing indices, including the write index.
|
backing indices, including the write index.
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
The following put mapping API request adds the new `message` field mapping to
|
The following update mapping API request adds the new `message` field mapping to
|
||||||
`my-data-stream`.
|
`my-data-stream`.
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
|
@ -138,11 +138,11 @@ PUT /my-data-stream/_mapping
|
||||||
----
|
----
|
||||||
--
|
--
|
||||||
+
|
+
|
||||||
To add the mapping only to the stream's write index, set the put mapping API's
|
To add the mapping only to the stream's write index, set the update mapping API's
|
||||||
`write_index_only` query parameter to `true`.
|
`write_index_only` query parameter to `true`.
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
The following put mapping request adds the new `message` field mapping only to
|
The following update mapping request adds the new `message` field mapping only to
|
||||||
`my-data-stream`'s write index. The new field mapping is not added to
|
`my-data-stream`'s write index. The new field mapping is not added to
|
||||||
the stream's other backing indices.
|
the stream's other backing indices.
|
||||||
|
|
||||||
|
@ -165,7 +165,7 @@ PUT /my-data-stream/_mapping?write_index_only=true
|
||||||
|
|
||||||
The documentation for each <<mapping-params,mapping parameter>> indicates
|
The documentation for each <<mapping-params,mapping parameter>> indicates
|
||||||
whether you can update it for an existing field using the
|
whether you can update it for an existing field using the
|
||||||
<<indices-put-mapping,put mapping API>>. To update these parameters for an
|
<<indices-put-mapping,update mapping API>>. To update these parameters for an
|
||||||
existing field, follow these steps:
|
existing field, follow these steps:
|
||||||
|
|
||||||
. Update the index template used by the data stream. This ensures the updated
|
. Update the index template used by the data stream. This ensures the updated
|
||||||
|
@ -175,7 +175,7 @@ field mapping is added to future backing indices created for the stream.
|
||||||
For example, `my-data-stream-template` is an existing index template used by
|
For example, `my-data-stream-template` is an existing index template used by
|
||||||
`my-data-stream`.
|
`my-data-stream`.
|
||||||
|
|
||||||
The following <<index-templates,put index template>> request changes the
|
The following <<index-templates,create or update index template>> request changes the
|
||||||
argument for the `host.ip` field's <<ignore-malformed,`ignore_malformed`>>
|
argument for the `host.ip` field's <<ignore-malformed,`ignore_malformed`>>
|
||||||
mapping parameter to `true`.
|
mapping parameter to `true`.
|
||||||
|
|
||||||
|
@ -205,12 +205,12 @@ PUT /_index_template/my-data-stream-template
|
||||||
<1> Changes the `host.ip` field's `ignore_malformed` value to `true`.
|
<1> Changes the `host.ip` field's `ignore_malformed` value to `true`.
|
||||||
--
|
--
|
||||||
|
|
||||||
. Use the <<indices-put-mapping,put mapping API>> to apply the mapping changes
|
. Use the <<indices-put-mapping,update mapping API>> to apply the mapping changes
|
||||||
to the data stream. By default, this applies the changes to the stream's
|
to the data stream. By default, this applies the changes to the stream's
|
||||||
existing backing indices, including the write index.
|
existing backing indices, including the write index.
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
The following <<indices-put-mapping,put mapping API>> request targets
|
The following <<indices-put-mapping,update mapping API>> request targets
|
||||||
`my-data-stream`. The request changes the argument for the `host.ip`
|
`my-data-stream`. The request changes the argument for the `host.ip`
|
||||||
field's `ignore_malformed` mapping parameter to `true`.
|
field's `ignore_malformed` mapping parameter to `true`.
|
||||||
|
|
||||||
|
@ -236,7 +236,7 @@ To apply the mapping changes only to the stream's write index, set the put
|
||||||
mapping API's `write_index_only` query parameter to `true`.
|
mapping API's `write_index_only` query parameter to `true`.
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
The following put mapping request changes the `host.ip` field's mapping only for
|
The following update mapping request changes the `host.ip` field's mapping only for
|
||||||
`my-data-stream`'s write index. The change is not applied to the
|
`my-data-stream`'s write index. The change is not applied to the
|
||||||
stream's other backing indices.
|
stream's other backing indices.
|
||||||
|
|
||||||
|
@ -281,7 +281,7 @@ applied to future backing indices created for the stream.
|
||||||
For example, `my-data-stream-template` is an existing index template used by
|
For example, `my-data-stream-template` is an existing index template used by
|
||||||
`my-data-stream`.
|
`my-data-stream`.
|
||||||
|
|
||||||
The following <<index-templates,put index template>> request changes the
|
The following <<index-templates,create or update index template>> request changes the
|
||||||
template's `index.refresh_interval` index setting to `30s` (30 seconds).
|
template's `index.refresh_interval` index setting to `30s` (30 seconds).
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
|
@ -335,8 +335,8 @@ backing index created after the update.
|
||||||
For example, `my-data-stream-template` is an existing index template used by
|
For example, `my-data-stream-template` is an existing index template used by
|
||||||
`my-data-stream`.
|
`my-data-stream`.
|
||||||
|
|
||||||
The following <<index-templates,put index template API>> requests adds new
|
The following <<index-templates,create or update index template API>> requests
|
||||||
`sort.field` and `sort.order index` settings to the template.
|
adds new `sort.field` and `sort.order index` settings to the template.
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
----
|
----
|
||||||
|
@ -428,10 +428,10 @@ new template by copying an existing one and modifying it as needed.
|
||||||
For example, `my-data-stream-template` is an existing index template used by
|
For example, `my-data-stream-template` is an existing index template used by
|
||||||
`my-data-stream`.
|
`my-data-stream`.
|
||||||
|
|
||||||
The following <<index-templates,put index template API>> request creates a new
|
The following <<index-templates,create or update index template API>> request
|
||||||
index template, `new-data-stream-template`. `new-data-stream-template`
|
creates a new index template, `new-data-stream-template`.
|
||||||
uses `my-data-stream-template` as its basis, with the following
|
`new-data-stream-template` uses `my-data-stream-template` as its basis, with the
|
||||||
changes:
|
following changes:
|
||||||
|
|
||||||
* The index pattern in `index_patterns` matches any index or data stream
|
* The index pattern in `index_patterns` matches any index or data stream
|
||||||
starting with `new-data-stream`.
|
starting with `new-data-stream`.
|
||||||
|
|
|
@ -129,8 +129,8 @@ image::images/data-streams/create-index-template.png[Create template page]
|
||||||
[%collapsible]
|
[%collapsible]
|
||||||
.API example
|
.API example
|
||||||
====
|
====
|
||||||
Use the <<indices-put-template,put index template API>> to create an index
|
Use the <<indices-put-template,create or update index template API>> to create
|
||||||
template. The template must include a `data_stream` object, indicating
|
an index template. The template must include a `data_stream` object, indicating
|
||||||
it's used for data streams.
|
it's used for data streams.
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
|
|
|
@ -208,7 +208,7 @@ include::{es-repo-dir}/indices/index-templates.asciidoc[tag=built-in-index-templ
|
||||||
If no mapping exists, the index operation
|
If no mapping exists, the index operation
|
||||||
creates a dynamic mapping. By default, new fields and objects are
|
creates a dynamic mapping. By default, new fields and objects are
|
||||||
automatically added to the mapping if needed. For more information about field
|
automatically added to the mapping if needed. For more information about field
|
||||||
mapping, see <<mapping,mapping>> and the <<indices-put-mapping,put mapping>> API.
|
mapping, see <<mapping,mapping>> and the <<indices-put-mapping,update mapping>> API.
|
||||||
|
|
||||||
Automatic index creation is controlled by the `action.auto_create_index`
|
Automatic index creation is controlled by the `action.auto_create_index`
|
||||||
setting. This setting defaults to `true`, which allows any index to be created
|
setting. This setting defaults to `true`, which allows any index to be created
|
||||||
|
|
|
@ -280,7 +280,7 @@ An index alias is a logical name used to reference one or more indices.
|
||||||
Most {es} APIs accept an index alias in place of an index name.
|
Most {es} APIs accept an index alias in place of an index name.
|
||||||
// end::index-alias-desc[]
|
// end::index-alias-desc[]
|
||||||
|
|
||||||
See {ref}/indices-add-alias.html[Add index alias].
|
See {ref}/indices-add-alias.html[Create or update index alias API].
|
||||||
// end::index-alias-def[]
|
// end::index-alias-def[]
|
||||||
--
|
--
|
||||||
|
|
||||||
|
|
|
@ -56,7 +56,7 @@ reaches either a `max_primary_shard_size` of 50 gigabytes or a `max_age` of 30 d
|
||||||
Note that this value is relative to the rollover time, not the index creation time.
|
Note that this value is relative to the rollover time, not the index creation time.
|
||||||
|
|
||||||
You can create the policy through {kib} or with the
|
You can create the policy through {kib} or with the
|
||||||
<<ilm-put-lifecycle, put policy>> API.
|
<<ilm-put-lifecycle,create or update policy>> API.
|
||||||
To create the policy from {kib}, open the menu and go to *Stack Management >
|
To create the policy from {kib}, open the menu and go to *Stack Management >
|
||||||
Index Lifecycle Policies*. Click *Create policy*.
|
Index Lifecycle Policies*. Click *Create policy*.
|
||||||
|
|
||||||
|
@ -116,8 +116,8 @@ Templates* tab, click *Create template*.
|
||||||
|
|
||||||
image::images/data-streams/create-index-template.png[Create template page]
|
image::images/data-streams/create-index-template.png[Create template page]
|
||||||
|
|
||||||
This wizard invokes the <<indices-put-template,put index template API>> to create
|
This wizard invokes the <<indices-put-template,create or update index template
|
||||||
the index template with the options you specify.
|
API>> to create the index template with the options you specify.
|
||||||
|
|
||||||
.API example
|
.API example
|
||||||
[%collapsible]
|
[%collapsible]
|
||||||
|
|
|
@ -35,7 +35,8 @@ image:images/ilm/create-policy.png[Create policy page]
|
||||||
|
|
||||||
You specify the lifecycle phases for the policy and the actions to perform in each phase.
|
You specify the lifecycle phases for the policy and the actions to perform in each phase.
|
||||||
|
|
||||||
The <<ilm-put-lifecycle, put policy>> API is invoked to add the policy to the {es} cluster.
|
The <<ilm-put-lifecycle,create or update policy>> API is invoked to add the
|
||||||
|
policy to the {es} cluster.
|
||||||
|
|
||||||
.API example
|
.API example
|
||||||
[%collapsible]
|
[%collapsible]
|
||||||
|
@ -83,7 +84,8 @@ wizard, open the menu and go to *Stack Management > Index Management*. In the
|
||||||
[role="screenshot"]
|
[role="screenshot"]
|
||||||
image:images/ilm/create-template-wizard-my_template.png[Create template page]
|
image:images/ilm/create-template-wizard-my_template.png[Create template page]
|
||||||
|
|
||||||
The wizard invokes the <<indices-put-template,put template API>> to add templates to a cluster.
|
The wizard invokes the <<indices-put-template,create or update index template
|
||||||
|
API>> to add templates to a cluster.
|
||||||
|
|
||||||
.API example
|
.API example
|
||||||
[%collapsible]
|
[%collapsible]
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
== Mapper
|
== Mapper
|
||||||
|
|
||||||
The mapper module acts as a registry for the type mapping definitions
|
The mapper module acts as a registry for the type mapping definitions
|
||||||
added to an index either when creating it or by using the put mapping
|
added to an index either when creating it or by using the update mapping
|
||||||
api. It also handles the dynamic mapping support for types that have no
|
API. It also handles the dynamic mapping support for types that have no
|
||||||
explicit mappings pre defined. For more information about mapping
|
explicit mappings pre defined. For more information about mapping
|
||||||
definitions, check out the <<mapping,mapping section>>.
|
definitions, check out the <<mapping,mapping section>>.
|
||||||
|
|
|
@ -91,96 +91,50 @@ For more information, see <<index-templates, Index Templates>>.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
include::indices/add-alias.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/analyze.asciidoc[]
|
include::indices/analyze.asciidoc[]
|
||||||
|
|
||||||
include::indices/clearcache.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/clone-index.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/close.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/create-index.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/delete-index.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/delete-alias.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/delete-component-template.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/delete-index-template.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/delete-index-template-v1.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/flush.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/forcemerge.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/apis/freeze.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/get-component-template.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/get-field-mapping.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/get-index.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/get-alias.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/get-settings.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/get-index-template.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/get-index-template-v1.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/get-mapping.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/alias-exists.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/indices-exists.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/recovery.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/segments.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/shard-stores.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/stats.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/index-template-exists-v1.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/open-close.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/put-index-template.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/put-index-template-v1.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/put-component-template.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/put-mapping.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/refresh.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/rollover-index.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/shrink-index.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/simulate-index.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/simulate-template.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/split-index.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/apis/unfreeze.asciidoc[]
|
|
||||||
|
|
||||||
include::indices/aliases.asciidoc[]
|
include::indices/aliases.asciidoc[]
|
||||||
|
include::indices/clearcache.asciidoc[]
|
||||||
include::indices/update-settings.asciidoc[]
|
include::indices/clone-index.asciidoc[]
|
||||||
|
include::indices/close.asciidoc[]
|
||||||
include::indices/resolve.asciidoc[]
|
include::indices/create-index.asciidoc[]
|
||||||
|
include::indices/put-component-template.asciidoc[]
|
||||||
include::indices/dangling-indices-list.asciidoc[]
|
include::indices/add-alias.asciidoc[]
|
||||||
|
include::indices/put-index-template.asciidoc[]
|
||||||
include::indices/dangling-index-import.asciidoc[]
|
include::indices/put-index-template-v1.asciidoc[]
|
||||||
|
include::indices/delete-component-template.asciidoc[]
|
||||||
include::indices/dangling-index-delete.asciidoc[]
|
include::indices/dangling-index-delete.asciidoc[]
|
||||||
|
include::indices/delete-index.asciidoc[]
|
||||||
|
include::indices/delete-alias.asciidoc[]
|
||||||
|
include::indices/delete-index-template.asciidoc[]
|
||||||
|
include::indices/delete-index-template-v1.asciidoc[]
|
||||||
|
include::indices/flush.asciidoc[]
|
||||||
|
include::indices/forcemerge.asciidoc[]
|
||||||
|
include::indices/apis/freeze.asciidoc[]
|
||||||
|
include::indices/get-component-template.asciidoc[]
|
||||||
|
include::indices/get-field-mapping.asciidoc[]
|
||||||
|
include::indices/get-index.asciidoc[]
|
||||||
|
include::indices/get-alias.asciidoc[]
|
||||||
|
include::indices/get-settings.asciidoc[]
|
||||||
|
include::indices/get-index-template.asciidoc[]
|
||||||
|
include::indices/get-index-template-v1.asciidoc[]
|
||||||
|
include::indices/get-mapping.asciidoc[]
|
||||||
|
include::indices/dangling-index-import.asciidoc[]
|
||||||
|
include::indices/alias-exists.asciidoc[]
|
||||||
|
include::indices/indices-exists.asciidoc[]
|
||||||
|
include::indices/recovery.asciidoc[]
|
||||||
|
include::indices/segments.asciidoc[]
|
||||||
|
include::indices/shard-stores.asciidoc[]
|
||||||
|
include::indices/stats.asciidoc[]
|
||||||
|
include::indices/index-template-exists-v1.asciidoc[]
|
||||||
|
include::indices/dangling-indices-list.asciidoc[]
|
||||||
|
include::indices/open-close.asciidoc[]
|
||||||
|
include::indices/refresh.asciidoc[]
|
||||||
|
include::indices/resolve.asciidoc[]
|
||||||
|
include::indices/rollover-index.asciidoc[]
|
||||||
|
include::indices/shrink-index.asciidoc[]
|
||||||
|
include::indices/simulate-index.asciidoc[]
|
||||||
|
include::indices/simulate-template.asciidoc[]
|
||||||
|
include::indices/split-index.asciidoc[]
|
||||||
|
include::indices/apis/unfreeze.asciidoc[]
|
||||||
|
include::indices/update-settings.asciidoc[]
|
||||||
|
include::indices/put-mapping.asciidoc[]
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[indices-add-alias]]
|
[[indices-add-alias]]
|
||||||
=== Add index alias API
|
=== Create or update index alias API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Add index alias</titleabbrev>
|
<titleabbrev>Create or update index alias</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Creates or updates an index alias.
|
Creates or updates an index alias.
|
||||||
|
|
|
@ -1,12 +1,14 @@
|
||||||
[[indices-aliases]]
|
[[indices-aliases]]
|
||||||
=== Update index alias API
|
=== Bulk index alias API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Update index alias</titleabbrev>
|
<titleabbrev>Bulk index alias</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Adds or removes index aliases.
|
Adds and removes multiple index aliases in a single request. Also deletes
|
||||||
|
concrete indices.
|
||||||
|
|
||||||
include::{es-repo-dir}/glossary.asciidoc[tag=index-alias-desc]
|
An index alias is a secondary name used to refer to one or more existing
|
||||||
|
indices. Most {es} APIs accept an index alias in place of an index.
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
----
|
----
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[indices-component-template]]
|
[[indices-component-template]]
|
||||||
=== Put component template API
|
=== Create or update component template API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Put component template</titleabbrev>
|
<titleabbrev>Create or update component template</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Creates or updates a component template.
|
Creates or updates a component template.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[indices-templates-v1]]
|
[[indices-templates-v1]]
|
||||||
=== Put index template API
|
=== Create or update index template API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Put index template (legacy)</titleabbrev>
|
<titleabbrev>Create or update index template (legacy)</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
IMPORTANT: This documentation is about legacy index templates,
|
IMPORTANT: This documentation is about legacy index templates,
|
||||||
|
@ -62,9 +62,6 @@ privilege>> to use this API.
|
||||||
[[put-index-template-v1-api-desc]]
|
[[put-index-template-v1-api-desc]]
|
||||||
==== {api-description-title}
|
==== {api-description-title}
|
||||||
|
|
||||||
Use the PUT index template API
|
|
||||||
to create or update an index template.
|
|
||||||
|
|
||||||
Index templates define <<index-modules-settings,settings>> and <<mapping,mappings>>
|
Index templates define <<index-modules-settings,settings>> and <<mapping,mappings>>
|
||||||
that you can automatically apply when creating new indices.
|
that you can automatically apply when creating new indices.
|
||||||
{es} applies templates to new indices
|
{es} applies templates to new indices
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[indices-put-template]]
|
[[indices-put-template]]
|
||||||
=== Put index template API
|
=== Create or update index template API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Put index template</titleabbrev>
|
<titleabbrev>Create or update index template</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Creates or updates an index template.
|
Creates or updates an index template.
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
[[indices-put-mapping]]
|
[[indices-put-mapping]]
|
||||||
=== Put mapping API
|
=== Update mapping API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Put mapping</titleabbrev>
|
<titleabbrev>Update mapping</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Adds new fields to an existing data stream or index. You can also use the
|
Adds new fields to an existing data stream or index. You can also use this
|
||||||
put mapping API to change the search settings of existing fields.
|
API to change the search settings of existing fields.
|
||||||
|
|
||||||
For data streams, these changes are applied to all backing indices by default.
|
For data streams, these changes are applied to all backing indices by default.
|
||||||
|
|
||||||
|
@ -98,7 +98,7 @@ For existing fields, see <<updating-field-mappings>>.
|
||||||
[[put-field-mapping-api-basic-ex]]
|
[[put-field-mapping-api-basic-ex]]
|
||||||
===== Example with single target
|
===== Example with single target
|
||||||
|
|
||||||
The put mapping API requires an existing data stream or index. The following
|
The update mapping API requires an existing data stream or index. The following
|
||||||
<<indices-create-index, create index>> API request creates the `publications`
|
<<indices-create-index, create index>> API request creates the `publications`
|
||||||
index with no mapping.
|
index with no mapping.
|
||||||
|
|
||||||
|
@ -107,7 +107,7 @@ index with no mapping.
|
||||||
PUT /publications
|
PUT /publications
|
||||||
----
|
----
|
||||||
|
|
||||||
The following put mapping API request adds `title`, a new <<text,`text`>> field,
|
The following update mapping API request adds `title`, a new <<text,`text`>> field,
|
||||||
to the `publications` index.
|
to the `publications` index.
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
|
@ -124,7 +124,7 @@ PUT /publications/_mapping
|
||||||
[[put-mapping-api-multi-ex]]
|
[[put-mapping-api-multi-ex]]
|
||||||
===== Multiple targets
|
===== Multiple targets
|
||||||
|
|
||||||
The PUT mapping API can be applied to multiple data streams or indices with a single request.
|
The update mapping API can be applied to multiple data streams or indices with a single request.
|
||||||
For example, you can update mappings for the `my-index-000001` and `my-index-000002` indices at the same time:
|
For example, you can update mappings for the `my-index-000001` and `my-index-000002` indices at the same time:
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
|
@ -152,7 +152,7 @@ PUT /my-index-000001,my-index-000002/_mapping
|
||||||
[[add-new-field-to-object]]
|
[[add-new-field-to-object]]
|
||||||
===== Add new properties to an existing object field
|
===== Add new properties to an existing object field
|
||||||
|
|
||||||
You can use the put mapping API to add new properties to an existing
|
You can use the update mapping API to add new properties to an existing
|
||||||
<<object,`object`>> field. To see how this works, try the following example.
|
<<object,`object`>> field. To see how this works, try the following example.
|
||||||
|
|
||||||
Use the <<indices-create-index,create index>> API to create an index with the
|
Use the <<indices-create-index,create index>> API to create an index with the
|
||||||
|
@ -176,7 +176,7 @@ PUT /my-index-000001
|
||||||
}
|
}
|
||||||
----
|
----
|
||||||
|
|
||||||
Use the put mapping API to add a new inner `last` text field to the `name`
|
Use the update mapping API to add a new inner `last` text field to the `name`
|
||||||
field.
|
field.
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
|
@ -201,7 +201,7 @@ PUT /my-index-000001/_mapping
|
||||||
===== Add multi-fields to an existing field
|
===== Add multi-fields to an existing field
|
||||||
|
|
||||||
<<multi-fields,Multi-fields>> let you index the same field in different ways.
|
<<multi-fields,Multi-fields>> let you index the same field in different ways.
|
||||||
You can use the put mapping API to update the `fields` mapping parameter and
|
You can use the update mapping API to update the `fields` mapping parameter and
|
||||||
enable multi-fields for an existing field.
|
enable multi-fields for an existing field.
|
||||||
|
|
||||||
To see how this works, try the following example.
|
To see how this works, try the following example.
|
||||||
|
@ -226,7 +226,7 @@ PUT /my-index-000001
|
||||||
While text fields work well for full-text search, <<keyword,keyword>> fields are
|
While text fields work well for full-text search, <<keyword,keyword>> fields are
|
||||||
not analyzed and may work better for sorting or aggregations.
|
not analyzed and may work better for sorting or aggregations.
|
||||||
|
|
||||||
Use the put mapping API to enable a multi-field for the `city` field. This
|
Use the update mapping API to enable a multi-field for the `city` field. This
|
||||||
request adds the `city.raw` keyword multi-field, which can be used for sorting.
|
request adds the `city.raw` keyword multi-field, which can be used for sorting.
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
|
@ -252,8 +252,8 @@ PUT /my-index-000001/_mapping
|
||||||
===== Change supported mapping parameters for an existing field
|
===== Change supported mapping parameters for an existing field
|
||||||
|
|
||||||
The documentation for each <<mapping-params,mapping parameter>> indicates
|
The documentation for each <<mapping-params,mapping parameter>> indicates
|
||||||
whether you can update it for an existing field using the put mapping API. For
|
whether you can update it for an existing field using the update mapping API. For
|
||||||
example, you can use the put mapping API to update the
|
example, you can use the update mapping API to update the
|
||||||
<<ignore-above,`ignore_above`>> parameter.
|
<<ignore-above,`ignore_above`>> parameter.
|
||||||
|
|
||||||
To see how this works, try the following example.
|
To see how this works, try the following example.
|
||||||
|
@ -277,7 +277,7 @@ PUT /my-index-000001
|
||||||
}
|
}
|
||||||
----
|
----
|
||||||
|
|
||||||
Use the put mapping API to change the `ignore_above` parameter value to `100`.
|
Use the update mapping API to change the `ignore_above` parameter value to `100`.
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
----
|
----
|
||||||
|
@ -416,7 +416,7 @@ PUT /my-index-000001
|
||||||
}
|
}
|
||||||
----
|
----
|
||||||
|
|
||||||
Use the put mapping API to add the `user_id` field alias
|
Use the update mapping API to add the `user_id` field alias
|
||||||
for the existing `user_identifier` field.
|
for the existing `user_identifier` field.
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
|
|
|
@ -1,12 +1,12 @@
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[testenv="basic"]
|
[testenv="basic"]
|
||||||
[[put-enrich-policy-api]]
|
[[put-enrich-policy-api]]
|
||||||
=== Put enrich policy API
|
=== Create or update enrich policy API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Put enrich policy</titleabbrev>
|
<titleabbrev>Create or update enrich policy</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Creates an enrich policy.
|
Creates or updates an enrich policy.
|
||||||
|
|
||||||
////
|
////
|
||||||
[source,console]
|
[source,console]
|
||||||
|
@ -64,8 +64,8 @@ If you use {es} {security-features}, you must have:
|
||||||
[[put-enrich-policy-api-desc]]
|
[[put-enrich-policy-api-desc]]
|
||||||
==== {api-description-title}
|
==== {api-description-title}
|
||||||
|
|
||||||
Use the put enrich policy API
|
Use the create or update enrich policy API to create a new
|
||||||
to create a new <<enrich-policy,enrich policy>>.
|
<<enrich-policy,enrich policy>>.
|
||||||
|
|
||||||
[WARNING]
|
[WARNING]
|
||||||
====
|
====
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[put-pipeline-api]]
|
[[put-pipeline-api]]
|
||||||
=== Put pipeline API
|
=== Create or update pipeline API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Put pipeline</titleabbrev>
|
<titleabbrev>Create or update pipeline</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Creates or updates an ingest pipeline.
|
Creates or updates an ingest pipeline.
|
||||||
|
|
|
@ -143,7 +143,7 @@ policy, you should include at least the following:
|
||||||
include::enrich.asciidoc[tag=enrich-policy-fields]
|
include::enrich.asciidoc[tag=enrich-policy-fields]
|
||||||
|
|
||||||
You can use this definition to create the enrich policy with the
|
You can use this definition to create the enrich policy with the
|
||||||
<<put-enrich-policy-api,put enrich policy API>>.
|
<<put-enrich-policy-api,create or update enrich policy API>>.
|
||||||
|
|
||||||
[WARNING]
|
[WARNING]
|
||||||
====
|
====
|
||||||
|
@ -172,7 +172,7 @@ your policy.
|
||||||
image::images/ingest/enrich/enrich-processor.svg[align="center"]
|
image::images/ingest/enrich/enrich-processor.svg[align="center"]
|
||||||
|
|
||||||
Define an <<enrich-processor,enrich processor>> and add it to an ingest
|
Define an <<enrich-processor,enrich processor>> and add it to an ingest
|
||||||
pipeline using the <<put-pipeline-api,put pipeline API>>.
|
pipeline using the <<put-pipeline-api,create or update pipeline API>>.
|
||||||
|
|
||||||
When defining the enrich processor, you must include at least the following:
|
When defining the enrich processor, you must include at least the following:
|
||||||
|
|
||||||
|
@ -343,8 +343,8 @@ PUT /postal_codes/_doc/1?refresh=wait_for
|
||||||
----
|
----
|
||||||
// TEST[continued]
|
// TEST[continued]
|
||||||
|
|
||||||
Use the <<put-enrich-policy-api,put enrich policy API>> to create an enrich
|
Use the <<put-enrich-policy-api,create or update enrich policy API>> to create
|
||||||
policy with the `geo_match` policy type. This policy must include:
|
an enrich policy with the `geo_match` policy type. This policy must include:
|
||||||
|
|
||||||
* One or more source indices
|
* One or more source indices
|
||||||
* A `match_field`,
|
* A `match_field`,
|
||||||
|
@ -374,8 +374,9 @@ POST /_enrich/policy/postal_policy/_execute
|
||||||
----
|
----
|
||||||
// TEST[continued]
|
// TEST[continued]
|
||||||
|
|
||||||
Use the <<put-pipeline-api,put pipeline API>> to create an ingest pipeline. In
|
Use the <<put-pipeline-api,create or update pipeline API>> to create an ingest
|
||||||
the pipeline, add an <<enrich-processor,enrich processor>> that includes:
|
pipeline. In the pipeline, add an <<enrich-processor,enrich processor>> that
|
||||||
|
includes:
|
||||||
|
|
||||||
* Your enrich policy.
|
* Your enrich policy.
|
||||||
* The `field` of incoming documents used to match the geo_shape of documents
|
* The `field` of incoming documents used to match the geo_shape of documents
|
||||||
|
@ -499,8 +500,8 @@ PUT /users/_doc/1?refresh=wait_for
|
||||||
}
|
}
|
||||||
----
|
----
|
||||||
|
|
||||||
Use the put enrich policy API to create an enrich policy with the `match`
|
Use the create or update enrich policy API to create an enrich policy with the
|
||||||
policy type. This policy must include:
|
`match` policy type. This policy must include:
|
||||||
|
|
||||||
* One or more source indices
|
* One or more source indices
|
||||||
* A `match_field`,
|
* A `match_field`,
|
||||||
|
@ -531,8 +532,9 @@ POST /_enrich/policy/users-policy/_execute
|
||||||
// TEST[continued]
|
// TEST[continued]
|
||||||
|
|
||||||
|
|
||||||
Use the <<put-pipeline-api,put pipeline API>> to create an ingest pipeline. In
|
Use the <<put-pipeline-api,create or update pipeline API>> to create an ingest
|
||||||
the pipeline, add an <<enrich-processor,enrich processor>> that includes:
|
pipeline. In the pipeline, add an <<enrich-processor,enrich processor>> that
|
||||||
|
includes:
|
||||||
|
|
||||||
* Your enrich policy.
|
* Your enrich policy.
|
||||||
* The `field` of incoming documents used to match documents
|
* The `field` of incoming documents used to match documents
|
||||||
|
|
|
@ -36,7 +36,7 @@ You can disable dynamic mapping, both at the document and at the
|
||||||
`false` ignores new fields, and `strict` rejects the document if {es}
|
`false` ignores new fields, and `strict` rejects the document if {es}
|
||||||
encounters an unknown field.
|
encounters an unknown field.
|
||||||
|
|
||||||
TIP: Use the <<indices-put-mapping,PUT mapping API>> to update the `dynamic`
|
TIP: Use the <<indices-put-mapping,update mapping API>> to update the `dynamic`
|
||||||
setting on existing fields.
|
setting on existing fields.
|
||||||
|
|
||||||
You can customize dynamic field mapping rules for
|
You can customize dynamic field mapping rules for
|
||||||
|
|
|
@ -61,7 +61,7 @@ snippet may cause the update or validation of a dynamic template to fail under c
|
||||||
at index time.
|
at index time.
|
||||||
|
|
||||||
Templates are processed in order -- the first matching template wins. When
|
Templates are processed in order -- the first matching template wins. When
|
||||||
putting new dynamic templates through the <<indices-put-mapping, put mapping>> API,
|
putting new dynamic templates through the <<indices-put-mapping, update mapping>> API,
|
||||||
all existing templates are overwritten. This allows for dynamic templates to be
|
all existing templates are overwritten. This allows for dynamic templates to be
|
||||||
reordered or deleted after they were initially added.
|
reordered or deleted after they were initially added.
|
||||||
|
|
||||||
|
|
|
@ -38,7 +38,7 @@ PUT /my-index-000001
|
||||||
[[add-field-mapping]]
|
[[add-field-mapping]]
|
||||||
=== Add a field to an existing mapping
|
=== Add a field to an existing mapping
|
||||||
|
|
||||||
You can use the <<indices-put-mapping, put mapping>> API to add one or more new
|
You can use the <<indices-put-mapping, update mapping>> API to add one or more new
|
||||||
fields to an existing index.
|
fields to an existing index.
|
||||||
|
|
||||||
The following example adds `employee-id`, a `keyword` field with an
|
The following example adds `employee-id`, a `keyword` field with an
|
||||||
|
|
|
@ -25,7 +25,7 @@ PUT my-index-000001
|
||||||
<<indices-get-mapping,GET mapping>> API.
|
<<indices-get-mapping,GET mapping>> API.
|
||||||
|
|
||||||
The `_meta` field can be updated on an existing type using the
|
The `_meta` field can be updated on an existing type using the
|
||||||
<<indices-put-mapping,PUT mapping>> API:
|
<<indices-put-mapping,update mapping>> API:
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
|
|
@ -20,7 +20,7 @@ We recommend testing analyzers before using them in production. See
|
||||||
====
|
====
|
||||||
|
|
||||||
TIP: The `analyzer` setting can *not* be updated on existing fields
|
TIP: The `analyzer` setting can *not* be updated on existing fields
|
||||||
using the <<indices-put-mapping,PUT mapping API>>.
|
using the <<indices-put-mapping,update mapping API>>.
|
||||||
|
|
||||||
[[search-quote-analyzer]]
|
[[search-quote-analyzer]]
|
||||||
==== `search_quote_analyzer`
|
==== `search_quote_analyzer`
|
||||||
|
@ -98,7 +98,7 @@ GET my-index-000001/_search
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
|
||||||
TIP: The `search_quote_analyzer` setting can be updated on existing fields
|
TIP: The `search_quote_analyzer` setting can be updated on existing fields
|
||||||
using the <<indices-put-mapping,PUT mapping API>>.
|
using the <<indices-put-mapping,update mapping API>>.
|
||||||
|
|
||||||
<1> `my_analyzer` analyzer which tokens all terms including stop words
|
<1> `my_analyzer` analyzer which tokens all terms including stop words
|
||||||
<2> `my_stop_analyzer` analyzer which removes stop words
|
<2> `my_stop_analyzer` analyzer which removes stop words
|
||||||
|
|
|
@ -48,7 +48,7 @@ PUT my-index-000001/_doc/2
|
||||||
<2> This document will be rejected because coercion is disabled.
|
<2> This document will be rejected because coercion is disabled.
|
||||||
|
|
||||||
TIP: The `coerce` setting value can be updated on existing fields
|
TIP: The `coerce` setting value can be updated on existing fields
|
||||||
using the <<indices-put-mapping,PUT mapping API>>.
|
using the <<indices-put-mapping,update mapping API>>.
|
||||||
|
|
||||||
[[coerce-setting]]
|
[[coerce-setting]]
|
||||||
==== Index-level default
|
==== Index-level default
|
||||||
|
|
|
@ -48,7 +48,7 @@ GET my-index-000001/_search <4>
|
||||||
<4> Search returns both documents, but only the first is present in the terms aggregation.
|
<4> Search returns both documents, but only the first is present in the terms aggregation.
|
||||||
|
|
||||||
TIP: The `ignore_above` setting can be updated on
|
TIP: The `ignore_above` setting can be updated on
|
||||||
existing fields using the <<indices-put-mapping,PUT mapping API>>.
|
existing fields using the <<indices-put-mapping,update mapping API>>.
|
||||||
|
|
||||||
This option is also useful for protecting against Lucene's term byte-length
|
This option is also useful for protecting against Lucene's term byte-length
|
||||||
limit of `32766`.
|
limit of `32766`.
|
||||||
|
|
|
@ -56,7 +56,7 @@ The `ignore_malformed` setting is currently supported by the following <<mapping
|
||||||
<<ip>>:: `ip` for IPv4 and IPv6 addresses
|
<<ip>>:: `ip` for IPv4 and IPv6 addresses
|
||||||
|
|
||||||
TIP: The `ignore_malformed` setting value can be updated on
|
TIP: The `ignore_malformed` setting value can be updated on
|
||||||
existing fields using the <<indices-put-mapping,PUT mapping API>>.
|
existing fields using the <<indices-put-mapping,update mapping API>>.
|
||||||
|
|
||||||
[[ignore-malformed-setting]]
|
[[ignore-malformed-setting]]
|
||||||
==== Index-level default
|
==== Index-level default
|
||||||
|
|
|
@ -61,7 +61,7 @@ GET my-index-000001/_search
|
||||||
NOTE: Multi-fields do not change the original `_source` field.
|
NOTE: Multi-fields do not change the original `_source` field.
|
||||||
|
|
||||||
TIP: New multi-fields can be added to existing
|
TIP: New multi-fields can be added to existing
|
||||||
fields using the <<indices-put-mapping,PUT mapping API>>.
|
fields using the <<indices-put-mapping,update mapping API>>.
|
||||||
|
|
||||||
==== Multi-fields with multiple analyzers
|
==== Multi-fields with multiple analyzers
|
||||||
|
|
||||||
|
|
|
@ -12,10 +12,10 @@ field. In particular, this is the case for fields that are used solely for
|
||||||
filtering or aggregations.
|
filtering or aggregations.
|
||||||
|
|
||||||
TIP: Norms can be disabled on existing fields using
|
TIP: Norms can be disabled on existing fields using
|
||||||
the <<indices-put-mapping,PUT mapping API>>.
|
the <<indices-put-mapping,update mapping API>>.
|
||||||
|
|
||||||
Norms can be disabled (but not reenabled after the fact), using the
|
Norms can be disabled (but not reenabled after the fact), using the
|
||||||
<<indices-put-mapping,PUT mapping API>> like so:
|
<<indices-put-mapping,update mapping API>> like so:
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
------------
|
------------
|
||||||
|
|
|
@ -7,7 +7,7 @@ contain sub-fields, called `properties`. These properties may be of any
|
||||||
be added:
|
be added:
|
||||||
|
|
||||||
* explicitly by defining them when <<indices-create-index,creating an index>>.
|
* explicitly by defining them when <<indices-create-index,creating an index>>.
|
||||||
* explicitly by defining them when adding or updating a mapping type with the <<indices-put-mapping,PUT mapping>> API.
|
* explicitly by defining them when adding or updating a mapping type with the <<indices-put-mapping,update mapping>> API.
|
||||||
* <<dynamic-mapping,dynamically>> just by indexing documents containing new fields.
|
* <<dynamic-mapping,dynamically>> just by indexing documents containing new fields.
|
||||||
|
|
||||||
Below is an example of adding `properties` to a mapping type, an `object`
|
Below is an example of adding `properties` to a mapping type, an `object`
|
||||||
|
@ -63,7 +63,7 @@ PUT my-index-000001/_doc/1 <4>
|
||||||
|
|
||||||
TIP: The `properties` setting is allowed to have different settings for fields
|
TIP: The `properties` setting is allowed to have different settings for fields
|
||||||
of the same name in the same index. New properties can be added to existing
|
of the same name in the same index. New properties can be added to existing
|
||||||
fields using the <<indices-put-mapping,PUT mapping API>>.
|
fields using the <<indices-put-mapping,update mapping API>>.
|
||||||
|
|
||||||
==== Dot notation
|
==== Dot notation
|
||||||
|
|
||||||
|
|
|
@ -76,5 +76,5 @@ See {defguide}/_index_time_search_as_you_type.html[Index time search-as-you-
|
||||||
type] for a full explanation of this example.
|
type] for a full explanation of this example.
|
||||||
|
|
||||||
TIP: The `search_analyzer` setting can be updated on existing fields
|
TIP: The `search_analyzer` setting can be updated on existing fields
|
||||||
using the <<indices-put-mapping,PUT mapping API>>. Note, that in order to do so,
|
using the <<indices-put-mapping,update mapping API>>. Note, that in order to do so,
|
||||||
any existing "analyzer" setting and "type" need to be repeated in the updated field definition.
|
any existing "analyzer" setting and "type" need to be repeated in the updated field definition.
|
||||||
|
|
|
@ -133,7 +133,7 @@ The following mapping parameters are accepted:
|
||||||
The maximum allowed depth of the flattened object field, in terms of nested
|
The maximum allowed depth of the flattened object field, in terms of nested
|
||||||
inner objects. If a flattened object field exceeds this limit, then an
|
inner objects. If a flattened object field exceeds this limit, then an
|
||||||
error will be thrown. Defaults to `20`. Note that `depth_limit` can be
|
error will be thrown. Defaults to `20`. Note that `depth_limit` can be
|
||||||
updated dynamically through the <<indices-put-mapping, put mapping>> API.
|
updated dynamically through the <<indices-put-mapping, update mapping>> API.
|
||||||
|
|
||||||
<<doc-values,`doc_values`>>::
|
<<doc-values,`doc_values`>>::
|
||||||
|
|
||||||
|
|
|
@ -53,7 +53,7 @@ PUT my-index-000001/_doc/match_value
|
||||||
|
|
||||||
Fields referred to in a percolator query must *already* exist in the mapping
|
Fields referred to in a percolator query must *already* exist in the mapping
|
||||||
associated with the index used for percolation. In order to make sure these fields exist,
|
associated with the index used for percolation. In order to make sure these fields exist,
|
||||||
add or update a mapping via the <<indices-create-index,create index>> or <<indices-put-mapping,put mapping>> APIs.
|
add or update a mapping via the <<indices-create-index,create index>> or <<indices-put-mapping,update mapping>> APIs.
|
||||||
|
|
||||||
=====================================
|
=====================================
|
||||||
|
|
||||||
|
|
|
@ -199,7 +199,7 @@ PUT my-index-000001
|
||||||
==== Enabling fielddata on `text` fields
|
==== Enabling fielddata on `text` fields
|
||||||
|
|
||||||
You can enable fielddata on an existing `text` field using the
|
You can enable fielddata on an existing `text` field using the
|
||||||
<<indices-put-mapping,PUT mapping API>> as follows:
|
<<indices-put-mapping,update mapping API>> as follows:
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
-----------------------------------
|
-----------------------------------
|
||||||
|
|
|
@ -49,16 +49,16 @@ Discontinue use of the `index.force_memory_term_dictionary` index setting.
|
||||||
Requests that include this setting will return an error.
|
Requests that include this setting will return an error.
|
||||||
====
|
====
|
||||||
|
|
||||||
.The put index template API's `template` parameter has been removed.
|
.The create or update index template API's `template` parameter has been removed.
|
||||||
[%collapsible]
|
[%collapsible]
|
||||||
====
|
====
|
||||||
*Details* +
|
*Details* +
|
||||||
In 6.0, we deprecated the `template` parameter in put index template requests
|
In 6.0, we deprecated the `template` parameter in create or update index
|
||||||
in favor of using `index_patterns`. Support for the `template` parameter is now
|
template requests in favor of using `index_patterns`. Support for the `template`
|
||||||
removed in 8.0.
|
parameter is now removed in 8.0.
|
||||||
|
|
||||||
*Impact* +
|
*Impact* +
|
||||||
Use the {ref}/indices-templates-v1.html[put index template API]'s
|
Use the {ref}/indices-templates-v1.html[create or update index template API]'s
|
||||||
`index_patterns` parameter. Requests that include the `template` parameter will
|
`index_patterns` parameter. Requests that include the `template` parameter will
|
||||||
return an error.
|
return an error.
|
||||||
====
|
====
|
||||||
|
|
|
@ -27,7 +27,7 @@ than 10 completion contexts will return an error.
|
||||||
[%collapsible]
|
[%collapsible]
|
||||||
====
|
====
|
||||||
*Details* +
|
*Details* +
|
||||||
The typed REST endpoints of the Put Mapping, Get Mapping and Get Field mapping
|
The typed REST endpoints of the update mapping, get mapping and get field mapping
|
||||||
APIs have been removed in favour of their typeless REST endpoints, since indexes
|
APIs have been removed in favour of their typeless REST endpoints, since indexes
|
||||||
no longer contain types, these typed endpoints are obsolete.
|
no longer contain types, these typed endpoints are obsolete.
|
||||||
|
|
||||||
|
|
|
@ -35,7 +35,7 @@ each interval. See {ml-docs}/ml-delayed-data-detection.html[Handling delayed dat
|
||||||
|
|
||||||
[IMPORTANT]
|
[IMPORTANT]
|
||||||
====
|
====
|
||||||
* You must use {kib} or this API to create a {dfeed}. Do not put a
|
* You must use {kib} or this API to create a {dfeed}. Do not add a
|
||||||
{dfeed} directly to the `.ml-config` index using the {es} index API. If {es}
|
{dfeed} directly to the `.ml-config` index using the {es} index API. If {es}
|
||||||
{security-features} are enabled, do not give users `write` privileges on the
|
{security-features} are enabled, do not give users `write` privileges on the
|
||||||
`.ml-config` index.
|
`.ml-config` index.
|
||||||
|
|
|
@ -202,7 +202,7 @@ cluster. This setting has three valid values:
|
||||||
--
|
--
|
||||||
`all`::: All operations on the node (both read and write operations) are rejected.
|
`all`::: All operations on the node (both read and write operations) are rejected.
|
||||||
This also applies for API cluster state read or write operations, like the get
|
This also applies for API cluster state read or write operations, like the get
|
||||||
index settings, put mapping and cluster state API.
|
index settings, update mapping, and cluster state API.
|
||||||
|
|
||||||
`write`::: (default) Write operations are rejected. Read operations succeed,
|
`write`::: (default) Write operations are rejected. Read operations succeed,
|
||||||
based on the last known cluster configuration. This situation may result in
|
based on the last known cluster configuration. This situation may result in
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[slm-api-put-policy]]
|
[[slm-api-put-policy]]
|
||||||
=== Put snapshot lifecycle policy API
|
=== Create or update snapshot lifecycle policy API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Put policy</titleabbrev>
|
<titleabbrev>Create or update policy</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Creates or updates a snapshot lifecycle policy.
|
Creates or updates a snapshot lifecycle policy.
|
||||||
|
@ -23,7 +23,7 @@ For more information, see <<security-privileges>>.
|
||||||
[[slm-api-put-desc]]
|
[[slm-api-put-desc]]
|
||||||
==== {api-description-title}
|
==== {api-description-title}
|
||||||
|
|
||||||
Use the put snapshot lifecycle policy API
|
Use the create or update snapshot lifecycle policy API
|
||||||
to create or update a snapshot lifecycle policy.
|
to create or update a snapshot lifecycle policy.
|
||||||
|
|
||||||
If the policy already exists,
|
If the policy already exists,
|
||||||
|
|
|
@ -28,7 +28,7 @@ Remote repositories are generally used for production deployments.
|
||||||
|
|
||||||
For this tutorial, you can register a local repository from
|
For this tutorial, you can register a local repository from
|
||||||
{kibana-ref}/snapshot-repositories.html[{kib} Management]
|
{kibana-ref}/snapshot-repositories.html[{kib} Management]
|
||||||
or use the put repository API:
|
or use the create or update repository API:
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
-----------------------------------
|
-----------------------------------
|
||||||
|
@ -55,12 +55,13 @@ automatically delete snapshots when they are no longer needed.
|
||||||
TIP: Don't be afraid to configure a policy that takes frequent snapshots.
|
TIP: Don't be afraid to configure a policy that takes frequent snapshots.
|
||||||
Snapshots are incremental and make efficient use of storage.
|
Snapshots are incremental and make efficient use of storage.
|
||||||
|
|
||||||
You can define and manage policies through {kib} Management or with the put policy API.
|
You can define and manage policies through {kib} Management or with the create
|
||||||
|
or update policy API.
|
||||||
|
|
||||||
For example, you could define a `nightly-snapshots` policy
|
For example, you could define a `nightly-snapshots` policy
|
||||||
to back up all of your data streams and indices daily at 2:30AM UTC.
|
to back up all of your data streams and indices daily at 2:30AM UTC.
|
||||||
|
|
||||||
A put policy request defines the policy configuration in JSON:
|
A create or update policy request defines the policy configuration in JSON:
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
|
|
@ -52,7 +52,9 @@ cluster, as well as the cluster state. You can change this behavior by
|
||||||
specifying a list of data streams and indices to back up in the body of the
|
specifying a list of data streams and indices to back up in the body of the
|
||||||
snapshot request.
|
snapshot request.
|
||||||
|
|
||||||
NOTE: You must register a snapshot repository before performing snapshot and restore operations. Use the <<put-snapshot-repo-api,put snapshot repository API>> to register new repositories and update existing ones.
|
NOTE: You must register a snapshot repository before performing snapshot and
|
||||||
|
restore operations. Use the <<put-snapshot-repo-api,create or update snapshot
|
||||||
|
repository API>> to register new repositories and update existing ones.
|
||||||
|
|
||||||
The snapshot process is incremental. When creating a snapshot, {es} analyzes the list of files that are already stored in the repository and copies only files that were created or changed since the last snapshot. This process allows multiple snapshots to be preserved in the repository in a compact form.
|
The snapshot process is incremental. When creating a snapshot, {es} analyzes the list of files that are already stored in the repository and copies only files that were created or changed since the last snapshot. This process allows multiple snapshots to be preserved in the repository in a compact form.
|
||||||
|
|
||||||
|
|
|
@ -112,8 +112,9 @@ Contains settings for the repository. Valid properties for the `settings` object
|
||||||
depend on the repository type, set using the
|
depend on the repository type, set using the
|
||||||
<<put-snapshot-repo-api-request-type,`type`>> parameter.
|
<<put-snapshot-repo-api-request-type,`type`>> parameter.
|
||||||
+
|
+
|
||||||
For properties, see the <<put-snapshot-repo-api,put snapshot repository API>>'s
|
For properties, see the <<put-snapshot-repo-api,create or update snapshot
|
||||||
<<put-snapshot-repo-api-settings-param,`settings` parameter>>.
|
repository API>>'s <<put-snapshot-repo-api-settings-param,`settings`
|
||||||
|
parameter>>.
|
||||||
====
|
====
|
||||||
|
|
||||||
[[get-snapshot-repo-api-example]]
|
[[get-snapshot-repo-api-example]]
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[[put-snapshot-repo-api]]
|
[[put-snapshot-repo-api]]
|
||||||
=== Put snapshot repository API
|
=== Create or update snapshot repository API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Put snapshot repository</titleabbrev>
|
<titleabbrev>Create or update snapshot repository</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Registers or updates a <<snapshots-register-repository,snapshot repository>>.
|
Registers or updates a <<snapshots-register-repository,snapshot repository>>.
|
||||||
|
|
|
@ -9,7 +9,7 @@ For more information, see <<snapshot-restore>>.
|
||||||
[discrete]
|
[discrete]
|
||||||
[[snapshot-restore-repo-apis]]
|
[[snapshot-restore-repo-apis]]
|
||||||
=== Snapshot repository management APIs
|
=== Snapshot repository management APIs
|
||||||
* <<put-snapshot-repo-api,Put snapshot repository>>
|
* <<put-snapshot-repo-api,Create or snapshot repository>>
|
||||||
* <<verify-snapshot-repo-api,Verify snapshot repository>>
|
* <<verify-snapshot-repo-api,Verify snapshot repository>>
|
||||||
* <<get-snapshot-repo-api,Get snapshot repository>>
|
* <<get-snapshot-repo-api,Get snapshot repository>>
|
||||||
* <<delete-snapshot-repo-api,Delete snapshot repository>>
|
* <<delete-snapshot-repo-api,Delete snapshot repository>>
|
||||||
|
|
|
@ -39,13 +39,13 @@ POST /_snapshot/my_repository/_verify
|
||||||
[[verify-snapshot-repo-api-desc]]
|
[[verify-snapshot-repo-api-desc]]
|
||||||
==== {api-description-title}
|
==== {api-description-title}
|
||||||
|
|
||||||
By default, <<put-snapshot-repo-api,put snapshot repository API>> requests
|
By default, <<put-snapshot-repo-api,create or update snapshot repository API>>
|
||||||
verify that a snapshot is functional on all master and data nodes in the
|
requests verify that a snapshot is functional on all master and data nodes in
|
||||||
cluster.
|
the cluster.
|
||||||
|
|
||||||
You can skip this verification using the put snapshot repository API's `verify`
|
You can skip this verification using the create or update snapshot repository
|
||||||
parameter. You can then use the verify snapshot repository API to manually
|
API's `verify` parameter. You can then use the verify snapshot repository API to
|
||||||
verify the repository.
|
manually verify the repository.
|
||||||
|
|
||||||
If verification is successful, the verify snapshot repository API returns a list
|
If verification is successful, the verify snapshot repository API returns a list
|
||||||
of nodes connected to the snapshot repository. If verification failed, the API
|
of nodes connected to the snapshot repository. If verification failed, the API
|
||||||
|
|
|
@ -7,8 +7,10 @@
|
||||||
[[snapshots-register-repository-description]]
|
[[snapshots-register-repository-description]]
|
||||||
// tag::snapshots-register-repository-tag[]
|
// tag::snapshots-register-repository-tag[]
|
||||||
You must register a snapshot repository before you can perform snapshot and
|
You must register a snapshot repository before you can perform snapshot and
|
||||||
restore operations. Use the <<put-snapshot-repo-api,put snapshot repository API>> to register or update a snapshot repository. We recommend creating a new snapshot repository for each
|
restore operations. Use the <<put-snapshot-repo-api,create or update snapshot
|
||||||
major version. The valid repository settings depend on the repository type.
|
repository API>> to register or update a snapshot repository. We recommend
|
||||||
|
creating a new snapshot repository for each major version. The valid repository
|
||||||
|
settings depend on the repository type.
|
||||||
|
|
||||||
If you register the same snapshot repository with multiple clusters, only
|
If you register the same snapshot repository with multiple clusters, only
|
||||||
one cluster should have write access to the repository. All other clusters
|
one cluster should have write access to the repository. All other clusters
|
||||||
|
|
|
@ -4,7 +4,10 @@
|
||||||
A repository can contain multiple snapshots of the same cluster. Snapshots are identified by unique names within the
|
A repository can contain multiple snapshots of the same cluster. Snapshots are identified by unique names within the
|
||||||
cluster.
|
cluster.
|
||||||
|
|
||||||
Use the <<put-snapshot-repo-api,put snapshot repository API>> to register or update a snapshot repository, and then use the <<create-snapshot-api,create snapshot API>> to create a snapshot in a repository.
|
Use the <<put-snapshot-repo-api,create or update snapshot repository API>> to
|
||||||
|
register or update a snapshot repository, and then use the
|
||||||
|
<<create-snapshot-api,create snapshot API>> to create a snapshot in a
|
||||||
|
repository.
|
||||||
|
|
||||||
The following request creates a snapshot with the name `snapshot_1` in the repository `my_backup`:
|
The following request creates a snapshot with the name `snapshot_1` in the repository `my_backup`:
|
||||||
|
|
||||||
|
|
|
@ -9,9 +9,9 @@ path:
|
||||||
- /mount/long_term_backups
|
- /mount/long_term_backups
|
||||||
----
|
----
|
||||||
|
|
||||||
After restarting each node, use the <<put-snapshot-repo-api,put snapshot
|
After restarting each node, use the <<put-snapshot-repo-api,create or update
|
||||||
repository>> API to register the file system repository. Specify the file
|
snapshot repository>> API to register the file system repository. Specify the
|
||||||
system's path in `settings.location`:
|
file system's path in `settings.location`:
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
----
|
----
|
||||||
|
@ -64,9 +64,9 @@ path:
|
||||||
<1> DOS path
|
<1> DOS path
|
||||||
<2> UNC path
|
<2> UNC path
|
||||||
|
|
||||||
After restarting each node, use the <<put-snapshot-repo-api,put snapshot
|
After restarting each node, use the <<put-snapshot-repo-api,create or update
|
||||||
repository>> API to register the file system repository. Specify the file
|
snapshot repository>> API to register the file system repository. Specify the
|
||||||
system's path in `settings.location`:
|
file system's path in `settings.location`:
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
----
|
----
|
||||||
|
|
|
@ -56,7 +56,7 @@ 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
|
privileges on the source and destination indices, the {transform} fails when it
|
||||||
attempts unauthorized operations.
|
attempts unauthorized operations.
|
||||||
|
|
||||||
IMPORTANT: You must use {kib} or this API to create a {transform}. Do not put a
|
IMPORTANT: You must use {kib} or this API to create a {transform}. Do not add a
|
||||||
{transform} directly into any `.transform-internal*` indices using the {es}
|
{transform} directly into any `.transform-internal*` indices using the {es}
|
||||||
index API. If {es} {security-features} are enabled, do not give users any
|
index API. If {es} {security-features} are enabled, do not give users any
|
||||||
privileges on `.transform-internal*` indices. If you used {transforms} prior to
|
privileges on `.transform-internal*` indices. If you used {transforms} prior to
|
||||||
|
|
|
@ -10,6 +10,6 @@ Management]:
|
||||||
* <<logstash-api-get-pipeline>>
|
* <<logstash-api-get-pipeline>>
|
||||||
* <<logstash-api-delete-pipeline>>
|
* <<logstash-api-delete-pipeline>>
|
||||||
|
|
||||||
|
include::put-pipeline.asciidoc[]
|
||||||
include::delete-pipeline.asciidoc[]
|
include::delete-pipeline.asciidoc[]
|
||||||
include::get-pipeline.asciidoc[]
|
include::get-pipeline.asciidoc[]
|
||||||
include::put-pipeline.asciidoc[]
|
|
||||||
|
|
|
@ -1,9 +1,9 @@
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[testenv="basic"]
|
[testenv="basic"]
|
||||||
[[logstash-api-put-pipeline]]
|
[[logstash-api-put-pipeline]]
|
||||||
=== Put {ls} pipeline API
|
=== Create or update {ls} pipeline API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Put {ls} pipeline</titleabbrev>
|
<titleabbrev>Create or update {ls} pipeline</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
This API creates or updates a {ls} pipeline used for
|
This API creates or updates a {ls} pipeline used for
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[[watcher-api-put-watch]]
|
[[watcher-api-put-watch]]
|
||||||
=== Put watch API
|
=== Create or update watch API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Put watch</titleabbrev>
|
<titleabbrev>Create or update watch</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Either registers a new watch in {watcher} or updates an existing one.
|
Either registers a new watch in {watcher} or updates an existing one.
|
||||||
|
@ -26,7 +26,7 @@ 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. Typically for the `schedule` trigger, the scheduler is the
|
||||||
trigger engine.
|
trigger engine.
|
||||||
|
|
||||||
IMPORTANT: You must use {kib} or this API to create a watch. Do not put a watch
|
IMPORTANT: You must use {kib} or this API to create a watch. Do not add a watch
|
||||||
directly to the `.watches` index using the Elasticsearch index API.
|
directly to the `.watches` index using the Elasticsearch index API.
|
||||||
If {es} {security-features} are enabled, do not give users `write`
|
If {es} {security-features} are enabled, do not give users `write`
|
||||||
privileges on the `.watches` index.
|
privileges on the `.watches` index.
|
||||||
|
|
|
@ -91,22 +91,22 @@ invoked to invalidate one or more API keys.
|
||||||
| `{"type":"audit", "timestamp":"2020-12-31T00:36:30,247+0200", "node.id":"9clhpgjJRR-iKzOw20xBNQ", "event.type":"security_config_change", "event.action":"invalidate_apikeys", "request.id":"7lyIQU9QTFqSrTxD0CqnTQ", "invalidate":{"apikeys":{"owned_by_authenticated_user":false,"user":{"name":"myuser","realm":"native1"}}}}`
|
| `{"type":"audit", "timestamp":"2020-12-31T00:36:30,247+0200", "node.id":"9clhpgjJRR-iKzOw20xBNQ", "event.type":"security_config_change", "event.action":"invalidate_apikeys", "request.id":"7lyIQU9QTFqSrTxD0CqnTQ", "invalidate":{"apikeys":{"owned_by_authenticated_user":false,"user":{"name":"myuser","realm":"native1"}}}}`
|
||||||
|
|
||||||
| `put_privileges`
|
| `put_privileges`
|
||||||
| Logged when the <<security-api-put-privileges,put privileges API>> is invoked
|
| Logged when the <<security-api-put-privileges,create or update privileges API>> is invoked
|
||||||
to add or update one or more application privileges.
|
to add or update one or more application privileges.
|
||||||
| `{"type":"audit", "timestamp":"2020-12-31T00:39:07,779+0200", "node.id":"9clhpgjJRR-iKzOw20xBNQ", "event.type":"security_config_change", "event.action":"put_privileges", "request.id":"1X2VVtNgRYO7FmE0nR_BGA", "put":{"privileges":[{"application":"myapp","name":"read","actions":["data:read/*","action:login"],"metadata":{"description":"Read access to myapp"}}]}}`
|
| `{"type":"audit", "timestamp":"2020-12-31T00:39:07,779+0200", "node.id":"9clhpgjJRR-iKzOw20xBNQ", "event.type":"security_config_change", "event.action":"put_privileges", "request.id":"1X2VVtNgRYO7FmE0nR_BGA", "put":{"privileges":[{"application":"myapp","name":"read","actions":["data:read/*","action:login"],"metadata":{"description":"Read access to myapp"}}]}}`
|
||||||
|
|
||||||
| `put_role`
|
| `put_role`
|
||||||
| Logged when the <<security-api-put-role,put role API>> is invoked to create or
|
| Logged when the <<security-api-put-role,create or update role API>> is invoked to create or
|
||||||
update a role.
|
update a role.
|
||||||
| `{"type":"audit", "timestamp":"2020-12-30T22:27:01,978+0200", "node.id":"0RMNyghkQYCc_gVd1G6tZQ", "event.type":"security_config_change", "event.action":"put_role", "request.id":"tDYQhv5CRMWM4Sc5Zkk2cQ", "put":{"role":{"name":"test_role","role_descriptor":{"cluster":["all"],"indices":[{"names":["apm*"],"privileges":["all"],"field_security":{"grant":["granted"]},"query":"{\"term\": {\"service.name\": \"bar\"}}"},{"names":["apm-all*"],"privileges":["all"],"query":"{\"term\": {\"service.name\": \"bar2\"}}"}],"applications":[],"run_as":[]}}}}`
|
| `{"type":"audit", "timestamp":"2020-12-30T22:27:01,978+0200", "node.id":"0RMNyghkQYCc_gVd1G6tZQ", "event.type":"security_config_change", "event.action":"put_role", "request.id":"tDYQhv5CRMWM4Sc5Zkk2cQ", "put":{"role":{"name":"test_role","role_descriptor":{"cluster":["all"],"indices":[{"names":["apm*"],"privileges":["all"],"field_security":{"grant":["granted"]},"query":"{\"term\": {\"service.name\": \"bar\"}}"},{"names":["apm-all*"],"privileges":["all"],"query":"{\"term\": {\"service.name\": \"bar2\"}}"}],"applications":[],"run_as":[]}}}}`
|
||||||
|
|
||||||
| `put_role_mapping`
|
| `put_role_mapping`
|
||||||
| Logged when the <<security-api-put-role-mapping,put role mapping API>> is
|
| Logged when the <<security-api-put-role-mapping,create or update role mapping API>> is
|
||||||
invoked to create or update a role mapping.
|
invoked to create or update a role mapping.
|
||||||
| `{"type":"audit", "timestamp":"2020-12-31T00:11:13,932+0200", "node.id":"0RMNyghkQYCc_gVd1G6tZQ", "event.type":"security_config_change", "event.action":"put_role_mapping", "request.id":"kg4h1l_kTDegnLC-0A-XxA", "put":{"role_mapping":{"name":"mapping1","roles":["user"],"rules":{"field":{"username":"*"}},"enabled":true,"metadata":{"version":1}}}}`
|
| `{"type":"audit", "timestamp":"2020-12-31T00:11:13,932+0200", "node.id":"0RMNyghkQYCc_gVd1G6tZQ", "event.type":"security_config_change", "event.action":"put_role_mapping", "request.id":"kg4h1l_kTDegnLC-0A-XxA", "put":{"role_mapping":{"name":"mapping1","roles":["user"],"rules":{"field":{"username":"*"}},"enabled":true,"metadata":{"version":1}}}}`
|
||||||
|
|
||||||
| `put_user`
|
| `put_user`
|
||||||
| Logged when the <<security-api-put-user,put user API>> is invoked to create or
|
| Logged when the <<security-api-put-user,create or update user API>> is invoked to create or
|
||||||
update a native user. Note that user updates can also change the
|
update a native user. Note that user updates can also change the
|
||||||
user's password.
|
user's password.
|
||||||
| `{"type":"audit", "timestamp":"2020-12-30T22:10:09,749+0200", "node.id":"0RMNyghkQYCc_gVd1G6tZQ", "event.type":"security_config_change", "event.action":"put_user", "request.id":"VIiSvhp4Riim_tpkQCVSQA", "put":{"user":{"name":"user1","enabled":false,"roles":["admin","other_role1"],"full_name":"Jack Sparrow","email":"jack@blackpearl.com","has_password":true,"metadata":{"cunning":10}}}}`
|
| `{"type":"audit", "timestamp":"2020-12-30T22:10:09,749+0200", "node.id":"0RMNyghkQYCc_gVd1G6tZQ", "event.type":"security_config_change", "event.action":"put_user", "request.id":"VIiSvhp4Riim_tpkQCVSQA", "put":{"user":{"name":"user1","enabled":false,"roles":["admin","other_role1"],"full_name":"Jack Sparrow","email":"jack@blackpearl.com","has_password":true,"metadata":{"cunning":10}}}}`
|
||||||
|
|
|
@ -213,7 +213,7 @@ non-existent index or data stream rather than an explicit
|
||||||
auto-update of mappings on indices and data streams if they do not contradict
|
auto-update of mappings on indices and data streams if they do not contradict
|
||||||
existing mappings. An auto-update mapping action is the result of an index or
|
existing mappings. An auto-update mapping action is the result of an index or
|
||||||
bulk request on an index or data stream that contains new fields that may
|
bulk request on an index or data stream that contains new fields that may
|
||||||
be mapped rather than an explicit <<indices-put-mapping,put mapping>> request.
|
be mapped rather than an explicit <<indices-put-mapping,update mapping>> request.
|
||||||
|
|
||||||
`create`::
|
`create`::
|
||||||
Privilege to index documents. Also grants access to the update mapping
|
Privilege to index documents. Also grants access to the update mapping
|
||||||
|
|
|
@ -43,9 +43,8 @@ Specify what happens when the watch condition is met.
|
||||||
|
|
||||||
[[watch-definition-example]]
|
[[watch-definition-example]]
|
||||||
|
|
||||||
For example, the following snippet shows a
|
For example, the following snippet shows a <<watcher-api-put-watch,create or
|
||||||
<<watcher-api-put-watch,put watch>> request that defines a watch that
|
update watch>> request that defines a watch that looks for log error events:
|
||||||
looks for log error events:
|
|
||||||
|
|
||||||
[source,console]
|
[source,console]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
|
|
@ -1,14 +1,14 @@
|
||||||
[discrete]
|
[discrete]
|
||||||
[[api-java-put-watch]]
|
[[api-java-put-watch]]
|
||||||
=== Put watch API
|
=== Create or update watch API
|
||||||
|
|
||||||
The put watch API either registers a new watch in {watcher} or update an
|
The create or update watch API either registers a new watch in {watcher} or
|
||||||
existing one. Once registered, a new document will be added to the `.watches`
|
update an existing one. Once registered, a new document will be added to the
|
||||||
index, representing the watch, and the watch trigger will immediately be
|
`.watches` index, representing the watch, and the watch trigger will immediately
|
||||||
registered with the relevant trigger engine (typically the scheduler, for the
|
be registered with the relevant trigger engine (typically the scheduler, for the
|
||||||
`schedule` trigger).
|
`schedule` trigger).
|
||||||
|
|
||||||
IMPORTANT: Putting a watch must be done via this API only. Do not put a watch
|
IMPORTANT: Putting a watch must be done via this API only. Do not add a watch
|
||||||
directly to the `.watches` index using Elasticsearch's Index API.
|
directly to the `.watches` index using Elasticsearch's Index API.
|
||||||
When the {es} {security-features} are enabled, make sure no `write`
|
When the {es} {security-features} are enabled, make sure no `write`
|
||||||
privileges are granted to anyone over the `.watches` index.
|
privileges are granted to anyone over the `.watches` index.
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
|
|
||||||
{watcher} provides as set of APIs you can use to manage your watches:
|
{watcher} provides as set of APIs you can use to manage your watches:
|
||||||
|
|
||||||
* Use the <<watcher-api-put-watch,put watch API>> to add or update watches
|
* Use the <<watcher-api-put-watch,create or update watch API>> to add or update watches
|
||||||
* Use the <<watcher-api-get-watch,get watch API>> to retrieve watches
|
* Use the <<watcher-api-get-watch,get watch API>> to retrieve watches
|
||||||
* Use the <<watcher-api-delete-watch,delete watch API>> to delete watches
|
* Use the <<watcher-api-delete-watch,delete watch API>> to delete watches
|
||||||
* Use the <<watcher-api-activate-watch,activate watch API>> to activate watches
|
* Use the <<watcher-api-activate-watch,activate watch API>> to activate watches
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue