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 -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<FieldCapability> Json deserializer forFieldCapability -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanRequired - Whether this field can be aggregated on all indexes.static FieldCapability.Builderbuilder()booleaninthashCode()indices()API name:indicesmeta()API name:metafinal BooleanWhether this field is registered as a metadata field.API name:non_aggregatable_indicesAPI name:non_searchable_indicesstatic FieldCapabilityfinal booleanRequired - Whether this field is indexed for search on all indexes.voidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.final Stringtype()Required - API name:typeMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forFieldCapability
-
-
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
API name:indices -
meta
API name:meta -
metadataField
Whether this field is registered as a metadata field.API name:
metadata_field -
nonAggregatableIndices
API name:non_aggregatable_indices -
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
Required - API name:type -
serialize
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<FieldCapability.Builder,FieldCapability> - Returns:
- a new builder instance.
-
builder
-
setupFieldCapabilityDeserializer
protected static void setupFieldCapabilityDeserializer(ObjectDeserializer<FieldCapability.Builder> op) -
hashCode
public int hashCode() -
equals
-