Package org.opensearch.client.opensearch.indices.close

Class CloseIndexResult

java.lang.Object

org.opensearch.client.opensearch.indices.close.CloseIndexResult

All Implemented Interfaces:

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

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

The result of a close index operation.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static CloseIndexResult.Builder	builder()
final boolean	closed()	Required - Whether the index was successfully closed.
boolean	equals(Object o)
int	hashCode()
static CloseIndexResult	of(Function<CloseIndexResult.Builder,ObjectBuilder<CloseIndexResult>> 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	setupCloseIndexResultDeserializer(ObjectDeserializer<CloseIndexResult.Builder> op)
final Map<String,CloseShardResult>	shards()	The status of individual shards during the close operation.
CloseIndexResult.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<CloseIndexResult> _DESERIALIZER

Json deserializer for CloseIndexResult

Method Details

of

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

closed

public final boolean closed()

Required - Whether the index was successfully closed.

API name: closed

shards

@Nonnull
public final Map<String,CloseShardResult> shards()

The status of individual shards during the close operation.

API name: shards

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

Returns:

a new builder instance.

builder

@Nonnull
public static CloseIndexResult.Builder builder()

setupCloseIndexResultDeserializer

protected static void setupCloseIndexResultDeserializer(ObjectDeserializer<CloseIndexResult.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object