Package org.opensearch.client.opensearch.cluster.allocation_explain

Class DiskUsage.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cluster.allocation_explain.DiskUsage.Builder

All Implemented Interfaces:

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

Enclosing class:

DiskUsage

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

Builder for DiskUsage.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DiskUsage	build()	Builds a DiskUsage.
DiskUsage.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DiskUsage.Builder	free(String value)	API name: free
final DiskUsage.Builder	freeBytes(long value)	Required - API name: free_bytes
final DiskUsage.Builder	freeDiskPercent(double value)	Required - API name: free_disk_percent
final DiskUsage.Builder	path(String value)	Required - API name: path
final DiskUsage.Builder	total(String value)	API name: total
final DiskUsage.Builder	totalBytes(long value)	Required - API name: total_bytes
final DiskUsage.Builder	used(String value)	API name: used
final DiskUsage.Builder	usedBytes(long value)	Required - API name: used_bytes
final DiskUsage.Builder	usedDiskPercent(double value)	Required - API name: used_disk_percent

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

Returns:

a new builder instance.

free

@Nonnull
public final DiskUsage.Builder free(@Nullable
 String value)

API name: free

freeBytes

@Nonnull
public final DiskUsage.Builder freeBytes(long value)

Required - API name: free_bytes

freeDiskPercent

@Nonnull
public final DiskUsage.Builder freeDiskPercent(double value)

Required - API name: free_disk_percent

path

@Nonnull
public final DiskUsage.Builder path(String value)

Required - API name: path

total

@Nonnull
public final DiskUsage.Builder total(@Nullable
 String value)

API name: total

totalBytes

@Nonnull
public final DiskUsage.Builder totalBytes(long value)

Required - API name: total_bytes

used

@Nonnull
public final DiskUsage.Builder used(@Nullable
 String value)

API name: used

usedBytes

@Nonnull
public final DiskUsage.Builder usedBytes(long value)

Required - API name: used_bytes

usedDiskPercent

@Nonnull
public final DiskUsage.Builder usedDiskPercent(double value)

Required - API name: used_disk_percent

build

@Nonnull
public DiskUsage build()

Builds a DiskUsage.

Specified by:

build in interface ObjectBuilder<DiskUsage>

Throws:

NullPointerException - if some of the required fields are null.