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

Interface CcrFollowRequest

Name	Type	Description
body	string	({ [key: string]: any; } & { index?: never; master_timeout?: never; wait_for_active_shards?: never; data_stream_name?: never; leader_index?: never; max_outstanding_read_requests?: never; max_outstanding_write_requests?: 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; read_poll_timeout?: never; remote_cluster?: never; settings?: never; })
data_stream_name	string	If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.
index	IndexName	The name of the follower index.
leader_index	IndexName	The name of the index in the leader cluster to follow.
master_timeout	Duration	Period to wait for a connection to the master node.
max_outstanding_read_requests	long	The maximum number of outstanding reads requests from the remote cluster.
max_outstanding_write_requests	integer	The maximum number of outstanding write requests on the follower.
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.
querystring	{ [key: string]: any; } & { index?: never; master_timeout?: never; wait_for_active_shards?: never; data_stream_name?: never; leader_index?: never; max_outstanding_read_requests?: never; max_outstanding_write_requests?: 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; read_poll_timeout?: never; remote_cluster?: never; settings?: 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 index.
settings	IndicesIndexSettings	Settings to override from the leader index.
wait_for_active_shards	WaitForActiveShards	Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be active. A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the remote Lucene segment files to the follower index.