Package org.opensearch.client.opensearch.indices

Class GetMappingRequest.Builder

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<GetMappingRequest>

Enclosing class:

GetMappingRequest

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

Builder for GetMappingRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetMappingRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
GetMappingRequest.Builder	addType(java.lang.String value)	Add a value to type(List), creating the list if needed.
GetMappingRequest.Builder	allowNoIndices(java.lang.Boolean value)	API name: allow_no_indices
GetMappingRequest	build()	Builds a GetMappingRequest.
GetMappingRequest.Builder	expandWildcards(jakarta.json.JsonValue value)	API name: expand_wildcards
GetMappingRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
GetMappingRequest.Builder	includeTypeName(java.lang.Boolean value)	API name: include_type_name
GetMappingRequest.Builder	index(java.lang.String... value)	API name: index
GetMappingRequest.Builder	index(java.util.List<java.lang.String> value)	API name: index
GetMappingRequest.Builder	local(java.lang.Boolean value)	API name: local
GetMappingRequest.Builder	masterTimeout(jakarta.json.JsonValue value)	API name: master_timeout
GetMappingRequest.Builder	type(java.lang.String... value)	API name: type
GetMappingRequest.Builder	type(java.util.List<java.lang.String> value)	API name: type

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

index

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

API name: index

index

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

API name: index

addIndex

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

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

type

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

API name: type

type

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

API name: type

addType

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

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

allowNoIndices

public GetMappingRequest.Builder allowNoIndices(@Nullable java.lang.Boolean value)

API name: allow_no_indices

expandWildcards

public GetMappingRequest.Builder expandWildcards(@Nullable jakarta.json.JsonValue value)

API name: expand_wildcards

ignoreUnavailable

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

API name: ignore_unavailable

includeTypeName

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

API name: include_type_name

local

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

API name: local

masterTimeout

public GetMappingRequest.Builder masterTimeout(@Nullable jakarta.json.JsonValue value)

API name: master_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.