elasticsearch-js/docs/reference/api/CcrPutAutoFollowPatternRequest.md

CcrPutAutoFollowPatternRequest [interface-CcrPutAutoFollowPatternRequest]

Name	Type	Description
body	string	({ [key: string]: any; } & { name?: never; master_timeout?: never; remote_cluster?: never; follow_index_pattern?: never; leader_index_patterns?: never; leader_index_exclusion_patterns?: never; max_outstanding_read_requests?: never; settings?: never; max_outstanding_write_requests?: never; read_poll_timeout?: never; max_read_request_operation_count?: never; max_read_request_size?: never; max_retry_delay?: never; max_write_buffer_count?: never; max_write_buffer_size?: never; max_write_request_operation_count?: never; max_write_request_size?: never; })
follow_index_pattern	IndexPattern	The name of follower index. The template { { leader_index } } can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use { { leader_index } } ; CCR does not support changes to the names of a follower data stream’s backing indices.
leader_index_exclusion_patterns	IndexPatterns	An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.
leader_index_patterns	IndexPatterns	An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.
master_timeout	Duration	Period to wait for a connection to the master node.
max_outstanding_read_requests	integer	The maximum number of outstanding reads requests from the remote cluster.
max_outstanding_write_requests	integer	The maximum number of outstanding reads requests from the remote cluster.
max_read_request_operation_count	integer	The maximum number of operations to pull per read from the remote cluster.
max_read_request_size	ByteSize	The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.
max_retry_delay	Duration	The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.
max_write_buffer_count	integer	The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.
max_write_buffer_size	ByteSize	The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.
max_write_request_operation_count	integer	The maximum number of operations per bulk write request executed on the follower.
max_write_request_size	ByteSize	The maximum total bytes of operations per bulk write request executed on the follower.
name	Name	The name of the collection of auto-follow patterns.
querystring	{ [key: string]: any; } & { name?: never; master_timeout?: never; remote_cluster?: never; follow_index_pattern?: never; leader_index_patterns?: never; leader_index_exclusion_patterns?: never; max_outstanding_read_requests?: never; settings?: never; max_outstanding_write_requests?: never; read_poll_timeout?: never; max_read_request_operation_count?: never; max_read_request_size?: never; max_retry_delay?: never; max_write_buffer_count?: never; max_write_buffer_size?: never; max_write_request_operation_count?: never; max_write_request_size?: never; }	All values in querystring will be added to the request querystring.
read_poll_timeout	Duration	The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.
remote_cluster	string	The remote cluster containing the leader indices to match against.
settings	Record<string, any>	Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).