Package org.opensearch.client.opensearch.indices

Class DataStreamsStatsResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.DataStreamsStatsResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

DataStreamsStatsResponse

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

Builder for DataStreamsStatsResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final DataStreamsStatsResponse.Builder	backingIndices(int value)	Required - Total number of backing indexes for the selected data streams.
DataStreamsStatsResponse	build()	Builds a DataStreamsStatsResponse.
DataStreamsStatsResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DataStreamsStatsResponse.Builder	dataStreamCount(int value)	Required - Total number of selected data streams.
final DataStreamsStatsResponse.Builder	dataStreams(Function<DataStreamStats.Builder,ObjectBuilder<DataStreamStats>> fn)	Required - Contains statistics for the selected data streams.
final DataStreamsStatsResponse.Builder	dataStreams(List<DataStreamStats> list)	Required - Contains statistics for the selected data streams.
final DataStreamsStatsResponse.Builder	dataStreams(DataStreamStats value, DataStreamStats... values)	Required - Contains statistics for the selected data streams.
final DataStreamsStatsResponse.Builder	shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)	Required - API name: _shards
final DataStreamsStatsResponse.Builder	shards(ShardStatistics value)	Required - API name: _shards
final DataStreamsStatsResponse.Builder	totalStoreSize(String value)	API name: total_store_size
final DataStreamsStatsResponse.Builder	totalStoreSizeBytes(long value)	Required - Total size, in bytes, of all shards for the selected data streams.

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

Returns:

a new builder instance.

backingIndices

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

Required - Total number of backing indexes for the selected data streams.

API name: backing_indices

dataStreamCount

@Nonnull
public final DataStreamsStatsResponse.Builder dataStreamCount(int value)

Required - Total number of selected data streams.

API name: data_stream_count

dataStreams

@Nonnull
public final DataStreamsStatsResponse.Builder dataStreams(List<DataStreamStats> list)

Required - Contains statistics for the selected data streams.

API name: data_streams

Adds all elements of list to dataStreams.

dataStreams

@Nonnull
public final DataStreamsStatsResponse.Builder dataStreams(DataStreamStats value,
 DataStreamStats... values)

Required - Contains statistics for the selected data streams.

API name: data_streams

Adds one or more values to dataStreams.

dataStreams

@Nonnull
public final DataStreamsStatsResponse.Builder dataStreams(Function<DataStreamStats.Builder,ObjectBuilder<DataStreamStats>> fn)

Required - Contains statistics for the selected data streams.

API name: data_streams

Adds a value to dataStreams using a builder lambda.

shards

@Nonnull
public final DataStreamsStatsResponse.Builder shards(ShardStatistics value)

Required - API name: _shards

shards

@Nonnull
public final DataStreamsStatsResponse.Builder shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)

Required - API name: _shards

totalStoreSize

@Nonnull
public final DataStreamsStatsResponse.Builder totalStoreSize(@Nullable
 String value)

API name: total_store_size

totalStoreSizeBytes

@Nonnull
public final DataStreamsStatsResponse.Builder totalStoreSizeBytes(long value)

Required - Total size, in bytes, of all shards for the selected data streams.

API name: total_store_size_bytes

build

@Nonnull
public DataStreamsStatsResponse build()

Builds a DataStreamsStatsResponse.

Specified by:

build in interface ObjectBuilder<DataStreamsStatsResponse>

Throws:

NullPointerException - if some of the required fields are null.