Package org.opensearch.client.opensearch._types

Class ShardSearchFailure

java.lang.Object

org.opensearch.client.opensearch._types.ShardSearchFailure

All Implemented Interfaces:

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

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

Represents a failure to search on a specific shard. Used in search responses.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ShardSearchFailure.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	index()	The index name where the failure occurred.
final String	node()	The node id where the failure occurred.
static ShardSearchFailure	of(Function<ShardSearchFailure.Builder,ObjectBuilder<ShardSearchFailure>> fn)
final ErrorCause	reason()	Required - API name: reason
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	setupShardSearchFailureDeserializer(ObjectDeserializer<ShardSearchFailure.Builder> op)
final int	shard()	Required - The shard id where the failure occurred.
ShardSearchFailure.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<ShardSearchFailure> _DESERIALIZER

Json deserializer for ShardSearchFailure

Method Details

of

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

index

@Nullable
public final String index()

The index name where the failure occurred.

API name: index

node

@Nullable
public final String node()

The node id where the failure occurred.

API name: node

reason

@Nonnull
public final ErrorCause reason()

Required - API name: reason

shard

public final int shard()

Required - The shard id where the failure occurred.

API name: shard

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

Returns:

a new builder instance.

builder

@Nonnull
public static ShardSearchFailure.Builder builder()

setupShardSearchFailureDeserializer

protected static void setupShardSearchFailureDeserializer(ObjectDeserializer<ShardSearchFailure.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object