Package org.opensearch.client.opensearch.indices

Class IndexSettingsLifecycle.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.IndexSettingsLifecycle.Builder

All Implemented Interfaces:

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

Enclosing class:

IndexSettingsLifecycle

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

Builder for IndexSettingsLifecycle.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IndexSettingsLifecycle	build()	Builds a IndexSettingsLifecycle.
IndexSettingsLifecycle.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndexSettingsLifecycle.Builder	indexingComplete(Boolean value)	API name: indexing_complete
final IndexSettingsLifecycle.Builder	name(String value)	Required - API name: name
final IndexSettingsLifecycle.Builder	originationDate(Long value)	The timestamp used to calculate the index age for its phase transitions.
final IndexSettingsLifecycle.Builder	parseOriginationDate(Boolean value)	When true, parses the origination date from the index name.
final IndexSettingsLifecycle.Builder	rolloverAlias(String value)	The index alias to update when the index rolls over.
final IndexSettingsLifecycle.Builder	step(Function<IndexSettingsLifecycleStep.Builder,ObjectBuilder<IndexSettingsLifecycleStep>> fn)	API name: step
final IndexSettingsLifecycle.Builder	step(IndexSettingsLifecycleStep value)	API name: step

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 IndexSettingsLifecycle.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<IndexSettingsLifecycle.Builder,IndexSettingsLifecycle>

Returns:

a new builder instance.

indexingComplete

@Nonnull
public final IndexSettingsLifecycle.Builder indexingComplete(@Nullable
 Boolean value)

API name: indexing_complete

name

@Nonnull
public final IndexSettingsLifecycle.Builder name(String value)

Required - API name: name

originationDate

@Nonnull
public final IndexSettingsLifecycle.Builder originationDate(@Nullable
 Long value)

The timestamp used to calculate the index age for its phase transitions. Use this setting if you create a new index that contains old data and want to use the original creation date to calculate the index age. Specified as a Unix epoch value in milliseconds.

API name: origination_date

parseOriginationDate

@Nonnull
public final IndexSettingsLifecycle.Builder parseOriginationDate(@Nullable
 Boolean value)

When true, parses the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, for example logs-2016.10.31-000002). If the index name doesn't match the pattern, index creation fails.

API name: parse_origination_date

rolloverAlias

@Nonnull
public final IndexSettingsLifecycle.Builder rolloverAlias(@Nullable
 String value)

The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rolling indexes, see Rollover.

API name: rollover_alias

step

@Nonnull
public final IndexSettingsLifecycle.Builder step(@Nullable
 IndexSettingsLifecycleStep value)

API name: step

step

@Nonnull
public final IndexSettingsLifecycle.Builder step(Function<IndexSettingsLifecycleStep.Builder,ObjectBuilder<IndexSettingsLifecycleStep>> fn)

API name: step

build

@Nonnull
public IndexSettingsLifecycle build()

Builds a IndexSettingsLifecycle.

Specified by:

build in interface ObjectBuilder<IndexSettingsLifecycle>

Throws:

NullPointerException - if some of the required fields are null.