Package org.opensearch.client.opensearch.nodes.stats

Class IoStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.nodes.stats.IoStats.Builder

All Implemented Interfaces:

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

Enclosing class:

IoStats

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

Builder for IoStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IoStats	build()	Builds a IoStats.
IoStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IoStats.Builder	devices(Function<IoStatDevice.Builder,ObjectBuilder<IoStatDevice>> fn)	Array of disk metrics for each device that is backing an OpenSearch data path.
final IoStats.Builder	devices(List<IoStatDevice> list)	Array of disk metrics for each device that is backing an OpenSearch data path.
final IoStats.Builder	devices(IoStatDevice value, IoStatDevice... values)	Array of disk metrics for each device that is backing an OpenSearch data path.
final IoStats.Builder	total(Function<IoStatDevice.Builder,ObjectBuilder<IoStatDevice>> fn)	API name: total
final IoStats.Builder	total(IoStatDevice value)	API name: total

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

Returns:

a new builder instance.

devices

@Nonnull
public final IoStats.Builder devices(List<IoStatDevice> list)

Array of disk metrics for each device that is backing an OpenSearch data path. These disk metrics are probed periodically and averages between the last probe and the current probe are computed.

API name: devices

Adds all elements of list to devices.

devices

@Nonnull
public final IoStats.Builder devices(IoStatDevice value,
 IoStatDevice... values)

Array of disk metrics for each device that is backing an OpenSearch data path. These disk metrics are probed periodically and averages between the last probe and the current probe are computed.

API name: devices

Adds one or more values to devices.

devices

@Nonnull
public final IoStats.Builder devices(Function<IoStatDevice.Builder,ObjectBuilder<IoStatDevice>> fn)

Array of disk metrics for each device that is backing an OpenSearch data path. These disk metrics are probed periodically and averages between the last probe and the current probe are computed.

API name: devices

Adds a value to devices using a builder lambda.

total

@Nonnull
public final IoStats.Builder total(@Nullable
 IoStatDevice value)

API name: total

total

@Nonnull
public final IoStats.Builder total(Function<IoStatDevice.Builder,ObjectBuilder<IoStatDevice>> fn)

API name: total

build

@Nonnull
public IoStats build()

Builds a IoStats.

Specified by:

build in interface ObjectBuilder<IoStats>

Throws:

NullPointerException - if some of the required fields are null.