Package co.elastic.clients.elasticsearch.ccr

Class FollowRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<FollowRequest.Builder>

co.elastic.clients.elasticsearch.ccr.FollowRequest.Builder

All Implemented Interfaces:

WithJson<FollowRequest.Builder>, ObjectBuilder<FollowRequest>

Enclosing class:

FollowRequest

public static class FollowRequest.Builder
extends RequestBase.AbstractBuilder<FollowRequest.Builder>
implements ObjectBuilder<FollowRequest>

Builder for FollowRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FollowRequest	build()	Builds a FollowRequest.
final FollowRequest.Builder	index(String value)	Required - The name of the follower index
final FollowRequest.Builder	leaderIndex(String value)	API name: leader_index
final FollowRequest.Builder	maxOutstandingReadRequests(Long value)	API name: max_outstanding_read_requests
final FollowRequest.Builder	maxOutstandingWriteRequests(Long value)	API name: max_outstanding_write_requests
final FollowRequest.Builder	maxReadRequestOperationCount(Long value)	API name: max_read_request_operation_count
final FollowRequest.Builder	maxReadRequestSize(String value)	API name: max_read_request_size
final FollowRequest.Builder	maxRetryDelay(Time value)	API name: max_retry_delay
final FollowRequest.Builder	maxRetryDelay(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: max_retry_delay
final FollowRequest.Builder	maxWriteBufferCount(Long value)	API name: max_write_buffer_count
final FollowRequest.Builder	maxWriteBufferSize(String value)	API name: max_write_buffer_size
final FollowRequest.Builder	maxWriteRequestOperationCount(Long value)	API name: max_write_request_operation_count
final FollowRequest.Builder	maxWriteRequestSize(String value)	API name: max_write_request_size
final FollowRequest.Builder	readPollTimeout(Time value)	API name: read_poll_timeout
final FollowRequest.Builder	readPollTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: read_poll_timeout
final FollowRequest.Builder	remoteCluster(String value)	API name: remote_cluster
protected FollowRequest.Builder	self()
final FollowRequest.Builder	waitForActiveShards(WaitForActiveShards value)	Sets the number of shard copies that must be active before returning.
final FollowRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	Sets the number of shard copies that must be active before returning.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

index

public final FollowRequest.Builder index(String value)

Required - The name of the follower index

API name: index

leaderIndex

public final FollowRequest.Builder leaderIndex(@Nullable
 String value)

API name: leader_index

maxOutstandingReadRequests

public final FollowRequest.Builder maxOutstandingReadRequests(@Nullable
 Long value)

API name: max_outstanding_read_requests

maxOutstandingWriteRequests

public final FollowRequest.Builder maxOutstandingWriteRequests(@Nullable
 Long value)

API name: max_outstanding_write_requests

maxReadRequestOperationCount

public final FollowRequest.Builder maxReadRequestOperationCount(@Nullable
 Long value)

API name: max_read_request_operation_count

maxReadRequestSize

public final FollowRequest.Builder maxReadRequestSize(@Nullable
 String value)

API name: max_read_request_size

maxRetryDelay

public final FollowRequest.Builder maxRetryDelay(@Nullable
 Time value)

API name: max_retry_delay

maxRetryDelay

public final FollowRequest.Builder maxRetryDelay(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: max_retry_delay

maxWriteBufferCount

public final FollowRequest.Builder maxWriteBufferCount(@Nullable
 Long value)

API name: max_write_buffer_count

maxWriteBufferSize

public final FollowRequest.Builder maxWriteBufferSize(@Nullable
 String value)

API name: max_write_buffer_size

maxWriteRequestOperationCount

public final FollowRequest.Builder maxWriteRequestOperationCount(@Nullable
 Long value)

API name: max_write_request_operation_count

maxWriteRequestSize

public final FollowRequest.Builder maxWriteRequestSize(@Nullable
 String value)

API name: max_write_request_size

readPollTimeout

public final FollowRequest.Builder readPollTimeout(@Nullable
 Time value)

API name: read_poll_timeout

readPollTimeout

public final FollowRequest.Builder readPollTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: read_poll_timeout

remoteCluster

public final FollowRequest.Builder remoteCluster(@Nullable
 String value)

API name: remote_cluster

waitForActiveShards

public final FollowRequest.Builder waitForActiveShards(@Nullable
 WaitForActiveShards value)

Sets the number of shard copies that must be active before returning. Defaults to 0. Set to all for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)

API name: wait_for_active_shards

waitForActiveShards

public final FollowRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)

Sets the number of shard copies that must be active before returning. Defaults to 0. Set to all for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)

API name: wait_for_active_shards

self

protected FollowRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<FollowRequest.Builder>

build

public FollowRequest build()

Builds a FollowRequest.

Specified by:

build in interface ObjectBuilder<FollowRequest>

Throws:

NullPointerException - if some of the required fields are null.