Package co.elastic.clients.elasticsearch.indices

Class GetMappingRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.GetMappingRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class GetMappingRequest
extends RequestBase

Nested Class Summary

Nested Classes

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

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<GetMappingRequest,GetMappingResponse,ElasticsearchError>	ENDPOINT	Endpoint "indices.get_mapping".

Constructor Summary

Constructors

Constructor	Description
GetMappingRequest(GetMappingRequest.Builder builder)
GetMappingRequest(java.util.function.Function<GetMappingRequest.Builder,GetMappingRequest.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.lang.Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
java.lang.Boolean	includeTypeName()	Whether to add the type name to the response (default: false)
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.lang.String	masterTimeout()	Specify timeout for connection to master
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<GetMappingRequest,GetMappingResponse,ElasticsearchError> ENDPOINT

Endpoint "indices.get_mapping".

Constructor Details

GetMappingRequest

public GetMappingRequest(GetMappingRequest.Builder builder)

GetMappingRequest

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

Method Details

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

includeTypeName

@Nullable
public java.lang.Boolean includeTypeName()

Whether to add the type name to the response (default: false)

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

masterTimeout

@Nullable
public java.lang.String masterTimeout()

Specify timeout for connection to master

API name: master_timeout