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:

ObjectBuilder<SnapshotInfo>

Enclosing class:

SnapshotInfo

public static class SnapshotInfo.Builder
extends ObjectBuilderBase
implements ObjectBuilder<SnapshotInfo>

Builder for SnapshotInfo.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnapshotInfo	build()	Builds a SnapshotInfo.
SnapshotInfo.Builder	dataStreams(java.lang.String value, java.lang.String... values)	Required - API name: data_streams
SnapshotInfo.Builder	dataStreams(java.util.List<java.lang.String> list)	Required - API name: data_streams
SnapshotInfo.Builder	duration(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: duration
SnapshotInfo.Builder	duration(Time value)	API name: duration
SnapshotInfo.Builder	durationInMillis(java.lang.String value)	API name: duration_in_millis
SnapshotInfo.Builder	endTime(Time value)	API name: end_time
SnapshotInfo.Builder	endTimeInMillis(java.lang.String value)	API name: end_time_in_millis
SnapshotInfo.Builder	failures(java.util.function.Function<SnapshotShardFailure.Builder,ObjectBuilder<SnapshotShardFailure>> fn)	API name: failures
SnapshotInfo.Builder	failures(java.util.List<SnapshotShardFailure> list)	API name: failures
SnapshotInfo.Builder	failures(SnapshotShardFailure value, SnapshotShardFailure... values)	API name: failures
SnapshotInfo.Builder	includeGlobalState(java.lang.Boolean value)	API name: include_global_state
SnapshotInfo.Builder	indices(java.lang.String value, java.lang.String... values)	API name: indices
SnapshotInfo.Builder	indices(java.util.List<java.lang.String> list)	API name: indices
SnapshotInfo.Builder	metadata(java.lang.String key, JsonData value)	API name: metadata
SnapshotInfo.Builder	metadata(java.util.Map<java.lang.String,JsonData> map)	API name: metadata
SnapshotInfo.Builder	pinnedTimestamp(java.lang.Long value)	API name: pinned_timestamp
SnapshotInfo.Builder	reason(java.lang.String value)	API name: reason
SnapshotInfo.Builder	remoteStoreIndexShallowCopy(java.lang.Boolean value)	API name: remote_store_index_shallow_copy
SnapshotInfo.Builder	shards(java.util.function.Function<ShardStatistics.Builder,ObjectBuilder<ShardStatistics>> fn)	API name: shards
SnapshotInfo.Builder	shards(ShardStatistics value)	API name: shards
SnapshotInfo.Builder	snapshot(java.lang.String value)	Required - API name: snapshot
SnapshotInfo.Builder	startTime(Time value)	API name: start_time
SnapshotInfo.Builder	startTimeInMillis(java.lang.String value)	API name: start_time_in_millis
SnapshotInfo.Builder	state(java.lang.String value)	API name: state
SnapshotInfo.Builder	uuid(java.lang.String value)	Required - API name: uuid
SnapshotInfo.Builder	version(java.lang.String value)	API name: version
SnapshotInfo.Builder	versionId(java.lang.Long value)	API name: version_id

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

dataStreams

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

Required - API name: data_streams

Adds all elements of list to dataStreams.

dataStreams

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

Required - API name: data_streams

Adds one or more values to dataStreams.

duration

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

API name: duration

duration

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

API name: duration

durationInMillis

@Nonnull
public final SnapshotInfo.Builder durationInMillis(@Nullable
                                                   java.lang.String value)

API name: duration_in_millis

endTime

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

API name: end_time

endTimeInMillis

@Nonnull
public final SnapshotInfo.Builder endTimeInMillis(@Nullable
                                                  java.lang.String value)

API name: end_time_in_millis

failures

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

API name: failures

Adds all elements of list to failures.

failures

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

API name: failures

Adds one or more values to failures.

failures

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

API name: failures

Adds a value to failures using a builder lambda.

includeGlobalState

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

API name: include_global_state

indices

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

API name: indices

Adds all elements of list to indices.

indices

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

API name: indices

Adds one or more values to indices.

metadata

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

API name: metadata

Adds all elements of map to metadata.

metadata

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

API name: metadata

Adds an entry to metadata.

pinnedTimestamp

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

API name: pinned_timestamp

reason

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

API name: reason

remoteStoreIndexShallowCopy

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

API name: remote_store_index_shallow_copy

shards

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

API name: shards

shards

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

API name: shards

snapshot

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

Required - API name: snapshot

startTime

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

API name: start_time

startTimeInMillis

@Nonnull
public final SnapshotInfo.Builder startTimeInMillis(@Nullable
                                                    java.lang.String value)

API name: start_time_in_millis

state

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

API name: state

uuid

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

Required - API name: uuid

version

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

API name: version

versionId

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

API name: version_id

build

@Nonnull
public SnapshotInfo build()

Builds a SnapshotInfo.

Specified by:

build in interface ObjectBuilder<SnapshotInfo>

Throws:

java.lang.NullPointerException - if some of the required fields are null.