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

Class ShardCommit

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<ShardCommit.Builder,ShardCommit>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class ShardCommit
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<ShardCommit.Builder,ShardCommit>

The commit information for a shard.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShardCommit.Builder	Builder for ShardCommit.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ShardCommit>	_DESERIALIZER	Json deserializer for ShardCommit

Method Summary

Modifier and Type	Method	Description
static ShardCommit.Builder	builder()
boolean	equals(Object o)
final int	generation()	Required - The generation number of the commit.
int	hashCode()
final String	id()	Required - API name: id
final long	numDocs()	Required - The number of documents in the commit.
static ShardCommit	of(Function<ShardCommit.Builder,ObjectBuilder<ShardCommit>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupShardCommitDeserializer(ObjectDeserializer<ShardCommit.Builder> op)
ShardCommit.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Map<String,String>	userData()	Required - The user-defined data associated with the commit.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ShardCommit> _DESERIALIZER

Json deserializer for ShardCommit

Method Details

of

public static ShardCommit of(Function<ShardCommit.Builder,ObjectBuilder<ShardCommit>> fn)

generation

public final int generation()

Required - The generation number of the commit.

API name: generation

id

@Nonnull
public final String id()

Required - API name: id

numDocs

public final long numDocs()

Required - The number of documents in the commit.

API name: num_docs

userData

@Nonnull
public final Map<String,String> userData()

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

API name: user_data

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public ShardCommit.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ShardCommit.Builder,ShardCommit>

Returns:

a new builder instance.

builder

@Nonnull
public static ShardCommit.Builder builder()

setupShardCommitDeserializer

protected static void setupShardCommitDeserializer(ObjectDeserializer<ShardCommit.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object