Package org.opensearch.client.opensearch.ism

Class ActionRollover.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ism.ActionRollover.Builder

All Implemented Interfaces:

CopyableBuilder<ActionRollover.Builder,ActionRollover>, MutableBuilder<ActionRollover.Builder,ActionRollover>, ObjectBuilder<ActionRollover>

Enclosing class:

ActionRollover

public static class ActionRollover.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ActionRollover.Builder,ActionRollover>

Builder for ActionRollover.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ActionRollover	build()	Builds a ActionRollover.
ActionRollover.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ActionRollover.Builder	copyAlias(Boolean value)	Whether to copy the alias to the new index.
final ActionRollover.Builder	minDocCount(Number value)	The minimum document count to trigger rollover.
final ActionRollover.Builder	minIndexAge(String value)	The minimum index age to trigger rollover.
final ActionRollover.Builder	minPrimaryShardSize(String value)	The minimum primary shard size to trigger rollover.
final ActionRollover.Builder	minSize(String value)	The minimum size to trigger rollover.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ActionRollover.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ActionRollover.Builder,ActionRollover>

Returns:

a new builder instance.

copyAlias

@Nonnull
public final ActionRollover.Builder copyAlias(@Nullable
 Boolean value)

Whether to copy the alias to the new index.

API name: copy_alias

minDocCount

@Nonnull
public final ActionRollover.Builder minDocCount(@Nullable
 Number value)

The minimum document count to trigger rollover.

API name: min_doc_count

minIndexAge

@Nonnull
public final ActionRollover.Builder minIndexAge(@Nullable
 String value)

The minimum index age to trigger rollover.

API name: min_index_age

minPrimaryShardSize

@Nonnull
public final ActionRollover.Builder minPrimaryShardSize(@Nullable
 String value)

The minimum primary shard size to trigger rollover.

API name: min_primary_shard_size

minSize

@Nonnull
public final ActionRollover.Builder minSize(@Nullable
 String value)

The minimum size to trigger rollover.

API name: min_size

build

@Nonnull
public ActionRollover build()

Builds a ActionRollover.

Specified by:

build in interface ObjectBuilder<ActionRollover>

Throws:

NullPointerException - if some of the required fields are null.