Class PutAutoFollowPatternRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ccr.PutAutoFollowPatternRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class PutAutoFollowPatternRequest
extends RequestBase
implements JsonpSerializable
Creates a new named collection of auto-follow patterns against a specified
remote cluster. Newly created indices on the remote cluster matching any of
the specified patterns will be automatically configured as follower indices.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutAutoFollowPatternRequest>
Json deserializer forPutAutoFollowPatternRequest
Endpoint "ccr.put_auto_follow_pattern
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of follower index.An array of simple index patterns that can be used to exclude indices from being auto-followed.An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.final Integer
The maximum number of outstanding reads requests from the remote cluster.final Integer
The maximum number of outstanding reads requests from the remote cluster.final Integer
The maximum number of operations to pull per read from the remote cluster.final String
The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.final Time
The maximum time to wait before retrying an operation that failed exceptionally.final Integer
The maximum number of operations that can be queued for writing.final String
The maximum total bytes of operations that can be queued for writing.final Integer
The maximum number of operations per bulk write request executed on the follower.final String
The maximum total bytes of operations per bulk write request executed on the follower.final String
name()
Required - The name of the collection of auto-follow patterns.static PutAutoFollowPatternRequest
final Time
The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index.final String
Required - The remote cluster containing the leader indices to match against.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) settings()
Settings to override from the leader index.protected static void
setupPutAutoFollowPatternRequestDeserializer
(ObjectDeserializer<PutAutoFollowPatternRequest.Builder> op) Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forPutAutoFollowPatternRequest
-
_ENDPOINT
public static final Endpoint<PutAutoFollowPatternRequest,PutAutoFollowPatternResponse, _ENDPOINTErrorResponse> Endpoint "ccr.put_auto_follow_pattern
".
-
-
Method Details
-
of
-
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
-
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
-
maxOutstandingReadRequests
The maximum number of outstanding reads requests from the remote cluster.API name:
max_outstanding_read_requests
-
maxOutstandingWriteRequests
The maximum number of outstanding reads requests from the remote cluster.API name:
max_outstanding_write_requests
-
maxReadRequestOperationCount
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
-
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
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
-
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
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupPutAutoFollowPatternRequestDeserializer
protected static void setupPutAutoFollowPatternRequestDeserializer(ObjectDeserializer<PutAutoFollowPatternRequest.Builder> op)
-