Package org.opensearch.client.opensearch.indices.recovery

Class RecoveryFiles.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.recovery.RecoveryFiles.Builder

All Implemented Interfaces:

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

Enclosing class:

RecoveryFiles

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

Builder for RecoveryFiles.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RecoveryFiles	build()	Builds a RecoveryFiles.
RecoveryFiles.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RecoveryFiles.Builder	details(Function<FileDetails.Builder,ObjectBuilder<FileDetails>> fn)	The detailed information about recovered files.
final RecoveryFiles.Builder	details(List<FileDetails> list)	The detailed information about recovered files.
final RecoveryFiles.Builder	details(FileDetails value, FileDetails... values)	The detailed information about recovered files.
final RecoveryFiles.Builder	percent(String value)	Required - API name: percent
final RecoveryFiles.Builder	recovered(long value)	Required - The number of recovered files.
final RecoveryFiles.Builder	reused(long value)	Required - The number of reused files.
final RecoveryFiles.Builder	total(long value)	Required - The total number of files.

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

Returns:

a new builder instance.

details

@Nonnull
public final RecoveryFiles.Builder details(List<FileDetails> list)

The detailed information about recovered files.

API name: details

Adds all elements of list to details.

details

@Nonnull
public final RecoveryFiles.Builder details(FileDetails value,
 FileDetails... values)

The detailed information about recovered files.

API name: details

Adds one or more values to details.

details

@Nonnull
public final RecoveryFiles.Builder details(Function<FileDetails.Builder,ObjectBuilder<FileDetails>> fn)

The detailed information about recovered files.

API name: details

Adds a value to details using a builder lambda.

percent

@Nonnull
public final RecoveryFiles.Builder percent(String value)

Required - API name: percent

recovered

@Nonnull
public final RecoveryFiles.Builder recovered(long value)

Required - The number of recovered files.

API name: recovered

reused

@Nonnull
public final RecoveryFiles.Builder reused(long value)

Required - The number of reused files.

API name: reused

total

@Nonnull
public final RecoveryFiles.Builder total(long value)

Required - The total number of files.

API name: total

build

@Nonnull
public RecoveryFiles build()

Builds a RecoveryFiles.

Specified by:

build in interface ObjectBuilder<RecoveryFiles>

Throws:

NullPointerException - if some of the required fields are null.