Package org.opensearch.client.opensearch.indices.resolve_index

Class ResolveIndexItem

java.lang.Object

org.opensearch.client.opensearch.indices.resolve_index.ResolveIndexItem

All Implemented Interfaces:

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

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

The resolved information for an index.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final List<String>	aliases()	The list of aliases associated with the index.
final List<String>	attributes()	Required - The list of index attributes.
static ResolveIndexItem.Builder	builder()
final String	dataStream()	API name: data_stream
boolean	equals(Object o)
int	hashCode()
final String	name()	Required - API name: name
static ResolveIndexItem	of(Function<ResolveIndexItem.Builder,ObjectBuilder<ResolveIndexItem>> 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	setupResolveIndexItemDeserializer(ObjectDeserializer<ResolveIndexItem.Builder> op)
ResolveIndexItem.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<ResolveIndexItem> _DESERIALIZER

Json deserializer for ResolveIndexItem

Method Details

of

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

aliases

@Nonnull
public final List<String> aliases()

The list of aliases associated with the index.

API name: aliases

attributes

@Nonnull
public final List<String> attributes()

Required - The list of index attributes.

API name: attributes

dataStream

@Nullable
public final String dataStream()

API name: data_stream

name

@Nonnull
public final String name()

Required - API name: name

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

Returns:

a new builder instance.

builder

@Nonnull
public static ResolveIndexItem.Builder builder()

setupResolveIndexItemDeserializer

protected static void setupResolveIndexItemDeserializer(ObjectDeserializer<ResolveIndexItem.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object