Package org.opensearch.client.opensearch.snapshot

Class SnapshotStats.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.SnapshotStats.Builder

All Implemented Interfaces:

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

Enclosing class:

SnapshotStats

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

Builder for SnapshotStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotStats	build()	Builds a SnapshotStats.
SnapshotStats.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SnapshotStats.Builder	incremental(Function<FileCountSnapshotStats.Builder,ObjectBuilder<FileCountSnapshotStats>> fn)	The incremental statistics for the snapshot.
final SnapshotStats.Builder	incremental(FileCountSnapshotStats value)	The incremental statistics for the snapshot.
final SnapshotStats.Builder	processed(Function<FileCountSnapshotStats.Builder,ObjectBuilder<FileCountSnapshotStats>> fn)	The processed statistics for the snapshot.
final SnapshotStats.Builder	processed(FileCountSnapshotStats value)	The processed statistics for the snapshot.
final SnapshotStats.Builder	startTimeInMillis(Long value)	When the snapshot started in milliseconds.
final SnapshotStats.Builder	time(Function<Time.Builder,ObjectBuilder<Time>> fn)	The total time taken for the snapshot.
final SnapshotStats.Builder	time(Time value)	The total time taken for the snapshot.
final SnapshotStats.Builder	timeInMillis(Long value)	The total time taken for the snapshot in milliseconds.
final SnapshotStats.Builder	total(Function<FileCountSnapshotStats.Builder,ObjectBuilder<FileCountSnapshotStats>> fn)	The total statistics for the snapshot.
final SnapshotStats.Builder	total(FileCountSnapshotStats value)	The total statistics for 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 SnapshotStats.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<SnapshotStats.Builder,SnapshotStats>

Returns:

a new builder instance.

incremental

@Nonnull
public final SnapshotStats.Builder incremental(@Nullable
 FileCountSnapshotStats value)

The incremental statistics for the snapshot.

API name: incremental

incremental

@Nonnull
public final SnapshotStats.Builder incremental(Function<FileCountSnapshotStats.Builder,ObjectBuilder<FileCountSnapshotStats>> fn)

The incremental statistics for the snapshot.

API name: incremental

processed

@Nonnull
public final SnapshotStats.Builder processed(@Nullable
 FileCountSnapshotStats value)

The processed statistics for the snapshot.

API name: processed

processed

@Nonnull
public final SnapshotStats.Builder processed(Function<FileCountSnapshotStats.Builder,ObjectBuilder<FileCountSnapshotStats>> fn)

The processed statistics for the snapshot.

API name: processed

startTimeInMillis

@Nonnull
public final SnapshotStats.Builder startTimeInMillis(@Nullable
 Long value)

When the snapshot started in milliseconds.

API name: start_time_in_millis

time

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

The total time taken for the snapshot.

API name: time

time

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

The total time taken for the snapshot.

API name: time

timeInMillis

@Nonnull
public final SnapshotStats.Builder timeInMillis(@Nullable
 Long value)

The total time taken for the snapshot in milliseconds.

API name: time_in_millis

total

@Nonnull
public final SnapshotStats.Builder total(@Nullable
 FileCountSnapshotStats value)

The total statistics for the snapshot.

API name: total

total

@Nonnull
public final SnapshotStats.Builder total(Function<FileCountSnapshotStats.Builder,ObjectBuilder<FileCountSnapshotStats>> fn)

The total statistics for the snapshot.

API name: total

build

@Nonnull
public SnapshotStats build()

Builds a SnapshotStats.

Specified by:

build in interface ObjectBuilder<SnapshotStats>

Throws:

NullPointerException - if some of the required fields are null.