Class PutAutoFollowPatternRequest.Builder
- All Implemented Interfaces:
WithJson<PutAutoFollowPatternRequest.Builder>
,ObjectBuilder<PutAutoFollowPatternRequest>
- Enclosing class:
- PutAutoFollowPatternRequest
PutAutoFollowPatternRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aPutAutoFollowPatternRequest
.followIndexPattern
(String value) The name of follower index.leaderIndexExclusionPatterns
(String value, String... values) An array of simple index patterns that can be used to exclude indices from being auto-followed.An array of simple index patterns that can be used to exclude indices from being auto-followed.leaderIndexPatterns
(String value, String... values) An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.leaderIndexPatterns
(List<String> list) An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.The maximum number of outstanding reads requests from the remote cluster.The maximum number of outstanding reads requests from the remote cluster.The maximum number of operations to pull per read from the remote cluster.maxReadRequestSize
(String value) The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.maxRetryDelay
(Time value) The maximum time to wait before retrying an operation that failed exceptionally.The maximum time to wait before retrying an operation that failed exceptionally.maxWriteBufferCount
(Integer value) The maximum number of operations that can be queued for writing.maxWriteBufferSize
(String value) The maximum total bytes of operations that can be queued for writing.The maximum number of operations per bulk write request executed on the follower.maxWriteRequestSize
(String value) The maximum total bytes of operations per bulk write request executed on the follower.Required - The name of the collection of auto-follow patterns.readPollTimeout
(Time value) The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.remoteCluster
(String value) Required - The remote cluster containing the leader indices to match against.protected PutAutoFollowPatternRequest.Builder
self()
Settings to override from the leader index.Settings to override from the leader index.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
followIndexPattern
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.API name:
follow_index_pattern
-
leaderIndexExclusionPatterns
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.API name:
leader_index_exclusion_patterns
Adds all elements of
list
toleaderIndexExclusionPatterns
. -
leaderIndexExclusionPatterns
public final PutAutoFollowPatternRequest.Builder leaderIndexExclusionPatterns(String value, String... values) 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.API name:
leader_index_exclusion_patterns
Adds one or more values to
leaderIndexExclusionPatterns
. -
leaderIndexPatterns
An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.API name:
leader_index_patterns
Adds all elements of
list
toleaderIndexPatterns
. -
leaderIndexPatterns
public final PutAutoFollowPatternRequest.Builder leaderIndexPatterns(String value, String... values) An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.API name:
leader_index_patterns
Adds one or more values to
leaderIndexPatterns
. -
maxOutstandingReadRequests
public final PutAutoFollowPatternRequest.Builder maxOutstandingReadRequests(@Nullable Integer value) The maximum number of outstanding reads requests from the remote cluster.API name:
max_outstanding_read_requests
-
maxOutstandingWriteRequests
public final PutAutoFollowPatternRequest.Builder maxOutstandingWriteRequests(@Nullable Integer value) The maximum number of outstanding reads requests from the remote cluster.API name:
max_outstanding_write_requests
-
maxReadRequestOperationCount
public final PutAutoFollowPatternRequest.Builder maxReadRequestOperationCount(@Nullable Integer value) The maximum number of operations to pull per read from the remote cluster.API name:
max_read_request_operation_count
-
maxReadRequestSize
The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.API name:
max_read_request_size
-
maxRetryDelay
The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.API name:
max_retry_delay
-
maxRetryDelay
public final PutAutoFollowPatternRequest.Builder maxRetryDelay(Function<Time.Builder, ObjectBuilder<Time>> fn) The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.API name:
max_retry_delay
-
maxWriteBufferCount
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.API name:
max_write_buffer_count
-
maxWriteBufferSize
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.API name:
max_write_buffer_size
-
maxWriteRequestOperationCount
public final PutAutoFollowPatternRequest.Builder maxWriteRequestOperationCount(@Nullable Integer value) The maximum number of operations per bulk write request executed on the follower.API name:
max_write_request_operation_count
-
maxWriteRequestSize
The maximum total bytes of operations per bulk write request executed on the follower.API name:
max_write_request_size
-
name
Required - The name of the collection of auto-follow patterns.API name:
name
-
readPollTimeout
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.API name:
read_poll_timeout
-
readPollTimeout
public final PutAutoFollowPatternRequest.Builder readPollTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) 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.API name:
read_poll_timeout
-
remoteCluster
Required - The remote cluster containing the leader indices to match against.API name:
remote_cluster
-
settings
Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).API name:
settings
Adds all entries of
map
tosettings
. -
settings
Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).API name:
settings
Adds an entry to
settings
. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<PutAutoFollowPatternRequest.Builder>
-
build
Builds aPutAutoFollowPatternRequest
.- Specified by:
build
in interfaceObjectBuilder<PutAutoFollowPatternRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-