Package org.opensearch.client.opensearch._types

Class RecoveryStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RecoveryStats.Builder

All Implemented Interfaces:

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

Enclosing class:

RecoveryStats

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

Builder for RecoveryStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RecoveryStats	build()	Builds a RecoveryStats.
RecoveryStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RecoveryStats.Builder	currentAsSource(long value)	Required - The number of ongoing recoveries for which this node is the source.
final RecoveryStats.Builder	currentAsTarget(long value)	Required - The number of ongoing recoveries for which this node is the target.
final RecoveryStats.Builder	throttleTime(Function<Time.Builder,ObjectBuilder<Time>> fn)	The total amount of time recovery operations have been throttled.
final RecoveryStats.Builder	throttleTime(Time value)	The total amount of time recovery operations have been throttled.
final RecoveryStats.Builder	throttleTimeInMillis(long value)	Required - The total amount of time recovery operations have been throttled in milliseconds.

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

Returns:

a new builder instance.

currentAsSource

@Nonnull
public final RecoveryStats.Builder currentAsSource(long value)

Required - The number of ongoing recoveries for which this node is the source.

API name: current_as_source

currentAsTarget

@Nonnull
public final RecoveryStats.Builder currentAsTarget(long value)

Required - The number of ongoing recoveries for which this node is the target.

API name: current_as_target

throttleTime

@Nonnull
public final RecoveryStats.Builder throttleTime(@Nullable
 Time value)

The total amount of time recovery operations have been throttled.

API name: throttle_time

throttleTime

@Nonnull
public final RecoveryStats.Builder throttleTime(Function<Time.Builder,ObjectBuilder<Time>> fn)

The total amount of time recovery operations have been throttled.

API name: throttle_time

throttleTimeInMillis

@Nonnull
public final RecoveryStats.Builder throttleTimeInMillis(long value)

Required - The total amount of time recovery operations have been throttled in milliseconds.

API name: throttle_time_in_millis

build

@Nonnull
public RecoveryStats build()

Builds a RecoveryStats.

Specified by:

build in interface ObjectBuilder<RecoveryStats>

Throws:

NullPointerException - if some of the required fields are null.