Package org.opensearch.client.opensearch.indices

Class GetMappingRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.GetMappingRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetMappingRequest>

Enclosing class:

GetMappingRequest

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

Builder for GetMappingRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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 GetMappingRequest.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 GetMappingRequest.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 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
                                                         java.lang.Boolean value)

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

API name: ignore_unavailable

index

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

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

API name: local

masterTimeout

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

Deprecated.

Specify timeout for connection to master

API name: master_timeout

masterTimeout

@Deprecated
public final GetMappingRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

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

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

clusterManagerTimeout

public final GetMappingRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

build

public GetMappingRequest build()

Builds a GetMappingRequest.

Specified by:

build in interface ObjectBuilder<GetMappingRequest>

Throws:

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