Files
elasticsearch-js/docs/reference-ccr-put_auto_follow_pattern.asciidoc
2024-12-05 14:46:52 -06:00

87 lines
4.7 KiB
Plaintext

[[reference-ccr-put_auto_follow_pattern]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
[[client.ccr.putAutoFollowPattern]]
=== client.ccr.putAutoFollowPattern
Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.
{ref}/ccr-put-auto-follow-pattern.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(CcrPutAutoFollowPatternRequest, options?): Promise<CcrPutAutoFollowPatternResponse>
----
[discrete]
==== CcrPutAutoFollowPatternRequest
[pass]
++++
<pre>
++++
interface CcrPutAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
remote_cluster: string
follow_index_pattern?: <<IndexPattern>>
leader_index_patterns?: <<IndexPatterns>>
leader_index_exclusion_patterns?: <<IndexPatterns>>
max_outstanding_read_requests?: <<integer>>
settings?: Record<string, any>
max_outstanding_write_requests?: <<integer>>
read_poll_timeout?: <<Duration>>
max_read_request_operation_count?: <<integer>>
max_read_request_size?: <<ByteSize>>
max_retry_delay?: <<Duration>>
max_write_buffer_count?: <<integer>>
max_write_buffer_size?: <<ByteSize>>
max_write_request_operation_count?: <<integer>>
max_write_request_size?: <<ByteSize>>
}
[pass]
++++
</pre>
++++
[discrete]
==== CcrPutAutoFollowPatternResponse
[pass]
++++
<pre>
++++
type CcrPutAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++