Package co.elastic.clients.elasticsearch.snapshot

Class ShardsStats.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.snapshot.ShardsStats.Builder

All Implemented Interfaces:

WithJson<ShardsStats.Builder>, ObjectBuilder<ShardsStats>

Enclosing class:

ShardsStats

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

Builder for ShardsStats.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardsStats	build()	Builds a ShardsStats.
final ShardsStats.Builder	done(long value)	Required - The number of shards that initialized, started, and finalized successfully.
final ShardsStats.Builder	failed(long value)	Required - The number of shards that failed to be included in the snapshot.
final ShardsStats.Builder	finalizing(long value)	Required - The number of shards that are finalizing but are not done.
final ShardsStats.Builder	initializing(long value)	Required - The number of shards that are still initializing.
protected ShardsStats.Builder	self()
final ShardsStats.Builder	started(long value)	Required - The number of shards that have started but are not finalized.
final ShardsStats.Builder	total(long value)	Required - The total number of shards included in 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

done

public final ShardsStats.Builder done(long value)

Required - The number of shards that initialized, started, and finalized successfully.

API name: done

failed

public final ShardsStats.Builder failed(long value)

Required - The number of shards that failed to be included in the snapshot.

API name: failed

finalizing

public final ShardsStats.Builder finalizing(long value)

Required - The number of shards that are finalizing but are not done.

API name: finalizing

initializing

public final ShardsStats.Builder initializing(long value)

Required - The number of shards that are still initializing.

API name: initializing

started

public final ShardsStats.Builder started(long value)

Required - The number of shards that have started but are not finalized.

API name: started

total

public final ShardsStats.Builder total(long value)

Required - The total number of shards included in the snapshot.

API name: total

self

protected ShardsStats.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<ShardsStats.Builder>

build

public ShardsStats build()

Builds a ShardsStats.

Specified by:

build in interface ObjectBuilder<ShardsStats>

Throws:

NullPointerException - if some of the required fields are null.