Package co.elastic.clients.elasticsearch._core

Class FieldCapsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch._core.FieldCapsRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class FieldCapsRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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,ElasticsearchError>	ENDPOINT	Endpoint "field_caps".

Constructor Summary

Constructors

Constructor	Description
FieldCapsRequest(FieldCapsRequest.Builder builder)
FieldCapsRequest(java.util.function.Function<FieldCapsRequest.Builder,FieldCapsRequest.Builder> fn)

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<ExpandWildcardOptions>	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
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(DelegatingDeserializer<FieldCapsRequest.Builder> op)

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<FieldCapsRequest> _DESERIALIZER

Json deserializer for FieldCapsRequest

ENDPOINT

public static final Endpoint<FieldCapsRequest,FieldCapsResponse,ElasticsearchError> ENDPOINT

Endpoint "field_caps".

Constructor Details

FieldCapsRequest

public FieldCapsRequest(FieldCapsRequest.Builder builder)

FieldCapsRequest

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

Method Details

index

@Nullable
public 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

allowNoIndices

@Nullable
public 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

@Nullable
public java.util.List<ExpandWildcardOptions> expandWildcards()

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

API name: expand_wildcards

fields

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

A comma-separated list of field names

API name: fields

ignoreUnavailable

@Nullable
public java.lang.Boolean ignoreUnavailable()

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

API name: ignore_unavailable

includeUnmapped

@Nullable
public java.lang.Boolean includeUnmapped()

Indicates whether unmapped fields should be included in the response.

API name: include_unmapped

indexFilter

@Nullable
public Query indexFilter()

API name: index_filter

runtimeMappings

@Nullable
public 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(DelegatingDeserializer<FieldCapsRequest.Builder> op)