Package co.elastic.clients.elasticsearch.ccr

Class PutAutoFollowPatternRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.ccr.PutAutoFollowPatternRequest.Builder
All Implemented Interfaces:
ObjectBuilder<PutAutoFollowPatternRequest>
Enclosing class:
PutAutoFollowPatternRequest
public static class PutAutoFollowPatternRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<PutAutoFollowPatternRequest>
Builder for PutAutoFollowPatternRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • followIndexPattern

      public final PutAutoFollowPatternRequest.Builder followIndexPattern​(@Nullable java.lang.String value)
      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 PutAutoFollowPatternRequest.Builder leaderIndexExclusionPatterns​(java.util.List<java.lang.String> list)
      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 to leaderIndexExclusionPatterns.

    • leaderIndexExclusionPatterns

      public final PutAutoFollowPatternRequest.Builder leaderIndexExclusionPatterns​(java.lang.String value, java.lang.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

      public final PutAutoFollowPatternRequest.Builder leaderIndexPatterns​(java.util.List<java.lang.String> list)
      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 to leaderIndexPatterns.

    • leaderIndexPatterns

      public final PutAutoFollowPatternRequest.Builder leaderIndexPatterns​(java.lang.String value, java.lang.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 java.lang.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 java.lang.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 java.lang.Integer value)
      The maximum number of operations to pull per read from the remote cluster.

      API name: max_read_request_operation_count

    • maxReadRequestSize

      public final PutAutoFollowPatternRequest.Builder maxReadRequestSize​(@Nullable java.lang.String value)
      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

      public final PutAutoFollowPatternRequest.Builder maxRetryDelay​(@Nullable Time value)
      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​(java.util.function.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

      public final PutAutoFollowPatternRequest.Builder maxWriteBufferCount​(@Nullable java.lang.Integer value)
      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

      public final PutAutoFollowPatternRequest.Builder maxWriteBufferSize​(@Nullable java.lang.String value)
      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 java.lang.Integer value)
      The maximum number of operations per bulk write request executed on the follower.

      API name: max_write_request_operation_count

    • maxWriteRequestSize

      public final PutAutoFollowPatternRequest.Builder maxWriteRequestSize​(@Nullable java.lang.String value)
      The maximum total bytes of operations per bulk write request executed on the follower.

      API name: max_write_request_size

    • name

      public final PutAutoFollowPatternRequest.Builder name​(java.lang.String value)
      Required - The name of the collection of auto-follow patterns.

      API name: name

    • readPollTimeout

      public final PutAutoFollowPatternRequest.Builder readPollTimeout​(@Nullable Time value)
      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​(java.util.function.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

      public final PutAutoFollowPatternRequest.Builder remoteCluster​(java.lang.String value)
      Required - The remote cluster containing the leader indices to match against.

      API name: remote_cluster

    • settings

      public final PutAutoFollowPatternRequest.Builder settings​(java.util.Map<java.lang.String,​JsonData> map)
      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 to settings.

    • settings

      public final PutAutoFollowPatternRequest.Builder settings​(java.lang.String key, JsonData value)
      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.

    • build

      public PutAutoFollowPatternRequest build()
      Builds a PutAutoFollowPatternRequest.
      Specified by:
      build in interface ObjectBuilder<PutAutoFollowPatternRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.