Package org.opensearch.client.opensearch.indices

Class DataStreamInfo.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.DataStreamInfo.Builder

All Implemented Interfaces:

ObjectBuilder<DataStreamInfo>

Enclosing class:

DataStreamInfo

public static class DataStreamInfo.Builder
extends ObjectBuilderBase
implements ObjectBuilder<DataStreamInfo>

Builder for DataStreamInfo.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataStreamInfo	build()	Builds a DataStreamInfo.
DataStreamInfo.Builder	generation(int value)	Required - generation
DataStreamInfo.Builder	indices(java.util.List<DataStreamIndexInfo> list)	Required - information about data stream's backing indices
DataStreamInfo.Builder	indices(DataStreamIndexInfo value, DataStreamIndexInfo... values)	Required - information about data stream's backing indices
DataStreamInfo.Builder	name(java.lang.String value)	Required - data stream name
DataStreamInfo.Builder	status(HealthStatus value)	Required - health status of the data stream
DataStreamInfo.Builder	template(java.lang.String value)	Required - index template name used to create the data stream's backing indices
DataStreamInfo.Builder	timestampField(java.util.function.Function<DataStreamTimestampField.Builder,ObjectBuilder<DataStreamTimestampField>> fn)	Required - data stream timestamp field
DataStreamInfo.Builder	timestampField(DataStreamTimestampField value)	Required - data stream timestamp field

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

name

public final DataStreamInfo.Builder name(java.lang.String value)

Required - data stream name

API name: name

timestampField

public final DataStreamInfo.Builder timestampField(DataStreamTimestampField value)

Required - data stream timestamp field

API name: timestamp_field

timestampField

public final DataStreamInfo.Builder timestampField(java.util.function.Function<DataStreamTimestampField.Builder,ObjectBuilder<DataStreamTimestampField>> fn)

Required - data stream timestamp field

API name: timestamp_field

indices

public final DataStreamInfo.Builder indices(java.util.List<DataStreamIndexInfo> list)

Required - information about data stream's backing indices

API name: indices

indices

public final DataStreamInfo.Builder indices(DataStreamIndexInfo value,
                                            DataStreamIndexInfo... values)

Required - information about data stream's backing indices

API name: indices

generation

public final DataStreamInfo.Builder generation(int value)

Required - generation

API name: generation

status

public final DataStreamInfo.Builder status(HealthStatus value)

Required - health status of the data stream

API name: status

template

public final DataStreamInfo.Builder template(java.lang.String value)

Required - index template name used to create the data stream's backing indices

API name: template

build

public DataStreamInfo build()

Builds a DataStreamInfo.

Specified by:

build in interface ObjectBuilder<DataStreamInfo>

Throws:

java.lang.NullPointerException - if some of the required fields are null.