Package org.opensearch.client.opensearch.indices

Class DataStreamStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.DataStreamStats.Builder

All Implemented Interfaces:

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

Enclosing class:

DataStreamStats

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

Builder for DataStreamStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final DataStreamStats.Builder	backingIndices(int value)	Required - Current number of backing indexes for the data stream.
DataStreamStats	build()	Builds a DataStreamStats.
DataStreamStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DataStreamStats.Builder	dataStream(String value)	Required - API name: data_stream
final DataStreamStats.Builder	maximumTimestamp(long value)	Required - API name: maximum_timestamp
final DataStreamStats.Builder	storeSize(String value)	API name: store_size
final DataStreamStats.Builder	storeSizeBytes(long value)	Required - The total size, in bytes, of all shards for the data stream's backing indexes.

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

Returns:

a new builder instance.

backingIndices

@Nonnull
public final DataStreamStats.Builder backingIndices(int value)

Required - Current number of backing indexes for the data stream.

API name: backing_indices

dataStream

@Nonnull
public final DataStreamStats.Builder dataStream(String value)

Required - API name: data_stream

maximumTimestamp

@Nonnull
public final DataStreamStats.Builder maximumTimestamp(long value)

Required - API name: maximum_timestamp

storeSize

@Nonnull
public final DataStreamStats.Builder storeSize(@Nullable
 String value)

API name: store_size

storeSizeBytes

@Nonnull
public final DataStreamStats.Builder storeSizeBytes(long value)

Required - The total size, in bytes, of all shards for the data stream's backing indexes.

API name: store_size_bytes

build

@Nonnull
public DataStreamStats build()

Builds a DataStreamStats.

Specified by:

build in interface ObjectBuilder<DataStreamStats>

Throws:

NullPointerException - if some of the required fields are null.