Package org.opensearch.client.opensearch._global

Class FieldCapsRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch._global.FieldCapsRequest

All Implemented Interfaces:

ToJsonp

public final class FieldCapsRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<FieldCapsRequest>	DESERIALIZER	Json deserializer for FieldCapsRequest
static Endpoint<FieldCapsRequest,FieldCapsResponse,OpenSearchError>	ENDPOINT	Endpoint "field_caps".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FieldCapsRequest(FieldCapsRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	API name: allow_no_indices
jakarta.json.JsonValue	expandWildcards()	API name: expand_wildcards
java.util.List<java.lang.String>	fields()	API name: fields
java.lang.Boolean	ignoreUnavailable()	API name: ignore_unavailable
java.lang.Boolean	includeUnmapped()	API name: include_unmapped
java.util.List<java.lang.String>	index()	API name: index
FieldCapabilitiesBodyIndexFilter	indexFilter()	API name: index_filter
protected static void	setupFieldCapsRequestDeserializer(DelegatingDeserializer<FieldCapsRequest.Builder> op)
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

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,OpenSearchError> ENDPOINT

Endpoint "field_caps".

Constructor Details

FieldCapsRequest

protected FieldCapsRequest(FieldCapsRequest.Builder builder)

Method Details

index

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

API name: index

allowNoIndices

@Nullable public java.lang.Boolean allowNoIndices()

API name: allow_no_indices

expandWildcards

@Nullable public jakarta.json.JsonValue expandWildcards()

API name: expand_wildcards

fields

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

API name: fields

ignoreUnavailable

@Nullable public java.lang.Boolean ignoreUnavailable()

API name: ignore_unavailable

includeUnmapped

@Nullable public java.lang.Boolean includeUnmapped()

API name: include_unmapped

indexFilter

@Nullable public FieldCapabilitiesBodyIndexFilter indexFilter()

API name: index_filter

toJsonp

public void toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

protected void toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

setupFieldCapsRequestDeserializer

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