Package co.elastic.clients.elasticsearch.indices

Class GetFieldMappingRequest.Builder

java.lang.Object

co.elastic.clients.elasticsearch.indices.GetFieldMappingRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetFieldMappingRequest>

Enclosing class:

GetFieldMappingRequest

public static class GetFieldMappingRequest.Builder
extends java.lang.Object
implements ObjectBuilder<GetFieldMappingRequest>

Builder for GetFieldMappingRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetFieldMappingRequest.Builder	addExpandWildcards(ExpandWildcardOptions value)	Add a value to expandWildcards(List), creating the list if needed.
GetFieldMappingRequest.Builder	addFields(java.lang.String value)	Add a value to fields(List), creating the list if needed.
GetFieldMappingRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
GetFieldMappingRequest.Builder	addType(java.lang.String value)	Add a value to type(List), creating the list if needed.
GetFieldMappingRequest.Builder	allowNoIndices(java.lang.Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
GetFieldMappingRequest	build()	Builds a GetFieldMappingRequest.
GetFieldMappingRequest.Builder	expandWildcards(ExpandWildcardOptions... value)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
GetFieldMappingRequest.Builder	expandWildcards(java.util.List<ExpandWildcardOptions> value)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
GetFieldMappingRequest.Builder	fields(java.lang.String... value)	Required - A comma-separated list of fields
GetFieldMappingRequest.Builder	fields(java.util.List<java.lang.String> value)	Required - A comma-separated list of fields
GetFieldMappingRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
GetFieldMappingRequest.Builder	includeDefaults(java.lang.Boolean value)	Whether the default mapping values should be returned as well
GetFieldMappingRequest.Builder	includeTypeName(java.lang.Boolean value)	Whether a type should be returned in the body of the mappings.
GetFieldMappingRequest.Builder	index(java.lang.String... value)	A comma-separated list of index names
GetFieldMappingRequest.Builder	index(java.util.List<java.lang.String> value)	A comma-separated list of index names
GetFieldMappingRequest.Builder	local(java.lang.Boolean value)	Return local information, do not retrieve the state from master node (default: false)
GetFieldMappingRequest.Builder	type(java.lang.String... value)	A comma-separated list of document types
GetFieldMappingRequest.Builder	type(java.util.List<java.lang.String> value)	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

Constructor Details

Builder

public Builder()

Method Details

fields

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

Required - A comma-separated list of fields

API name: fields

fields

public GetFieldMappingRequest.Builder fields(java.lang.String... value)

Required - A comma-separated list of fields

API name: fields

addFields

public GetFieldMappingRequest.Builder addFields(java.lang.String value)

Add a value to fields(List), creating the list if needed.

index

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

A comma-separated list of index names

API name: index

index

public GetFieldMappingRequest.Builder index(java.lang.String... value)

A comma-separated list of index names

API name: index

addIndex

public GetFieldMappingRequest.Builder addIndex(java.lang.String value)

Add a value to index(List), creating the list if needed.

type

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

A comma-separated list of document types

API name: type

type

public GetFieldMappingRequest.Builder type(java.lang.String... value)

A comma-separated list of document types

API name: type

addType

public GetFieldMappingRequest.Builder addType(java.lang.String value)

Add a value to type(List), creating the list if needed.

allowNoIndices

public GetFieldMappingRequest.Builder allowNoIndices(@Nullable
java.lang.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 GetFieldMappingRequest.Builder expandWildcards(@Nullable
java.util.List<ExpandWildcardOptions> value)

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

API name: expand_wildcards

expandWildcards

public GetFieldMappingRequest.Builder expandWildcards(ExpandWildcardOptions... value)

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

API name: expand_wildcards

addExpandWildcards

public GetFieldMappingRequest.Builder addExpandWildcards(ExpandWildcardOptions value)

Add a value to expandWildcards(List), creating the list if needed.

ignoreUnavailable

public GetFieldMappingRequest.Builder ignoreUnavailable(@Nullable
java.lang.Boolean value)

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

API name: ignore_unavailable

includeDefaults

public GetFieldMappingRequest.Builder includeDefaults(@Nullable
java.lang.Boolean value)

Whether the default mapping values should be returned as well

API name: include_defaults

includeTypeName

public GetFieldMappingRequest.Builder includeTypeName(@Nullable
java.lang.Boolean value)

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

API name: include_type_name

local

public GetFieldMappingRequest.Builder local(@Nullable
java.lang.Boolean value)

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

API name: local

build

public GetFieldMappingRequest build()

Builds a GetFieldMappingRequest.

Specified by:

build in interface ObjectBuilder<GetFieldMappingRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.