Package co.elastic.clients.elasticsearch.ccr

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
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.

See Also:

  • Field Details

  • Method Details

    • of

      public static PutAutoFollowPatternRequest of(Function<PutAutoFollowPatternRequest.Builder,ObjectBuilder<PutAutoFollowPatternRequest>> fn)

    • followIndexPattern

      @Nullable public final String 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

      public final List<String> 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

      public final List<String> 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

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Period to wait for a connection to the master node.

      API name: master_timeout

    • maxOutstandingReadRequests

      @Nullable public final Integer maxOutstandingReadRequests()
      The maximum number of outstanding reads requests from the remote cluster.

      API name: max_outstanding_read_requests

    • maxOutstandingWriteRequests

      @Nullable public final Integer maxOutstandingWriteRequests()
      The maximum number of outstanding reads requests from the remote cluster.

      API name: max_outstanding_write_requests

    • maxReadRequestOperationCount

      @Nullable public final Integer maxReadRequestOperationCount()
      The maximum number of operations to pull per read from the remote cluster.

      API name: max_read_request_operation_count

    • maxReadRequestSize

      @Nullable public final String 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

      @Nullable public final Time 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

      @Nullable public final Integer 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

      @Nullable public final String 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

      @Nullable public final Integer maxWriteRequestOperationCount()
      The maximum number of operations per bulk write request executed on the follower.

      API name: max_write_request_operation_count

    • maxWriteRequestSize

      @Nullable public final String maxWriteRequestSize()
      The maximum total bytes of operations per bulk write request executed on the follower.

      API name: max_write_request_size

    • name

      public final String name()
      Required - The name of the collection of auto-follow patterns.

      API name: name

    • readPollTimeout

      @Nullable public final Time 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

      public final String remoteCluster()
      Required - The remote cluster containing the leader indices to match against.

      API name: remote_cluster

    • settings

      public final Map<String,JsonData> 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

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupPutAutoFollowPatternRequestDeserializer

      protected static void setupPutAutoFollowPatternRequestDeserializer(ObjectDeserializer<PutAutoFollowPatternRequest.Builder> op)