Package org.opensearch.client.opensearch.indices.rollover

Class RolloverConditions.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.rollover.RolloverConditions.Builder

All Implemented Interfaces:

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

Enclosing class:

RolloverConditions

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

Builder for RolloverConditions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RolloverConditions	build()	Builds a RolloverConditions.
RolloverConditions.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RolloverConditions.Builder	maxAge(Function<Time.Builder,ObjectBuilder<Time>> fn)	The maximum age of the index before rollover.
final RolloverConditions.Builder	maxAge(Time value)	The maximum age of the index before rollover.
final RolloverConditions.Builder	maxAgeMillis(Long value)	The maximum age in milliseconds of the index before rollover.
final RolloverConditions.Builder	maxDocs(Long value)	The maximum number of documents in the index before rollover.
final RolloverConditions.Builder	maxPrimaryShardDocs(Long value)	The maximum number of documents in any primary shard before rollover.
final RolloverConditions.Builder	maxPrimaryShardSize(String value)	The maximum size of any primary shard in the index before rollover.
final RolloverConditions.Builder	maxPrimaryShardSizeBytes(Long value)	The maximum size in bytes of any primary shard in the index before rollover.
final RolloverConditions.Builder	maxSize(String value)	The maximum size of the index before rollover.
final RolloverConditions.Builder	maxSizeBytes(Long value)	The maximum size in bytes of the index before rollover.
final RolloverConditions.Builder	minAge(Function<Time.Builder,ObjectBuilder<Time>> fn)	The minimum age of the index before rollover.
final RolloverConditions.Builder	minAge(Time value)	The minimum age of the index before rollover.
final RolloverConditions.Builder	minDocs(Long value)	The minimum number of documents in the index before rollover.
final RolloverConditions.Builder	minPrimaryShardDocs(Long value)	The minimum number of documents in any primary shard before rollover.
final RolloverConditions.Builder	minPrimaryShardSize(String value)	The minimum size of any primary shard in the index before rollover.
final RolloverConditions.Builder	minPrimaryShardSizeBytes(Long value)	The minimum size in bytes of any primary shard in the index before rollover.
final RolloverConditions.Builder	minSize(String value)	The minimum size of the index before rollover.
final RolloverConditions.Builder	minSizeBytes(Long value)	The minimum size in bytes of the index before 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 RolloverConditions.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<RolloverConditions.Builder,RolloverConditions>

Returns:

a new builder instance.

maxAge

@Nonnull
public final RolloverConditions.Builder maxAge(@Nullable
 Time value)

The maximum age of the index before rollover.

API name: max_age

maxAge

@Nonnull
public final RolloverConditions.Builder maxAge(Function<Time.Builder,ObjectBuilder<Time>> fn)

The maximum age of the index before rollover.

API name: max_age

maxAgeMillis

@Nonnull
public final RolloverConditions.Builder maxAgeMillis(@Nullable
 Long value)

The maximum age in milliseconds of the index before rollover.

API name: max_age_millis

maxDocs

@Nonnull
public final RolloverConditions.Builder maxDocs(@Nullable
 Long value)

The maximum number of documents in the index before rollover.

API name: max_docs

maxPrimaryShardDocs

@Nonnull
public final RolloverConditions.Builder maxPrimaryShardDocs(@Nullable
 Long value)

The maximum number of documents in any primary shard before rollover.

API name: max_primary_shard_docs

maxPrimaryShardSize

@Nonnull
public final RolloverConditions.Builder maxPrimaryShardSize(@Nullable
 String value)

The maximum size of any primary shard in the index before rollover.

API name: max_primary_shard_size

maxPrimaryShardSizeBytes

@Nonnull
public final RolloverConditions.Builder maxPrimaryShardSizeBytes(@Nullable
 Long value)

The maximum size in bytes of any primary shard in the index before rollover.

API name: max_primary_shard_size_bytes

maxSize

@Nonnull
public final RolloverConditions.Builder maxSize(@Nullable
 String value)

The maximum size of the index before rollover.

API name: max_size

maxSizeBytes

@Nonnull
public final RolloverConditions.Builder maxSizeBytes(@Nullable
 Long value)

The maximum size in bytes of the index before rollover.

API name: max_size_bytes

minAge

@Nonnull
public final RolloverConditions.Builder minAge(@Nullable
 Time value)

The minimum age of the index before rollover.

API name: min_age

minAge

@Nonnull
public final RolloverConditions.Builder minAge(Function<Time.Builder,ObjectBuilder<Time>> fn)

The minimum age of the index before rollover.

API name: min_age

minDocs

@Nonnull
public final RolloverConditions.Builder minDocs(@Nullable
 Long value)

The minimum number of documents in the index before rollover.

API name: min_docs

minPrimaryShardDocs

@Nonnull
public final RolloverConditions.Builder minPrimaryShardDocs(@Nullable
 Long value)

The minimum number of documents in any primary shard before rollover.

API name: min_primary_shard_docs

minPrimaryShardSize

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

The minimum size of any primary shard in the index before rollover.

API name: min_primary_shard_size

minPrimaryShardSizeBytes

@Nonnull
public final RolloverConditions.Builder minPrimaryShardSizeBytes(@Nullable
 Long value)

The minimum size in bytes of any primary shard in the index before rollover.

API name: min_primary_shard_size_bytes

minSize

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

The minimum size of the index before rollover.

API name: min_size

minSizeBytes

@Nonnull
public final RolloverConditions.Builder minSizeBytes(@Nullable
 Long value)

The minimum size in bytes of the index before rollover.

API name: min_size_bytes

build

@Nonnull
public RolloverConditions build()

Builds a RolloverConditions.

Specified by:

build in interface ObjectBuilder<RolloverConditions>

Throws:

NullPointerException - if some of the required fields are null.