Package org.opensearch.client.opensearch.indices

Class GetFieldMappingRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.GetFieldMappingRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetFieldMappingRequest>

Enclosing class:

GetFieldMappingRequest

public static class GetFieldMappingRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<GetFieldMappingRequest>

Builder for GetFieldMappingRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
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(java.util.List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
GetFieldMappingRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
GetFieldMappingRequest.Builder	fields(java.lang.String value, java.lang.String... values)	Required - A comma-separated list of fields
GetFieldMappingRequest.Builder	fields(java.util.List<java.lang.String> list)	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	index(java.lang.String value, java.lang.String... values)	A comma-separated list of index names
GetFieldMappingRequest.Builder	index(java.util.List<java.lang.String> list)	A comma-separated list of index names
GetFieldMappingRequest.Builder	local(java.lang.Boolean value)	Return local information, do not retrieve the state from cluster-manager node (default: false)

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

allowNoIndices

public final 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 final GetFieldMappingRequest.Builder expandWildcards(java.util.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 GetFieldMappingRequest.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.

fields

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

Required - A comma-separated list of fields

API name: fields

Adds all elements of list to fields.

fields

public final GetFieldMappingRequest.Builder fields(java.lang.String value,
                                                   java.lang.String... values)

Required - A comma-separated list of fields

API name: fields

Adds one or more values to fields.

ignoreUnavailable

public final 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 final GetFieldMappingRequest.Builder includeDefaults(@Nullable
                                                            java.lang.Boolean value)

Whether the default mapping values should be returned as well

API name: include_defaults

index

public final GetFieldMappingRequest.Builder index(java.util.List<java.lang.String> list)

A comma-separated list of index names

API name: index

Adds all elements of list to index.

index

public final GetFieldMappingRequest.Builder index(java.lang.String value,
                                                  java.lang.String... values)

A comma-separated list of index names

API name: index

Adds one or more values to index.

local

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

Return local information, do not retrieve the state from cluster-manager 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.