elasticsearch/_async/client/ccr.py [98:232]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
self,
*,
index: str,
leader_index: t.Optional[str] = None,
remote_cluster: t.Optional[str] = None,
data_stream_name: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = 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,
wait_for_active_shards: t.Optional[
t.Union[int, t.Union[str, t.Literal["all", "index-setting"]]]
] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
Create a follower.
Create a cross-cluster replication follower index that follows a specific leader index.
When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.
``_
:param index: The name of the follower index.
:param leader_index: The name of the index in the leader cluster to follow.
:param remote_cluster: The remote cluster containing the leader index.
:param data_stream_name: 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.
: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 write
requests on the follower.
: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.
:param wait_for_active_shards: 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.
"""
if index in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'index'")
if leader_index is None and body is None:
raise ValueError("Empty value passed for parameter 'leader_index'")
if remote_cluster is None and body is None:
raise ValueError("Empty value passed for parameter 'remote_cluster'")
__path_parts: t.Dict[str, str] = {"index": _quote(index)}
__path = f'/{__path_parts["index"]}/_ccr/follow'
__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 wait_for_active_shards is not None:
__query["wait_for_active_shards"] = wait_for_active_shards
if not __body:
if leader_index is not None:
__body["leader_index"] = leader_index
if remote_cluster is not None:
__body["remote_cluster"] = remote_cluster
if data_stream_name is not None:
__body["data_stream_name"] = data_stream_name
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 [98:232]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
self,
*,
index: str,
leader_index: t.Optional[str] = None,
remote_cluster: t.Optional[str] = None,
data_stream_name: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
human: t.Optional[bool] = 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,
wait_for_active_shards: t.Optional[
t.Union[int, t.Union[str, t.Literal["all", "index-setting"]]]
] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
Create a follower.
Create a cross-cluster replication follower index that follows a specific leader index.
When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.
``_
:param index: The name of the follower index.
:param leader_index: The name of the index in the leader cluster to follow.
:param remote_cluster: The remote cluster containing the leader index.
:param data_stream_name: 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.
: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 write
requests on the follower.
: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.
:param wait_for_active_shards: 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.
"""
if index in SKIP_IN_PATH:
raise ValueError("Empty value passed for parameter 'index'")
if leader_index is None and body is None:
raise ValueError("Empty value passed for parameter 'leader_index'")
if remote_cluster is None and body is None:
raise ValueError("Empty value passed for parameter 'remote_cluster'")
__path_parts: t.Dict[str, str] = {"index": _quote(index)}
__path = f'/{__path_parts["index"]}/_ccr/follow'
__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 wait_for_active_shards is not None:
__query["wait_for_active_shards"] = wait_for_active_shards
if not __body:
if leader_index is not None:
__body["leader_index"] = leader_index
if remote_cluster is not None:
__body["remote_cluster"] = remote_cluster
if data_stream_name is not None:
__body["data_stream_name"] = data_stream_name
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"}
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -