Package co.elastic.clients.elasticsearch.indices

Class GetMappingRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetMappingRequest.Builder>

co.elastic.clients.elasticsearch.indices.GetMappingRequest.Builder

All Implemented Interfaces:

WithJson<GetMappingRequest.Builder>, ObjectBuilder<GetMappingRequest>

Enclosing class:

GetMappingRequest

public static class GetMappingRequest.Builder
extends RequestBase.AbstractBuilder<GetMappingRequest.Builder>
implements ObjectBuilder<GetMappingRequest>

Builder for GetMappingRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GetMappingRequest.Builder	allowNoIndices(Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
GetMappingRequest	build()	Builds a GetMappingRequest.
final GetMappingRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final GetMappingRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
final GetMappingRequest.Builder	ignoreUnavailable(Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
final GetMappingRequest.Builder	index(String value, String... values)	A comma-separated list of index names
final GetMappingRequest.Builder	index(List<String> list)	A comma-separated list of index names
final GetMappingRequest.Builder	local(Boolean value)	Return local information, do not retrieve the state from master node (default: false)
final GetMappingRequest.Builder	masterTimeout(Time value)	Specify timeout for connection to master
final GetMappingRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to master
protected GetMappingRequest.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoIndices

public final GetMappingRequest.Builder allowNoIndices(@Nullable
 Boolean value)

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 GetMappingRequest.Builder expandWildcards(List<ExpandWildcard> list)

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

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

public final GetMappingRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

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

API name: expand_wildcards

Adds one or more values to expandWildcards.

ignoreUnavailable

public final GetMappingRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

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

API name: ignore_unavailable

index

public final GetMappingRequest.Builder index(List<String> list)

A comma-separated list of index names

API name: index

Adds all elements of list to index.

index

public final GetMappingRequest.Builder index(String value,
 String... values)

A comma-separated list of index names

API name: index

Adds one or more values to index.

local

public final GetMappingRequest.Builder local(@Nullable
 Boolean value)

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

API name: local

masterTimeout

public final GetMappingRequest.Builder masterTimeout(@Nullable
 Time value)

Specify timeout for connection to master

API name: master_timeout

masterTimeout

public final GetMappingRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify timeout for connection to master

API name: master_timeout

self

protected GetMappingRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetMappingRequest.Builder>

build

public GetMappingRequest build()

Builds a GetMappingRequest.

Specified by:

build in interface ObjectBuilder<GetMappingRequest>

Throws:

NullPointerException - if some of the required fields are null.