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

@JsonpDeserializable
public class FieldCapability
extends java.lang.Object
implements JsonpSerializable

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 JsonpDeserializer<FieldCapability>	_DESERIALIZER	Json deserializer for FieldCapability

Method Summary

Modifier and Type	Method	Description
boolean	aggregatable()	Required - API name: aggregatable
java.util.List<java.lang.String>	indices()	API name: indices
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	meta()	API name: meta
java.lang.Boolean	metadataField()	API name: metadata_field
java.util.List<java.lang.String>	nonAggregatableIndices()	API name: non_aggregatable_indices
java.util.List<java.lang.String>	nonSearchableIndices()	API name: non_searchable_indices
static FieldCapability	of(java.util.function.Function<FieldCapability.Builder,ObjectBuilder<FieldCapability>> fn)
boolean	searchable()	Required - API name: searchable
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)
java.lang.String	type()	Required - API name: type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<FieldCapability> _DESERIALIZER

Json deserializer for FieldCapability

Method Detail

of

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

aggregatable

public final boolean aggregatable()

Required - API name: aggregatable

indices

public final java.util.List<java.lang.String> indices()

API name: indices

meta

public final java.util.Map<java.lang.String,java.util.List<java.lang.String>> meta()

API name: meta

nonAggregatableIndices

public final java.util.List<java.lang.String> nonAggregatableIndices()

API name: non_aggregatable_indices

nonSearchableIndices

public final java.util.List<java.lang.String> nonSearchableIndices()

API name: non_searchable_indices

searchable

public final boolean searchable()

Required - API name: searchable

type

public final java.lang.String type()

Required - API name: type

metadataField

@Nullable
public final java.lang.Boolean metadataField()

API name: metadata_field

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)

setupFieldCapabilityDeserializer

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