Package co.elastic.clients.elasticsearch.indices

Class RolloverRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.RolloverRequest.Builder

All Implemented Interfaces:

WithJson<RolloverRequest.Builder>, ObjectBuilder<RolloverRequest>

Enclosing class:

RolloverRequest

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

Builder for RolloverRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final RolloverRequest.Builder	alias(String value)	Required - The name of the alias to rollover
final RolloverRequest.Builder	aliases(String key, Alias value)	API name: aliases
final RolloverRequest.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	API name: aliases
final RolloverRequest.Builder	aliases(Map<String,Alias> map)	API name: aliases
RolloverRequest	build()	Builds a RolloverRequest.
final RolloverRequest.Builder	conditions(RolloverConditions value)	API name: conditions
final RolloverRequest.Builder	conditions(Function<RolloverConditions.Builder,ObjectBuilder<RolloverConditions>> fn)	API name: conditions
final RolloverRequest.Builder	dryRun(Boolean value)	If set to true the rollover action will only be validated but not actually performed even if a condition matches.
final RolloverRequest.Builder	includeTypeName(Boolean value)	Whether a type should be included in the body of the mappings.
final RolloverRequest.Builder	mappings(IndexRolloverMapping value)	API name: mappings
final RolloverRequest.Builder	mappings(Function<IndexRolloverMapping.Builder,ObjectBuilder<IndexRolloverMapping>> fn)	API name: mappings
final RolloverRequest.Builder	masterTimeout(Time value)	Specify timeout for connection to master
final RolloverRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to master
final RolloverRequest.Builder	newIndex(String value)	The name of the rollover index
protected RolloverRequest.Builder	self()
final RolloverRequest.Builder	settings(String key, JsonData value)	API name: settings
final RolloverRequest.Builder	settings(Map<String,JsonData> map)	API name: settings
final RolloverRequest.Builder	timeout(Time value)	Explicit operation timeout
final RolloverRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
final RolloverRequest.Builder	waitForActiveShards(WaitForActiveShards value)	Set the number of active shards to wait for on the newly created rollover index before the operation returns.
final RolloverRequest.Builder	waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)	Set the number of active shards to wait for on the newly created rollover index before the operation returns.

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

alias

public final RolloverRequest.Builder alias(String value)

Required - The name of the alias to rollover

API name: alias

aliases

public final RolloverRequest.Builder aliases(Map<String,Alias> map)

API name: aliases

Adds all entries of map to aliases.

aliases

public final RolloverRequest.Builder aliases(String key,
 Alias value)

API name: aliases

Adds an entry to aliases.

aliases

public final RolloverRequest.Builder aliases(String key,
 Function<Alias.Builder,ObjectBuilder<Alias>> fn)

API name: aliases

Adds an entry to aliases using a builder lambda.

conditions

public final RolloverRequest.Builder conditions(@Nullable
 RolloverConditions value)

API name: conditions

conditions

public final RolloverRequest.Builder conditions(Function<RolloverConditions.Builder,ObjectBuilder<RolloverConditions>> fn)

API name: conditions

dryRun

public final RolloverRequest.Builder dryRun(@Nullable
 Boolean value)

If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false

API name: dry_run

includeTypeName

public final RolloverRequest.Builder includeTypeName(@Nullable
 Boolean value)

Whether a type should be included in the body of the mappings.

API name: include_type_name

mappings

public final RolloverRequest.Builder mappings(@Nullable
 IndexRolloverMapping value)

API name: mappings

mappings

public final RolloverRequest.Builder mappings(Function<IndexRolloverMapping.Builder,ObjectBuilder<IndexRolloverMapping>> fn)

API name: mappings

masterTimeout

public final RolloverRequest.Builder masterTimeout(@Nullable
 Time value)

Specify timeout for connection to master

API name: master_timeout

masterTimeout

public final RolloverRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify timeout for connection to master

API name: master_timeout

newIndex

public final RolloverRequest.Builder newIndex(@Nullable
 String value)

The name of the rollover index

API name: new_index

settings

public final RolloverRequest.Builder settings(Map<String,JsonData> map)

API name: settings

Adds all entries of map to settings.

settings

public final RolloverRequest.Builder settings(String key,
 JsonData value)

API name: settings

Adds an entry to settings.

timeout

public final RolloverRequest.Builder timeout(@Nullable
 Time value)

Explicit operation timeout

API name: timeout

timeout

public final RolloverRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API name: timeout

waitForActiveShards

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

Set the number of active shards to wait for on the newly created rollover index before the operation returns.

API name: wait_for_active_shards

waitForActiveShards

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

Set the number of active shards to wait for on the newly created rollover index before the operation returns.

API name: wait_for_active_shards

self

protected RolloverRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<RolloverRequest.Builder>

build

public RolloverRequest build()

Builds a RolloverRequest.

Specified by:

build in interface ObjectBuilder<RolloverRequest>

Throws:

NullPointerException - if some of the required fields are null.