Package co.elastic.clients.elasticsearch.snapshot

Class Status.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<Status.Builder>

co.elastic.clients.elasticsearch.snapshot.Status.Builder

All Implemented Interfaces:

WithJson<Status.Builder>, ObjectBuilder<Status>

Enclosing class:

Status

public static class Status.Builder
extends WithJsonObjectBuilderBase<Status.Builder>
implements ObjectBuilder<Status>

Builder for Status.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Status	build()	Builds a Status.
final Status.Builder	includeGlobalState(boolean value)	Required - Indicates whether the current cluster state is included in the snapshot.
final Status.Builder	indices(String key, SnapshotIndexStats value)	Required - API name: indices
final Status.Builder	indices(String key, Function<SnapshotIndexStats.Builder,ObjectBuilder<SnapshotIndexStats>> fn)	Required - API name: indices
final Status.Builder	indices(Map<String,SnapshotIndexStats> map)	Required - API name: indices
final Status.Builder	repository(String value)	Required - The name of the repository that includes the snapshot.
protected Status.Builder	self()
final Status.Builder	shardsStats(ShardsStats value)	Required - Statistics for the shards in the snapshot.
final Status.Builder	shardsStats(Function<ShardsStats.Builder,ObjectBuilder<ShardsStats>> fn)	Required - Statistics for the shards in the snapshot.
final Status.Builder	snapshot(String value)	Required - The name of the snapshot.
final Status.Builder	state(String value)	Required - The current snapshot state: FAILED: The snapshot finished with an error and failed to store any data. STARTED: The snapshot is currently running. SUCCESS: The snapshot completed.
final Status.Builder	stats(SnapshotStats value)	Required - Details about the number (file_count) and size (size_in_bytes) of files included in the snapshot.
final Status.Builder	stats(Function<SnapshotStats.Builder,ObjectBuilder<SnapshotStats>> fn)	Required - Details about the number (file_count) and size (size_in_bytes) of files included in the snapshot.
final Status.Builder	uuid(String value)	Required - The universally unique identifier (UUID) for the snapshot.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

includeGlobalState

public final Status.Builder includeGlobalState(boolean value)

Required - Indicates whether the current cluster state is included in the snapshot.

API name: include_global_state

indices

public final Status.Builder indices(Map<String,SnapshotIndexStats> map)

Required - API name: indices

Adds all entries of map to indices.

indices

public final Status.Builder indices(String key,
 SnapshotIndexStats value)

Required - API name: indices

Adds an entry to indices.

indices

public final Status.Builder indices(String key,
 Function<SnapshotIndexStats.Builder,ObjectBuilder<SnapshotIndexStats>> fn)

Required - API name: indices

Adds an entry to indices using a builder lambda.

repository

public final Status.Builder repository(String value)

Required - The name of the repository that includes the snapshot.

API name: repository

shardsStats

public final Status.Builder shardsStats(ShardsStats value)

Required - Statistics for the shards in the snapshot.

API name: shards_stats

shardsStats

public final Status.Builder shardsStats(Function<ShardsStats.Builder,ObjectBuilder<ShardsStats>> fn)

Required - Statistics for the shards in the snapshot.

API name: shards_stats

snapshot

public final Status.Builder snapshot(String value)

Required - The name of the snapshot.

API name: snapshot

state

public final Status.Builder state(String value)

Required - The current snapshot state:

• FAILED: The snapshot finished with an error and failed to store any data.
• STARTED: The snapshot is currently running.
• SUCCESS: The snapshot completed.

API name: state

stats

public final Status.Builder stats(SnapshotStats value)

Required - Details about the number (file_count) and size (size_in_bytes) of files included in the snapshot.

API name: stats

stats

public final Status.Builder stats(Function<SnapshotStats.Builder,ObjectBuilder<SnapshotStats>> fn)

Required - Details about the number (file_count) and size (size_in_bytes) of files included in the snapshot.

API name: stats

uuid

public final Status.Builder uuid(String value)

Required - The universally unique identifier (UUID) for the snapshot.

API name: uuid

self

protected Status.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<Status.Builder>

build

public Status build()

Builds a Status.

Specified by:

build in interface ObjectBuilder<Status>

Throws:

NullPointerException - if some of the required fields are null.