Package org.opensearch.client.opensearch.indices.stats

Class ShardCommit.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.stats.ShardCommit.Builder

All Implemented Interfaces:

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

Enclosing class:

ShardCommit

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

Builder for ShardCommit.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShardCommit	build()	Builds a ShardCommit.
ShardCommit.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShardCommit.Builder	generation(int value)	Required - The generation number of the commit.
final ShardCommit.Builder	id(String value)	Required - API name: id
final ShardCommit.Builder	numDocs(long value)	Required - The number of documents in the commit.
final ShardCommit.Builder	userData(String key, String value)	Required - The user-defined data associated with the commit.
final ShardCommit.Builder	userData(Map<String,String> map)	Required - The user-defined data associated with the commit.

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

Returns:

a new builder instance.

generation

@Nonnull
public final ShardCommit.Builder generation(int value)

Required - The generation number of the commit.

API name: generation

id

@Nonnull
public final ShardCommit.Builder id(String value)

Required - API name: id

numDocs

@Nonnull
public final ShardCommit.Builder numDocs(long value)

Required - The number of documents in the commit.

API name: num_docs

userData

@Nonnull
public final ShardCommit.Builder userData(Map<String,String> map)

Required - The user-defined data associated with the commit.

API name: user_data

Adds all elements of map to userData.

userData

@Nonnull
public final ShardCommit.Builder userData(String key,
 String value)

Required - The user-defined data associated with the commit.

API name: user_data

Adds an entry to userData.

build

@Nonnull
public ShardCommit build()

Builds a ShardCommit.

Specified by:

build in interface ObjectBuilder<ShardCommit>

Throws:

NullPointerException - if some of the required fields are null.