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

Class ShardFileSizeInfo

java.lang.Object

org.opensearch.client.opensearch.indices.stats.ShardFileSizeInfo

All Implemented Interfaces:

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

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

The size information for shard files.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Long	averageSizeInBytes()	API name: average_size_in_bytes
static ShardFileSizeInfo.Builder	builder()
final Long	count()	The number of files.
final String	description()	Required - The description of the file type.
boolean	equals(Object o)
int	hashCode()
final Long	maxSizeInBytes()	API name: max_size_in_bytes
final Long	minSizeInBytes()	API name: min_size_in_bytes
static ShardFileSizeInfo	of(Function<ShardFileSizeInfo.Builder,ObjectBuilder<ShardFileSizeInfo>> 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	setupShardFileSizeInfoDeserializer(ObjectDeserializer<ShardFileSizeInfo.Builder> op)
final String	size()	API name: size
final long	sizeInBytes()	Required - API name: size_in_bytes
ShardFileSizeInfo.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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<ShardFileSizeInfo> _DESERIALIZER

Json deserializer for ShardFileSizeInfo

Method Details

of

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

averageSizeInBytes

@Nullable
public final Long averageSizeInBytes()

API name: average_size_in_bytes

count

@Nullable
public final Long count()

The number of files.

API name: count

description

@Nonnull
public final String description()

Required - The description of the file type.

API name: description

maxSizeInBytes

@Nullable
public final Long maxSizeInBytes()

API name: max_size_in_bytes

minSizeInBytes

@Nullable
public final Long minSizeInBytes()

API name: min_size_in_bytes

size

@Nullable
public final String size()

API name: size

sizeInBytes

public final long sizeInBytes()

Required - API name: size_in_bytes

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

Returns:

a new builder instance.

builder

@Nonnull
public static ShardFileSizeInfo.Builder builder()

setupShardFileSizeInfoDeserializer

protected static void setupShardFileSizeInfoDeserializer(ObjectDeserializer<ShardFileSizeInfo.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object