Package org.opensearch.client.opensearch.cat.snapshots

Class SnapshotsRecord.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cat.snapshots.SnapshotsRecord.Builder

All Implemented Interfaces:

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

Enclosing class:

SnapshotsRecord

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

Builder for SnapshotsRecord.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotsRecord	build()	Builds a SnapshotsRecord.
SnapshotsRecord.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SnapshotsRecord.Builder	duration(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: duration
final SnapshotsRecord.Builder	duration(Time value)	API name: duration
final SnapshotsRecord.Builder	endEpoch(Long value)	API name: end_epoch
final SnapshotsRecord.Builder	endTime(String value)	API name: end_time
final SnapshotsRecord.Builder	failedShards(String value)	The number of failed shards in the snapshot.
final SnapshotsRecord.Builder	id(String value)	The unique identifier for the snapshot.
final SnapshotsRecord.Builder	indices(String value)	The number of indexes in the snapshot.
final SnapshotsRecord.Builder	reason(String value)	The reason for any snapshot failures.
final SnapshotsRecord.Builder	repository(String value)	The repository name.
final SnapshotsRecord.Builder	startEpoch(Long value)	API name: start_epoch
final SnapshotsRecord.Builder	startTime(String value)	API name: start_time
final SnapshotsRecord.Builder	status(String value)	The state of the snapshot process.
final SnapshotsRecord.Builder	successfulShards(String value)	The number of successful shards in the snapshot.
final SnapshotsRecord.Builder	totalShards(String value)	The total number of shards in the snapshot.

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

Returns:

a new builder instance.

duration

@Nonnull
public final SnapshotsRecord.Builder duration(@Nullable
 Time value)

API name: duration

duration

@Nonnull
public final SnapshotsRecord.Builder duration(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: duration

endEpoch

@Nonnull
public final SnapshotsRecord.Builder endEpoch(@Nullable
 Long value)

API name: end_epoch

endTime

@Nonnull
public final SnapshotsRecord.Builder endTime(@Nullable
 String value)

API name: end_time

failedShards

@Nonnull
public final SnapshotsRecord.Builder failedShards(@Nullable
 String value)

The number of failed shards in the snapshot.

API name: failed_shards

id

@Nonnull
public final SnapshotsRecord.Builder id(@Nullable
 String value)

The unique identifier for the snapshot.

API name: id

indices

@Nonnull
public final SnapshotsRecord.Builder indices(@Nullable
 String value)

The number of indexes in the snapshot.

API name: indices

reason

@Nonnull
public final SnapshotsRecord.Builder reason(@Nullable
 String value)

The reason for any snapshot failures.

API name: reason

repository

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

The repository name.

API name: repository

startEpoch

@Nonnull
public final SnapshotsRecord.Builder startEpoch(@Nullable
 Long value)

API name: start_epoch

startTime

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

API name: start_time

status

@Nonnull
public final SnapshotsRecord.Builder status(@Nullable
 String value)

The state of the snapshot process. Returned values include: FAILED: The snapshot process failed. INCOMPATIBLE: The snapshot process is incompatible with the current cluster version. IN_PROGRESS: The snapshot process started but has not completed. PARTIAL: The snapshot process completed with a partial success. SUCCESS: The snapshot process completed with a full success.

API name: status

successfulShards

@Nonnull
public final SnapshotsRecord.Builder successfulShards(@Nullable
 String value)

The number of successful shards in the snapshot.

API name: successful_shards

totalShards

@Nonnull
public final SnapshotsRecord.Builder totalShards(@Nullable
 String value)

The total number of shards in the snapshot.

API name: total_shards

build

@Nonnull
public SnapshotsRecord build()

Builds a SnapshotsRecord.

Specified by:

build in interface ObjectBuilder<SnapshotsRecord>

Throws:

NullPointerException - if some of the required fields are null.