Package org.opensearch.client.opensearch.cat.recovery

Class RecoveryRecord.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cat.recovery.RecoveryRecord.Builder

All Implemented Interfaces:

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

Enclosing class:

RecoveryRecord

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

Builder for RecoveryRecord.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RecoveryRecord	build()	Builds a RecoveryRecord.
final RecoveryRecord.Builder	bytes(String value)	The number of bytes to recover.
final RecoveryRecord.Builder	bytesPercent(String value)	API name: bytes_percent
final RecoveryRecord.Builder	bytesRecovered(String value)	The bytes recovered.
final RecoveryRecord.Builder	bytesTotal(String value)	The total number of bytes.
RecoveryRecord.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RecoveryRecord.Builder	files(String value)	The number of files to recover.
final RecoveryRecord.Builder	filesPercent(String value)	API name: files_percent
final RecoveryRecord.Builder	filesRecovered(String value)	The files recovered.
final RecoveryRecord.Builder	filesTotal(String value)	The total number of files.
final RecoveryRecord.Builder	index(String value)	API name: index
final RecoveryRecord.Builder	repository(String value)	The repository name.
final RecoveryRecord.Builder	shard(String value)	The shard name.
final RecoveryRecord.Builder	snapshot(String value)	The snapshot name.
final RecoveryRecord.Builder	sourceHost(String value)	The source host.
final RecoveryRecord.Builder	sourceNode(String value)	The source node name.
final RecoveryRecord.Builder	stage(String value)	The recovery stage.
final RecoveryRecord.Builder	startTime(String value)	API name: start_time
final RecoveryRecord.Builder	startTimeMillis(Long value)	API name: start_time_millis
final RecoveryRecord.Builder	stopTime(String value)	API name: stop_time
final RecoveryRecord.Builder	stopTimeMillis(Long value)	API name: stop_time_millis
final RecoveryRecord.Builder	targetHost(String value)	The target host.
final RecoveryRecord.Builder	targetNode(String value)	The target node name.
final RecoveryRecord.Builder	time(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: time
final RecoveryRecord.Builder	time(Time value)	API name: time
final RecoveryRecord.Builder	translogOps(String value)	The number of translog operations to recover.
final RecoveryRecord.Builder	translogOpsPercent(String value)	API name: translog_ops_percent
final RecoveryRecord.Builder	translogOpsRecovered(String value)	The translog operations recovered.
final RecoveryRecord.Builder	type(String value)	The recovery type.

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

Returns:

a new builder instance.

bytes

@Nonnull
public final RecoveryRecord.Builder bytes(@Nullable
 String value)

The number of bytes to recover.

API name: bytes

bytesPercent

@Nonnull
public final RecoveryRecord.Builder bytesPercent(@Nullable
 String value)

API name: bytes_percent

bytesRecovered

@Nonnull
public final RecoveryRecord.Builder bytesRecovered(@Nullable
 String value)

The bytes recovered.

API name: bytes_recovered

bytesTotal

@Nonnull
public final RecoveryRecord.Builder bytesTotal(@Nullable
 String value)

The total number of bytes.

API name: bytes_total

files

@Nonnull
public final RecoveryRecord.Builder files(@Nullable
 String value)

The number of files to recover.

API name: files

filesPercent

@Nonnull
public final RecoveryRecord.Builder filesPercent(@Nullable
 String value)

API name: files_percent

filesRecovered

@Nonnull
public final RecoveryRecord.Builder filesRecovered(@Nullable
 String value)

The files recovered.

API name: files_recovered

filesTotal

@Nonnull
public final RecoveryRecord.Builder filesTotal(@Nullable
 String value)

The total number of files.

API name: files_total

index

@Nonnull
public final RecoveryRecord.Builder index(@Nullable
 String value)

API name: index

repository

@Nonnull
public final RecoveryRecord.Builder repository(@Nullable
 String value)

The repository name.

API name: repository

shard

@Nonnull
public final RecoveryRecord.Builder shard(@Nullable
 String value)

The shard name.

API name: shard

snapshot

@Nonnull
public final RecoveryRecord.Builder snapshot(@Nullable
 String value)

The snapshot name.

API name: snapshot

sourceHost

@Nonnull
public final RecoveryRecord.Builder sourceHost(@Nullable
 String value)

The source host.

API name: source_host

sourceNode

@Nonnull
public final RecoveryRecord.Builder sourceNode(@Nullable
 String value)

The source node name.

API name: source_node

stage

@Nonnull
public final RecoveryRecord.Builder stage(@Nullable
 String value)

The recovery stage.

API name: stage

startTime

@Nonnull
public final RecoveryRecord.Builder startTime(@Nullable
 String value)

API name: start_time

startTimeMillis

@Nonnull
public final RecoveryRecord.Builder startTimeMillis(@Nullable
 Long value)

API name: start_time_millis

stopTime

@Nonnull
public final RecoveryRecord.Builder stopTime(@Nullable
 String value)

API name: stop_time

stopTimeMillis

@Nonnull
public final RecoveryRecord.Builder stopTimeMillis(@Nullable
 Long value)

API name: stop_time_millis

targetHost

@Nonnull
public final RecoveryRecord.Builder targetHost(@Nullable
 String value)

The target host.

API name: target_host

targetNode

@Nonnull
public final RecoveryRecord.Builder targetNode(@Nullable
 String value)

The target node name.

API name: target_node

time

@Nonnull
public final RecoveryRecord.Builder time(@Nullable
 Time value)

API name: time

time

@Nonnull
public final RecoveryRecord.Builder time(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: time

translogOps

@Nonnull
public final RecoveryRecord.Builder translogOps(@Nullable
 String value)

The number of translog operations to recover.

API name: translog_ops

translogOpsPercent

@Nonnull
public final RecoveryRecord.Builder translogOpsPercent(@Nullable
 String value)

API name: translog_ops_percent

translogOpsRecovered

@Nonnull
public final RecoveryRecord.Builder translogOpsRecovered(@Nullable
 String value)

The translog operations recovered.

API name: translog_ops_recovered

type

@Nonnull
public final RecoveryRecord.Builder type(@Nullable
 String value)

The recovery type.

API name: type

build

@Nonnull
public RecoveryRecord build()

Builds a RecoveryRecord.

Specified by:

build in interface ObjectBuilder<RecoveryRecord>

Throws:

NullPointerException - if some of the required fields are null.