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
Creates a new follower index configured to follow the referenced leader
index.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFollowRequest.BuilderBuilder forFollowRequest.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>> -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<FollowRequest>_DESERIALIZERJson deserializer forFollowRequeststatic Endpoint<FollowRequest,FollowResponse,ErrorResponse>_ENDPOINTEndpoint "ccr.follow". -
Method Summary
Modifier and Type Method Description java.lang.Stringindex()Required - The name of the follower indexjava.lang.StringleaderIndex()API name:leader_indexjava.lang.LongmaxOutstandingReadRequests()API name:max_outstanding_read_requestsjava.lang.LongmaxOutstandingWriteRequests()API name:max_outstanding_write_requestsjava.lang.LongmaxReadRequestOperationCount()API name:max_read_request_operation_countjava.lang.StringmaxReadRequestSize()API name:max_read_request_sizeTimemaxRetryDelay()API name:max_retry_delayjava.lang.LongmaxWriteBufferCount()API name:max_write_buffer_countjava.lang.StringmaxWriteBufferSize()API name:max_write_buffer_sizejava.lang.LongmaxWriteRequestOperationCount()API name:max_write_request_operation_countjava.lang.StringmaxWriteRequestSize()API name:max_write_request_sizestatic FollowRequestof(java.util.function.Function<FollowRequest.Builder,ObjectBuilder<FollowRequest>> fn)TimereadPollTimeout()API name:read_poll_timeoutjava.lang.StringremoteCluster()API name:remote_clustervoidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)protected static voidsetupFollowRequestDeserializer(ObjectDeserializer<FollowRequest.Builder> op)WaitForActiveShardswaitForActiveShards()Sets the number of shard copies that must be active before returning.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forFollowRequest -
_ENDPOINT
Endpoint "ccr.follow".
-
-
Method Details
-
of
public static FollowRequest of(java.util.function.Function<FollowRequest.Builder,ObjectBuilder<FollowRequest>> fn) -
index
public final java.lang.String index()Required - The name of the follower indexAPI name:
index -
leaderIndex
@Nullable public final java.lang.String leaderIndex()API name:leader_index -
maxOutstandingReadRequests
@Nullable public final java.lang.Long maxOutstandingReadRequests()API name:max_outstanding_read_requests -
maxOutstandingWriteRequests
@Nullable public final java.lang.Long maxOutstandingWriteRequests()API name:max_outstanding_write_requests -
maxReadRequestOperationCount
@Nullable public final java.lang.Long maxReadRequestOperationCount()API name:max_read_request_operation_count -
maxReadRequestSize
@Nullable public final java.lang.String maxReadRequestSize()API name:max_read_request_size -
maxRetryDelay
API name:max_retry_delay -
maxWriteBufferCount
@Nullable public final java.lang.Long maxWriteBufferCount()API name:max_write_buffer_count -
maxWriteBufferSize
@Nullable public final java.lang.String maxWriteBufferSize()API name:max_write_buffer_size -
maxWriteRequestOperationCount
@Nullable public final java.lang.Long maxWriteRequestOperationCount()API name:max_write_request_operation_count -
maxWriteRequestSize
@Nullable public final java.lang.String maxWriteRequestSize()API name:max_write_request_size -
readPollTimeout
API name:read_poll_timeout -
remoteCluster
@Nullable public final java.lang.String remoteCluster()API name:remote_cluster -
waitForActiveShards
Sets the number of shard copies that must be active before returning. Defaults to 0. Set toallfor 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 -
serialize
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
setupFollowRequestDeserializer
-