Package org.opensearch.client.opensearch.indices.recovery

Class FileDetails

java.lang.Object

org.opensearch.client.opensearch.indices.recovery.FileDetails

All Implemented Interfaces:

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

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

The details of a recovered file.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static FileDetails.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final long	length()	Required - The length of the file in bytes.
final String	name()	Required - The name of the file.
static FileDetails	of(Function<FileDetails.Builder,ObjectBuilder<FileDetails>> fn)
final long	recovered()	Required - The number of bytes recovered.
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	setupFileDetailsDeserializer(ObjectDeserializer<FileDetails.Builder> op)
FileDetails.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<FileDetails> _DESERIALIZER

Json deserializer for FileDetails

Method Details

of

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

length

public final long length()

Required - The length of the file in bytes.

API name: length

name

@Nonnull
public final String name()

Required - The name of the file.

API name: name

recovered

public final long recovered()

Required - The number of bytes recovered.

API name: recovered

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

Returns:

a new builder instance.

builder

@Nonnull
public static FileDetails.Builder builder()

setupFileDetailsDeserializer

protected static void setupFileDetailsDeserializer(ObjectDeserializer<FileDetails.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object