Package org.opensearch.client.opensearch.core.field_caps

Class FieldCapability

java.lang.Object

org.opensearch.client.opensearch.core.field_caps.FieldCapability

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final boolean	aggregatable()	Required - Whether this field can be aggregated on all indexes.
static FieldCapability.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final List<String>	indices()	API name: indices
final Map<String,List<String>>	meta()	API name: meta
final Boolean	metadataField()	Whether this field is registered as a metadata field.
final List<String>	nonAggregatableIndices()	API name: non_aggregatable_indices
final List<String>	nonSearchableIndices()	API name: non_searchable_indices
static FieldCapability	of(Function<FieldCapability.Builder,ObjectBuilder<FieldCapability>> fn)
final boolean	searchable()	Required - Whether this field is indexed for search on all indexes.
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	setupFieldCapabilityDeserializer(ObjectDeserializer<FieldCapability.Builder> op)
FieldCapability.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	type()	Required - API name: type

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

Json deserializer for FieldCapability

Method Details

of

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

aggregatable

public final boolean aggregatable()

Required - Whether this field can be aggregated on all indexes.

API name: aggregatable

indices

@Nonnull
public final List<String> indices()

API name: indices

meta

@Nonnull
public final Map<String,List<String>> meta()

API name: meta

metadataField

@Nullable
public final Boolean metadataField()

Whether this field is registered as a metadata field.

API name: metadata_field

nonAggregatableIndices

@Nonnull
public final List<String> nonAggregatableIndices()

API name: non_aggregatable_indices

nonSearchableIndices

@Nonnull
public final List<String> nonSearchableIndices()

API name: non_searchable_indices

searchable

public final boolean searchable()

Required - Whether this field is indexed for search on all indexes.

API name: searchable

type

@Nonnull
public final String type()

Required - API name: type

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

Returns:

a new builder instance.

builder

@Nonnull
public static FieldCapability.Builder builder()

setupFieldCapabilityDeserializer

protected static void setupFieldCapabilityDeserializer(ObjectDeserializer<FieldCapability.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object