Package org.opensearch.client.opensearch.indices

Class RolloverRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.RolloverRequest.Builder

All Implemented Interfaces:

ObjectBuilder<RolloverRequest>

Enclosing class:

RolloverRequest

public static class RolloverRequest.Builder
extends ObjectBuilderBase
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)	API name: aliases
RolloverRequest.Builder	aliases(java.lang.String key, Alias value)	API name: aliases
RolloverRequest.Builder	aliases(java.util.Map<java.lang.String,Alias> map)	API name: aliases
RolloverRequest	build()	Builds a RolloverRequest.
RolloverRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to cluster-manager
RolloverRequest.Builder	clusterManagerTimeout(Time value)	Specify timeout for connection to cluster-manager
RolloverRequest.Builder	conditions(java.util.function.Function<RolloverConditions.Builder,ObjectBuilder<RolloverConditions>> fn)	API name: conditions
RolloverRequest.Builder	conditions(RolloverConditions value)	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	mappings(java.util.function.Function<IndexRolloverMapping.Builder,ObjectBuilder<IndexRolloverMapping>> fn)	API name: mappings
RolloverRequest.Builder	mappings(IndexRolloverMapping value)	API name: mappings
RolloverRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
RolloverRequest.Builder	masterTimeout(Time value)	Deprecated.
RolloverRequest.Builder	newIndex(java.lang.String value)	The name of the rollover index
RolloverRequest.Builder	settings(java.lang.String key, JsonData value)	API name: settings
RolloverRequest.Builder	settings(java.util.Map<java.lang.String,JsonData> map)	API name: settings
RolloverRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
RolloverRequest.Builder	timeout(Time value)	Explicit operation timeout
RolloverRequest.Builder	waitForActiveShards(java.util.function.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.
RolloverRequest.Builder	waitForActiveShards(WaitForActiveShards value)	Set the number of active shards to wait for on the newly created rollover index before the operation returns.

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

alias

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

Required - The name of the alias to rollover

API name: alias

aliases

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

API name: aliases

Adds all entries of map to aliases.

aliases

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

API name: aliases

Adds an entry to aliases.

aliases

public final RolloverRequest.Builder aliases(java.lang.String key,
                                             java.util.function.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(java.util.function.Function<RolloverConditions.Builder,ObjectBuilder<RolloverConditions>> fn)

API name: conditions

dryRun

public final 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

mappings

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

API name: mappings

mappings

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

API name: mappings

masterTimeout

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

Deprecated.

Specify timeout for connection to master

API name: master_timeout

masterTimeout

@Deprecated
public final RolloverRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

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

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

clusterManagerTimeout

public final RolloverRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

newIndex

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

The name of the rollover index

API name: new_index

settings

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

API name: settings

Adds all entries of map to settings.

settings

public final RolloverRequest.Builder settings(java.lang.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(java.util.function.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(java.util.function.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

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.