Package org.opensearch.client.opensearch.core

Class FieldCapsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.FieldCapsRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class FieldCapsRequest
extends RequestBase
implements JsonpSerializable

Returns the information about the capabilities of fields among multiple indices.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<FieldCapsRequest>	_DESERIALIZER	Json deserializer for FieldCapsRequest
static Endpoint<FieldCapsRequest,FieldCapsResponse,ErrorResponse>	_ENDPOINT	Endpoint "field_caps".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
java.util.List<ExpandWildcard>	expandWildcards()	Whether to expand wildcard expression to concrete indices that are open, closed or both.
java.util.List<java.lang.String>	fields()	A comma-separated list of field names
java.lang.Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
java.lang.Boolean	includeUnmapped()	Indicates whether unmapped fields should be included in the response.
java.util.List<java.lang.String>	index()	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
Query	indexFilter()	API name: index_filter
static FieldCapsRequest	of(java.util.function.Function<FieldCapsRequest.Builder,ObjectBuilder<FieldCapsRequest>> fn)
java.util.Map<java.lang.String,RuntimeField>	runtimeMappings()	API name: runtime_mappings
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	setupFieldCapsRequestDeserializer(ObjectDeserializer<FieldCapsRequest.Builder> op)

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

Json deserializer for FieldCapsRequest

_ENDPOINT

public static final Endpoint<FieldCapsRequest,FieldCapsResponse,ErrorResponse> _ENDPOINT

Endpoint "field_caps".

Method Detail

of

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

allowNoIndices

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

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

API name: allow_no_indices

expandWildcards

public final java.util.List<ExpandWildcard> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

fields

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

A comma-separated list of field names

API name: fields

ignoreUnavailable

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

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

includeUnmapped

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

Indicates whether unmapped fields should be included in the response.

API name: include_unmapped

index

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

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

indexFilter

@Nullable
public final Query indexFilter()

API name: index_filter

runtimeMappings

public final java.util.Map<java.lang.String,RuntimeField> runtimeMappings()

API name: runtime_mappings

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)

setupFieldCapsRequestDeserializer

protected static void setupFieldCapsRequestDeserializer(ObjectDeserializer<FieldCapsRequest.Builder> op)