Package org.opensearch.client.opensearch.snapshot

Class SnapshotInfo.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.SnapshotInfo.Builder

All Implemented Interfaces:

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

Enclosing class:

SnapshotInfo

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

Builder for SnapshotInfo.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotInfo	build()	Builds a SnapshotInfo.
SnapshotInfo.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SnapshotInfo.Builder	dataStreams(String value, String... values)	The list of data streams included in the snapshot.
final SnapshotInfo.Builder	dataStreams(List<String> list)	The list of data streams included in the snapshot.
final SnapshotInfo.Builder	duration(Function<Time.Builder,ObjectBuilder<Time>> fn)	The total time taken to complete the snapshot.
final SnapshotInfo.Builder	duration(Time value)	The total time taken to complete the snapshot.
final SnapshotInfo.Builder	durationInMillis(Long value)	The total time taken to complete the snapshot in milliseconds.
final SnapshotInfo.Builder	endTime(String value)	The time when the snapshot completed.
final SnapshotInfo.Builder	endTimeInMillis(Long value)	The time when the snapshot completed in milliseconds.
final SnapshotInfo.Builder	failures(Function<SnapshotShardFailure.Builder,ObjectBuilder<SnapshotShardFailure>> fn)	The list of shard failures that occurred during the snapshot.
final SnapshotInfo.Builder	failures(List<SnapshotShardFailure> list)	The list of shard failures that occurred during the snapshot.
final SnapshotInfo.Builder	failures(SnapshotShardFailure value, SnapshotShardFailure... values)	The list of shard failures that occurred during the snapshot.
final SnapshotInfo.Builder	includeGlobalState(Boolean value)	Whether the snapshot includes the cluster state.
final SnapshotInfo.Builder	indices(String value, String... values)	The list of indexes included in the snapshot.
final SnapshotInfo.Builder	indices(List<String> list)	The list of indexes included in the snapshot.
final SnapshotInfo.Builder	metadata(String key, JsonData value)	The custom metadata attached to the snapshot.
final SnapshotInfo.Builder	metadata(Map<String,JsonData> map)	The custom metadata attached to the snapshot.
final SnapshotInfo.Builder	pinnedTimestamp(Long value)	The timestamp when the snapshot was pinned.
final SnapshotInfo.Builder	reason(String value)	The reason for the snapshot creation.
final SnapshotInfo.Builder	remoteStoreIndexShallowCopy(Boolean value)	Whether the snapshot uses remote store index shallow copy.
final SnapshotInfo.Builder	shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)	The statistics about the shards included in the snapshot.
final SnapshotInfo.Builder	shards(ShardStatistics value)	The statistics about the shards included in the snapshot.
final SnapshotInfo.Builder	snapshot(String value)	The name of the snapshot.
final SnapshotInfo.Builder	startTime(String value)	The time when the snapshot started.
final SnapshotInfo.Builder	startTimeInMillis(Long value)	The time when the snapshot started in milliseconds.
final SnapshotInfo.Builder	state(String value)	The current state of the snapshot.
final SnapshotInfo.Builder	uuid(String value)	The unique identifier for the snapshot.
final SnapshotInfo.Builder	version(String value)	The version of OpenSearch when the snapshot was created.
final SnapshotInfo.Builder	versionId(Long value)	The internal version number of OpenSearch when the snapshot was created.

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

Returns:

a new builder instance.

dataStreams

@Nonnull
public final SnapshotInfo.Builder dataStreams(List<String> list)

The list of data streams included in the snapshot.

API name: data_streams

Adds all elements of list to dataStreams.

dataStreams

@Nonnull
public final SnapshotInfo.Builder dataStreams(String value,
 String... values)

The list of data streams included in the snapshot.

API name: data_streams

Adds one or more values to dataStreams.

duration

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

The total time taken to complete the snapshot.

API name: duration

duration

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

The total time taken to complete the snapshot.

API name: duration

durationInMillis

@Nonnull
public final SnapshotInfo.Builder durationInMillis(@Nullable
 Long value)

The total time taken to complete the snapshot in milliseconds.

API name: duration_in_millis

endTime

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

The time when the snapshot completed.

API name: end_time

endTimeInMillis

@Nonnull
public final SnapshotInfo.Builder endTimeInMillis(@Nullable
 Long value)

The time when the snapshot completed in milliseconds.

API name: end_time_in_millis

failures

@Nonnull
public final SnapshotInfo.Builder failures(List<SnapshotShardFailure> list)

The list of shard failures that occurred during the snapshot.

API name: failures

Adds all elements of list to failures.

failures

@Nonnull
public final SnapshotInfo.Builder failures(SnapshotShardFailure value,
 SnapshotShardFailure... values)

The list of shard failures that occurred during the snapshot.

API name: failures

Adds one or more values to failures.

failures

@Nonnull
public final SnapshotInfo.Builder failures(Function<SnapshotShardFailure.Builder,ObjectBuilder<SnapshotShardFailure>> fn)

The list of shard failures that occurred during the snapshot.

API name: failures

Adds a value to failures using a builder lambda.

includeGlobalState

@Nonnull
public final SnapshotInfo.Builder includeGlobalState(@Nullable
 Boolean value)

Whether the snapshot includes the cluster state.

API name: include_global_state

indices

@Nonnull
public final SnapshotInfo.Builder indices(List<String> list)

The list of indexes included in the snapshot.

API name: indices

Adds all elements of list to indices.

indices

@Nonnull
public final SnapshotInfo.Builder indices(String value,
 String... values)

The list of indexes included in the snapshot.

API name: indices

Adds one or more values to indices.

metadata

@Nonnull
public final SnapshotInfo.Builder metadata(Map<String,JsonData> map)

The custom metadata attached to the snapshot.

API name: metadata

Adds all elements of map to metadata.

metadata

@Nonnull
public final SnapshotInfo.Builder metadata(String key,
 JsonData value)

The custom metadata attached to the snapshot.

API name: metadata

Adds an entry to metadata.

pinnedTimestamp

@Nonnull
public final SnapshotInfo.Builder pinnedTimestamp(@Nullable
 Long value)

The timestamp when the snapshot was pinned.

API name: pinned_timestamp

reason

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

The reason for the snapshot creation.

API name: reason

remoteStoreIndexShallowCopy

@Nonnull
public final SnapshotInfo.Builder remoteStoreIndexShallowCopy(@Nullable
 Boolean value)

Whether the snapshot uses remote store index shallow copy.

API name: remote_store_index_shallow_copy

shards

@Nonnull
public final SnapshotInfo.Builder shards(@Nullable
 ShardStatistics value)

The statistics about the shards included in the snapshot.

API name: shards

shards

@Nonnull
public final SnapshotInfo.Builder shards(Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)

The statistics about the shards included in the snapshot.

API name: shards

snapshot

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

The name of the snapshot.

API name: snapshot

startTime

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

The time when the snapshot started.

API name: start_time

startTimeInMillis

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

The time when the snapshot started in milliseconds.

API name: start_time_in_millis

state

@Nonnull
public final SnapshotInfo.Builder state(@Nullable
 String value)

The current state of the snapshot.

API name: state

uuid

@Nonnull
public final SnapshotInfo.Builder uuid(@Nullable
 String value)

The unique identifier for the snapshot.

API name: uuid

version

@Nonnull
public final SnapshotInfo.Builder version(@Nullable
 String value)

The version of OpenSearch when the snapshot was created.

API name: version

versionId

@Nonnull
public final SnapshotInfo.Builder versionId(@Nullable
 Long value)

The internal version number of OpenSearch when the snapshot was created.

API name: version_id

build

@Nonnull
public SnapshotInfo build()

Builds a SnapshotInfo.

Specified by:

build in interface ObjectBuilder<SnapshotInfo>

Throws:

NullPointerException - if some of the required fields are null.