Package org.opensearch.client.opensearch.indices

Class IndexTemplateDataStreamConfiguration.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.IndexTemplateDataStreamConfiguration.Builder

All Implemented Interfaces:

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

Enclosing class:

IndexTemplateDataStreamConfiguration

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

Builder for IndexTemplateDataStreamConfiguration.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexTemplateDataStreamConfiguration.Builder	allowCustomRouting(Boolean value)	When true, the data stream supports custom routing.
IndexTemplateDataStreamConfiguration	build()	Builds a IndexTemplateDataStreamConfiguration.
IndexTemplateDataStreamConfiguration.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndexTemplateDataStreamConfiguration.Builder	hidden(Boolean value)	When true, the data stream is hidden.
final IndexTemplateDataStreamConfiguration.Builder	timestampField(Function<DataStreamTimestampField.Builder,ObjectBuilder<DataStreamTimestampField>> fn)	API name: timestamp_field
final IndexTemplateDataStreamConfiguration.Builder	timestampField(DataStreamTimestampField value)	API name: timestamp_field

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

Returns:

a new builder instance.

allowCustomRouting

@Nonnull
public final IndexTemplateDataStreamConfiguration.Builder allowCustomRouting(@Nullable
 Boolean value)

When true, the data stream supports custom routing.

API name: allow_custom_routing

hidden

@Nonnull
public final IndexTemplateDataStreamConfiguration.Builder hidden(@Nullable
 Boolean value)

When true, the data stream is hidden.

API name: hidden

timestampField

@Nonnull
public final IndexTemplateDataStreamConfiguration.Builder timestampField(@Nullable
 DataStreamTimestampField value)

API name: timestamp_field

timestampField

@Nonnull
public final IndexTemplateDataStreamConfiguration.Builder timestampField(Function<DataStreamTimestampField.Builder,ObjectBuilder<DataStreamTimestampField>> fn)

API name: timestamp_field

build

@Nonnull
public IndexTemplateDataStreamConfiguration build()

Builds a IndexTemplateDataStreamConfiguration.

Specified by:

build in interface ObjectBuilder<IndexTemplateDataStreamConfiguration>

Throws:

NullPointerException - if some of the required fields are null.