Package co.elastic.clients.elasticsearch.ccr.follow_info

Class FollowerIndex.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<FollowerIndex.Builder>

co.elastic.clients.elasticsearch.ccr.follow_info.FollowerIndex.Builder

All Implemented Interfaces:

WithJson<FollowerIndex.Builder>, ObjectBuilder<FollowerIndex>

Enclosing class:

FollowerIndex

public static class FollowerIndex.Builder
extends WithJsonObjectBuilderBase<FollowerIndex.Builder>
implements ObjectBuilder<FollowerIndex>

Builder for FollowerIndex.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FollowerIndex	build()	Builds a FollowerIndex.
final FollowerIndex.Builder	followerIndex(String value)	Required - The name of the follower index.
final FollowerIndex.Builder	leaderIndex(String value)	Required - The name of the index in the leader cluster that is followed.
final FollowerIndex.Builder	parameters(FollowerIndexParameters value)	An object that encapsulates cross-cluster replication parameters.
final FollowerIndex.Builder	parameters(Function<FollowerIndexParameters.Builder,ObjectBuilder<FollowerIndexParameters>> fn)	An object that encapsulates cross-cluster replication parameters.
final FollowerIndex.Builder	remoteCluster(String value)	Required - The remote cluster that contains the leader index.
protected FollowerIndex.Builder	self()
final FollowerIndex.Builder	status(FollowerIndexStatus value)	Required - The status of the index following: active or paused.

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

followerIndex

public final FollowerIndex.Builder followerIndex(String value)

Required - The name of the follower index.

API name: follower_index

leaderIndex

public final FollowerIndex.Builder leaderIndex(String value)

Required - The name of the index in the leader cluster that is followed.

API name: leader_index

parameters

public final FollowerIndex.Builder parameters(@Nullable
 FollowerIndexParameters value)

An object that encapsulates cross-cluster replication parameters. If the follower index's status is paused, this object is omitted.

API name: parameters

parameters

public final FollowerIndex.Builder parameters(Function<FollowerIndexParameters.Builder,ObjectBuilder<FollowerIndexParameters>> fn)

An object that encapsulates cross-cluster replication parameters. If the follower index's status is paused, this object is omitted.

API name: parameters

remoteCluster

public final FollowerIndex.Builder remoteCluster(String value)

Required - The remote cluster that contains the leader index.

API name: remote_cluster

status

public final FollowerIndex.Builder status(FollowerIndexStatus value)

Required - The status of the index following: active or paused.

API name: status

self

protected FollowerIndex.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<FollowerIndex.Builder>

build

public FollowerIndex build()

Builds a FollowerIndex.

Specified by:

build in interface ObjectBuilder<FollowerIndex>

Throws:

NullPointerException - if some of the required fields are null.