Package org.opensearch.client.opensearch._types

Class StoreStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.StoreStats.Builder

All Implemented Interfaces:

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

Enclosing class:

StoreStats

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

Builder for StoreStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StoreStats	build()	Builds a StoreStats.
StoreStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final StoreStats.Builder	reserved(String value)	API name: reserved
final StoreStats.Builder	reservedInBytes(long value)	Required - A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
final StoreStats.Builder	size(String value)	API name: size
final StoreStats.Builder	sizeInBytes(long value)	Required - The total size, in bytes, of all shards assigned to the selected nodes.

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

Returns:

a new builder instance.

reserved

@Nonnull
public final StoreStats.Builder reserved(@Nullable
 String value)

API name: reserved

reservedInBytes

@Nonnull
public final StoreStats.Builder reservedInBytes(long value)

Required - A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.

API name: reserved_in_bytes

size

@Nonnull
public final StoreStats.Builder size(@Nullable
 String value)

API name: size

sizeInBytes

@Nonnull
public final StoreStats.Builder sizeInBytes(long value)

Required - The total size, in bytes, of all shards assigned to the selected nodes.

API name: size_in_bytes

build

@Nonnull
public StoreStats build()

Builds a StoreStats.

Specified by:

build in interface ObjectBuilder<StoreStats>

Throws:

NullPointerException - if some of the required fields are null.