Package co.elastic.clients.elasticsearch.ccr

Class FollowRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ccr.FollowRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class FollowRequest extends RequestBase implements JsonpSerializable
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.
See Also:

  • Field Details

  • Method Details

    • of

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

    • dataStreamName

      @Nullable public final String dataStreamName()
      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.

      API name: data_stream_name

    • index

      public final String index()
      Required - The name of the follower index.

      API name: index

    • leaderIndex

      public final String leaderIndex()
      Required - The name of the index in the leader cluster to follow.

      API name: leader_index

    • masterTimeout

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

      API name: master_timeout

    • maxOutstandingReadRequests

      @Nullable public final Long 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 write requests on the follower.

      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

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

      API name: remote_cluster

    • settings

      @Nullable public final IndexSettings settings()
      Settings to override from the leader index.

      API name: settings

    • waitForActiveShards

      @Nullable public final WaitForActiveShards waitForActiveShards()
      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.

      API name: wait_for_active_shards

    • 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)

    • setupFollowRequestDeserializer

      protected static void setupFollowRequestDeserializer(ObjectDeserializer<FollowRequest.Builder> op)