elasticsearch/_async/client/ccr.py [615:754]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
self,
*,
name: str,
remote_cluster: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
follow_index_pattern: t.Optional[str] = None,
human: t.Optional[bool] = None,
leader_index_exclusion_patterns: t.Optional[t.Sequence[str]] = None,
leader_index_patterns: t.Optional[t.Sequence[str]] = None,
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
max_outstanding_read_requests: t.Optional[int] = None,
max_outstanding_write_requests: t.Optional[int] = None,
max_read_request_operation_count: t.Optional[int] = None,
max_read_request_size: t.Optional[t.Union[int, str]] = None,
max_retry_delay: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
max_write_buffer_count: t.Optional[int] = None,
max_write_buffer_size: t.Optional[t.Union[int, str]] = None,
max_write_request_operation_count: t.Optional[int] = None,
max_write_request_size: t.Optional[t.Union[int, str]] = None,
pretty: t.Optional[bool] = None,
read_poll_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
settings: t.Optional[t.Mapping[str, t.Any]] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
Create or update auto-follow patterns.
Create a collection of cross-cluster replication auto-follow patterns for a remote cluster.
Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.
Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.
This API can also be used to update auto-follow patterns.
NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.
``_
:param name: The name of the collection of auto-follow patterns.
:param remote_cluster: The remote cluster containing the leader indices to match
against.
:param follow_index_pattern: 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.
:param leader_index_exclusion_patterns: 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.
:param leader_index_patterns: An array of simple index patterns to match against
indices in the remote cluster specified by the remote_cluster field.
:param master_timeout: Period to wait for a connection to the master node.
:param max_outstanding_read_requests: The maximum number of outstanding reads
requests from the remote cluster.
:param max_outstanding_write_requests: The maximum number of outstanding reads
requests from the remote cluster.
:param max_read_request_operation_count: The maximum number of operations to
pull per read from the remote cluster.
:param max_read_request_size: The maximum size in bytes of per read of a batch
of operations pulled from the remote cluster.
:param max_retry_delay: The maximum time to wait before retrying an operation
that failed exceptionally. An exponential backoff strategy is employed when
retrying.
:param max_write_buffer_count: 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.
:param max_write_buffer_size: 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.
:param max_write_request_operation_count: The maximum number of operations per
bulk write request executed on the follower.
:param max_write_request_size: The maximum total bytes of operations per bulk
write request executed on the follower.
:param read_poll_timeout: 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.
:param settings: Settings to override from the leader index. Note that certain
settings can not be overrode (e.g., index.number_of_shards).
"""
if name in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'name'")
if remote_cluster is None and body is None:
raise ValueError("Empty value passed for parameter 'remote_cluster'")
__path_parts: t.Dict[str, str] = {"name": _quote(name)}
__path = f'/_ccr/auto_follow/{__path_parts["name"]}'
__query: t.Dict[str, t.Any] = {}
__body: t.Dict[str, t.Any] = body if body is not None else {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if pretty is not None:
__query["pretty"] = pretty
if not __body:
if remote_cluster is not None:
__body["remote_cluster"] = remote_cluster
if follow_index_pattern is not None:
__body["follow_index_pattern"] = follow_index_pattern
if leader_index_exclusion_patterns is not None:
__body["leader_index_exclusion_patterns"] = (
leader_index_exclusion_patterns
)
if leader_index_patterns is not None:
__body["leader_index_patterns"] = leader_index_patterns
if max_outstanding_read_requests is not None:
__body["max_outstanding_read_requests"] = max_outstanding_read_requests
if max_outstanding_write_requests is not None:
__body["max_outstanding_write_requests"] = (
max_outstanding_write_requests
)
if max_read_request_operation_count is not None:
__body["max_read_request_operation_count"] = (
max_read_request_operation_count
)
if max_read_request_size is not None:
__body["max_read_request_size"] = max_read_request_size
if max_retry_delay is not None:
__body["max_retry_delay"] = max_retry_delay
if max_write_buffer_count is not None:
__body["max_write_buffer_count"] = max_write_buffer_count
if max_write_buffer_size is not None:
__body["max_write_buffer_size"] = max_write_buffer_size
if max_write_request_operation_count is not None:
__body["max_write_request_operation_count"] = (
max_write_request_operation_count
)
if max_write_request_size is not None:
__body["max_write_request_size"] = max_write_request_size
if read_poll_timeout is not None:
__body["read_poll_timeout"] = read_poll_timeout
if settings is not None:
__body["settings"] = settings
__headers = {"accept": "application/json", "content-type": "application/json"}
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elasticsearch/_sync/client/ccr.py [615:754]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
self,
*,
name: str,
remote_cluster: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
follow_index_pattern: t.Optional[str] = None,
human: t.Optional[bool] = None,
leader_index_exclusion_patterns: t.Optional[t.Sequence[str]] = None,
leader_index_patterns: t.Optional[t.Sequence[str]] = None,
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
max_outstanding_read_requests: t.Optional[int] = None,
max_outstanding_write_requests: t.Optional[int] = None,
max_read_request_operation_count: t.Optional[int] = None,
max_read_request_size: t.Optional[t.Union[int, str]] = None,
max_retry_delay: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
max_write_buffer_count: t.Optional[int] = None,
max_write_buffer_size: t.Optional[t.Union[int, str]] = None,
max_write_request_operation_count: t.Optional[int] = None,
max_write_request_size: t.Optional[t.Union[int, str]] = None,
pretty: t.Optional[bool] = None,
read_poll_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
settings: t.Optional[t.Mapping[str, t.Any]] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
Create or update auto-follow patterns.
Create a collection of cross-cluster replication auto-follow patterns for a remote cluster.
Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.
Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.
This API can also be used to update auto-follow patterns.
NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.
``_
:param name: The name of the collection of auto-follow patterns.
:param remote_cluster: The remote cluster containing the leader indices to match
against.
:param follow_index_pattern: 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.
:param leader_index_exclusion_patterns: 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.
:param leader_index_patterns: An array of simple index patterns to match against
indices in the remote cluster specified by the remote_cluster field.
:param master_timeout: Period to wait for a connection to the master node.
:param max_outstanding_read_requests: The maximum number of outstanding reads
requests from the remote cluster.
:param max_outstanding_write_requests: The maximum number of outstanding reads
requests from the remote cluster.
:param max_read_request_operation_count: The maximum number of operations to
pull per read from the remote cluster.
:param max_read_request_size: The maximum size in bytes of per read of a batch
of operations pulled from the remote cluster.
:param max_retry_delay: The maximum time to wait before retrying an operation
that failed exceptionally. An exponential backoff strategy is employed when
retrying.
:param max_write_buffer_count: 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.
:param max_write_buffer_size: 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.
:param max_write_request_operation_count: The maximum number of operations per
bulk write request executed on the follower.
:param max_write_request_size: The maximum total bytes of operations per bulk
write request executed on the follower.
:param read_poll_timeout: 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.
:param settings: Settings to override from the leader index. Note that certain
settings can not be overrode (e.g., index.number_of_shards).
"""
if name in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'name'")
if remote_cluster is None and body is None:
raise ValueError("Empty value passed for parameter 'remote_cluster'")
__path_parts: t.Dict[str, str] = {"name": _quote(name)}
__path = f'/_ccr/auto_follow/{__path_parts["name"]}'
__query: t.Dict[str, t.Any] = {}
__body: t.Dict[str, t.Any] = body if body is not None else {}
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if master_timeout is not None:
__query["master_timeout"] = master_timeout
if pretty is not None:
__query["pretty"] = pretty
if not __body:
if remote_cluster is not None:
__body["remote_cluster"] = remote_cluster
if follow_index_pattern is not None:
__body["follow_index_pattern"] = follow_index_pattern
if leader_index_exclusion_patterns is not None:
__body["leader_index_exclusion_patterns"] = (
leader_index_exclusion_patterns
)
if leader_index_patterns is not None:
__body["leader_index_patterns"] = leader_index_patterns
if max_outstanding_read_requests is not None:
__body["max_outstanding_read_requests"] = max_outstanding_read_requests
if max_outstanding_write_requests is not None:
__body["max_outstanding_write_requests"] = (
max_outstanding_write_requests
)
if max_read_request_operation_count is not None:
__body["max_read_request_operation_count"] = (
max_read_request_operation_count
)
if max_read_request_size is not None:
__body["max_read_request_size"] = max_read_request_size
if max_retry_delay is not None:
__body["max_retry_delay"] = max_retry_delay
if max_write_buffer_count is not None:
__body["max_write_buffer_count"] = max_write_buffer_count
if max_write_buffer_size is not None:
__body["max_write_buffer_size"] = max_write_buffer_size
if max_write_request_operation_count is not None:
__body["max_write_request_operation_count"] = (
max_write_request_operation_count
)
if max_write_request_size is not None:
__body["max_write_request_size"] = max_write_request_size
if read_poll_timeout is not None:
__body["read_poll_timeout"] = read_poll_timeout
if settings is not None:
__body["settings"] = settings
__headers = {"accept": "application/json", "content-type": "application/json"}
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -