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

Class ShardRecovery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.recovery.ShardRecovery.Builder

All Implemented Interfaces:

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

Enclosing class:

ShardRecovery

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

Builder for ShardRecovery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardRecovery	build()	Builds a ShardRecovery.
ShardRecovery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardRecovery.Builder	id(int value)	Required - The shard ID.
final ShardRecovery.Builder	index(Function<RecoveryIndexStatus.Builder,ObjectBuilder<RecoveryIndexStatus>> fn)	Required - API name: index
final ShardRecovery.Builder	index(RecoveryIndexStatus value)	Required - API name: index
final ShardRecovery.Builder	primary(boolean value)	Required - Whether this is a primary shard.
final ShardRecovery.Builder	source(Function<RecoveryOrigin.Builder,ObjectBuilder<RecoveryOrigin>> fn)	Required - API name: source
final ShardRecovery.Builder	source(RecoveryOrigin value)	Required - API name: source
final ShardRecovery.Builder	stage(String value)	Required - The current recovery stage.
final ShardRecovery.Builder	start(Function<RecoveryStartStatus.Builder,ObjectBuilder<RecoveryStartStatus>> fn)	API name: start
final ShardRecovery.Builder	start(RecoveryStartStatus value)	API name: start
final ShardRecovery.Builder	startTime(String value)	API name: start_time
final ShardRecovery.Builder	startTimeInMillis(long value)	Required - API name: start_time_in_millis
final ShardRecovery.Builder	stopTime(String value)	API name: stop_time
final ShardRecovery.Builder	stopTimeInMillis(Long value)	API name: stop_time_in_millis
final ShardRecovery.Builder	target(Function<RecoveryOrigin.Builder,ObjectBuilder<RecoveryOrigin>> fn)	Required - API name: target
final ShardRecovery.Builder	target(RecoveryOrigin value)	Required - API name: target
final ShardRecovery.Builder	totalTime(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: total_time
final ShardRecovery.Builder	totalTime(Time value)	API name: total_time
final ShardRecovery.Builder	totalTimeInMillis(long value)	Required - API name: total_time_in_millis
final ShardRecovery.Builder	translog(Function<TranslogStatus.Builder,ObjectBuilder<TranslogStatus>> fn)	Required - API name: translog
final ShardRecovery.Builder	translog(TranslogStatus value)	Required - API name: translog
final ShardRecovery.Builder	type(String value)	Required - The type of recovery operation.
final ShardRecovery.Builder	verifyIndex(Function<VerifyIndex.Builder,ObjectBuilder<VerifyIndex>> fn)	Required - API name: verify_index
final ShardRecovery.Builder	verifyIndex(VerifyIndex value)	Required - API name: verify_index

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

Returns:

a new builder instance.

id

@Nonnull
public final ShardRecovery.Builder id(int value)

Required - The shard ID.

API name: id

index

@Nonnull
public final ShardRecovery.Builder index(RecoveryIndexStatus value)

Required - API name: index

index

@Nonnull
public final ShardRecovery.Builder index(Function<RecoveryIndexStatus.Builder,ObjectBuilder<RecoveryIndexStatus>> fn)

Required - API name: index

primary

@Nonnull
public final ShardRecovery.Builder primary(boolean value)

Required - Whether this is a primary shard.

API name: primary

source

@Nonnull
public final ShardRecovery.Builder source(RecoveryOrigin value)

Required - API name: source

source

@Nonnull
public final ShardRecovery.Builder source(Function<RecoveryOrigin.Builder,ObjectBuilder<RecoveryOrigin>> fn)

Required - API name: source

stage

@Nonnull
public final ShardRecovery.Builder stage(String value)

Required - The current recovery stage.

API name: stage

start

@Nonnull
public final ShardRecovery.Builder start(@Nullable
 RecoveryStartStatus value)

API name: start

start

@Nonnull
public final ShardRecovery.Builder start(Function<RecoveryStartStatus.Builder,ObjectBuilder<RecoveryStartStatus>> fn)

API name: start

startTime

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

API name: start_time

startTimeInMillis

@Nonnull
public final ShardRecovery.Builder startTimeInMillis(long value)

Required - API name: start_time_in_millis

stopTime

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

API name: stop_time

stopTimeInMillis

@Nonnull
public final ShardRecovery.Builder stopTimeInMillis(@Nullable
 Long value)

API name: stop_time_in_millis

target

@Nonnull
public final ShardRecovery.Builder target(RecoveryOrigin value)

Required - API name: target

target

@Nonnull
public final ShardRecovery.Builder target(Function<RecoveryOrigin.Builder,ObjectBuilder<RecoveryOrigin>> fn)

Required - API name: target

totalTime

@Nonnull
public final ShardRecovery.Builder totalTime(@Nullable
 Time value)

API name: total_time

totalTime

@Nonnull
public final ShardRecovery.Builder totalTime(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: total_time

totalTimeInMillis

@Nonnull
public final ShardRecovery.Builder totalTimeInMillis(long value)

Required - API name: total_time_in_millis

translog

@Nonnull
public final ShardRecovery.Builder translog(TranslogStatus value)

Required - API name: translog

translog

@Nonnull
public final ShardRecovery.Builder translog(Function<TranslogStatus.Builder,ObjectBuilder<TranslogStatus>> fn)

Required - API name: translog

type

@Nonnull
public final ShardRecovery.Builder type(String value)

Required - The type of recovery operation.

API name: type

verifyIndex

@Nonnull
public final ShardRecovery.Builder verifyIndex(VerifyIndex value)

Required - API name: verify_index

verifyIndex

@Nonnull
public final ShardRecovery.Builder verifyIndex(Function<VerifyIndex.Builder,ObjectBuilder<VerifyIndex>> fn)

Required - API name: verify_index

build

@Nonnull
public ShardRecovery build()

Builds a ShardRecovery.

Specified by:

build in interface ObjectBuilder<ShardRecovery>

Throws:

NullPointerException - if some of the required fields are null.