Package co.elastic.clients.elasticsearch.indices

Class RolloverRequest.Builder

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<RolloverRequest>

Enclosing class:

RolloverRequest

public static class RolloverRequest.Builder
extends java.lang.Object
implements ObjectBuilder<RolloverRequest>

Builder for RolloverRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

alias

public RolloverRequest.Builder alias(java.lang.String value)

Required - The name of the alias to rollover

API name: alias

newIndex

public RolloverRequest.Builder newIndex(@Nullable
java.lang.String value)

The name of the rollover index

API name: new_index

dryRun

public RolloverRequest.Builder dryRun(@Nullable
java.lang.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 RolloverRequest.Builder includeTypeName(@Nullable
java.lang.Boolean value)

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

API name: include_type_name

masterTimeout

public RolloverRequest.Builder masterTimeout(@Nullable
java.lang.String value)

Specify timeout for connection to master

API name: master_timeout

timeout

public RolloverRequest.Builder timeout(@Nullable
java.lang.String value)

Explicit operation timeout

API name: timeout

waitForActiveShards

public RolloverRequest.Builder waitForActiveShards(@Nullable
jakarta.json.JsonValue 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

aliases

public RolloverRequest.Builder aliases(@Nullable
java.util.Map<java.lang.String,Alias> value)

API name: aliases

putAliases

public RolloverRequest.Builder putAliases(java.lang.String key,
Alias value)

Add a key/value to aliases(Map), creating the map if needed.

aliases

public RolloverRequest.Builder aliases(java.lang.String key,
java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)

Set aliases(Map) to a singleton map.

putAliases

public RolloverRequest.Builder putAliases(java.lang.String key,
java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)

Add a key/value to aliases(Map), creating the map if needed.

conditions

public RolloverRequest.Builder conditions(@Nullable
RolloverConditions value)

API name: conditions

conditions

public RolloverRequest.Builder conditions(java.util.function.Function<RolloverConditions.Builder,ObjectBuilder<RolloverConditions>> fn)

API name: conditions

mappings

public RolloverRequest.Builder mappings(@Nullable
jakarta.json.JsonValue value)

API name: mappings

settings

public RolloverRequest.Builder settings(@Nullable
java.util.Map<java.lang.String,JsonData> value)

API name: settings

putSettings

public RolloverRequest.Builder putSettings(java.lang.String key,
JsonData value)

Add a key/value to settings(Map), creating the map if needed.

build

public RolloverRequest build()

Builds a RolloverRequest.

Specified by:

build in interface ObjectBuilder<RolloverRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.