Package org.opensearch.client.opensearch.indices

Class GetFieldMappingRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.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.

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
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)	API name: allow_no_indices
GetFieldMappingRequest	build()	Builds a GetFieldMappingRequest.
GetFieldMappingRequest.Builder	expandWildcards(jakarta.json.JsonValue value)	API name: expand_wildcards
GetFieldMappingRequest.Builder	fields(java.lang.String... value)	API name: fields
GetFieldMappingRequest.Builder	fields(java.util.List<java.lang.String> value)	API name: fields
GetFieldMappingRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
GetFieldMappingRequest.Builder	includeDefaults(java.lang.Boolean value)	API name: include_defaults
GetFieldMappingRequest.Builder	includeTypeName(java.lang.Boolean value)	API name: include_type_name
GetFieldMappingRequest.Builder	index(java.lang.String... value)	API name: index
GetFieldMappingRequest.Builder	index(java.util.List<java.lang.String> value)	API name: index
GetFieldMappingRequest.Builder	local(java.lang.Boolean value)	API name: local
GetFieldMappingRequest.Builder	type(java.lang.String... value)	API name: type
GetFieldMappingRequest.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

fields

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

API name: fields

fields

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

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)

API name: index

index

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

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)

API name: type

type

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

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)

API name: allow_no_indices

expandWildcards

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

API name: expand_wildcards

ignoreUnavailable

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

API name: ignore_unavailable

includeDefaults

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

API name: include_defaults

includeTypeName

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

API name: include_type_name

local

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

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.