Package co.elastic.clients.elasticsearch.indices

Class GetFieldMappingRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.GetFieldMappingRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class GetFieldMappingRequest
extends RequestBase

Nested Class Summary

Nested Classes

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

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 Endpoint<GetFieldMappingRequest,GetFieldMappingResponse,ElasticsearchError>	ENDPOINT	Endpoint "indices.get_field_mapping".

Constructor Summary

Constructors

Constructor	Description
GetFieldMappingRequest(GetFieldMappingRequest.Builder builder)
GetFieldMappingRequest(java.util.function.Function<GetFieldMappingRequest.Builder,GetFieldMappingRequest.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 fields
java.lang.Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
java.lang.Boolean	includeDefaults()	Whether the default mapping values should be returned as well
java.lang.Boolean	includeTypeName()	Whether a type should be returned in the body of the mappings.
java.util.List<java.lang.String>	index()	A comma-separated list of index names
java.lang.Boolean	local()	Return local information, do not retrieve the state from master node (default: false)
java.util.List<java.lang.String>	type()	A comma-separated list of document types

Methods inherited from class java.lang.Object

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

Field Details

ENDPOINT

public static final Endpoint<GetFieldMappingRequest,GetFieldMappingResponse,ElasticsearchError> ENDPOINT

Endpoint "indices.get_field_mapping".

Constructor Details

GetFieldMappingRequest

public GetFieldMappingRequest(GetFieldMappingRequest.Builder builder)

GetFieldMappingRequest

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

Method Details

fields

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

A comma-separated list of fields

API name: fields

index

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

A comma-separated list of index names

API name: index

type

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

A comma-separated list of document types

API name: type

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

ignoreUnavailable

@Nullable
public java.lang.Boolean ignoreUnavailable()

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

API name: ignore_unavailable

includeDefaults

@Nullable
public java.lang.Boolean includeDefaults()

Whether the default mapping values should be returned as well

API name: include_defaults

includeTypeName

@Nullable
public java.lang.Boolean includeTypeName()

Whether a type should be returned in the body of the mappings.

API name: include_type_name

local

@Nullable
public java.lang.Boolean local()

Return local information, do not retrieve the state from master node (default: false)

API name: local