Package org.opensearch.client.opensearch._global

Class FieldCapsRequest.Builder

java.lang.Object

org.opensearch.client.opensearch._global.FieldCapsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<FieldCapsRequest>

Enclosing class:

FieldCapsRequest

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

Builder for FieldCapsRequest.

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
FieldCapsRequest.Builder	addFields(java.lang.String value)	Add a value to fields(List), creating the list if needed.
FieldCapsRequest.Builder	addIndex(java.lang.String value)	Add a value to index(List), creating the list if needed.
FieldCapsRequest.Builder	allowNoIndices(java.lang.Boolean value)	API name: allow_no_indices
FieldCapsRequest	build()	Builds a FieldCapsRequest.
FieldCapsRequest.Builder	expandWildcards(jakarta.json.JsonValue value)	API name: expand_wildcards
FieldCapsRequest.Builder	fields(java.lang.String... value)	API name: fields
FieldCapsRequest.Builder	fields(java.util.List<java.lang.String> value)	API name: fields
FieldCapsRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	API name: ignore_unavailable
FieldCapsRequest.Builder	includeUnmapped(java.lang.Boolean value)	API name: include_unmapped
FieldCapsRequest.Builder	index(java.lang.String... value)	API name: index
FieldCapsRequest.Builder	index(java.util.List<java.lang.String> value)	API name: index
FieldCapsRequest.Builder	indexFilter(java.util.function.Function<FieldCapabilitiesBodyIndexFilter.Builder,ObjectBuilder<FieldCapabilitiesBodyIndexFilter>> fn)	API name: index_filter
FieldCapsRequest.Builder	indexFilter(FieldCapabilitiesBodyIndexFilter value)	API name: index_filter

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 FieldCapsRequest.Builder index(@Nullable java.util.List<java.lang.String> value)

API name: index

index

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

API name: index

addIndex

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

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

allowNoIndices

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

API name: allow_no_indices

expandWildcards

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

API name: expand_wildcards

fields

public FieldCapsRequest.Builder fields(@Nullable java.util.List<java.lang.String> value)

API name: fields

fields

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

API name: fields

addFields

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

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

ignoreUnavailable

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

API name: ignore_unavailable

includeUnmapped

public FieldCapsRequest.Builder includeUnmapped(@Nullable java.lang.Boolean value)

API name: include_unmapped

indexFilter

public FieldCapsRequest.Builder indexFilter(@Nullable FieldCapabilitiesBodyIndexFilter value)

API name: index_filter

indexFilter

public FieldCapsRequest.Builder indexFilter(java.util.function.Function<FieldCapabilitiesBodyIndexFilter.Builder,ObjectBuilder<FieldCapabilitiesBodyIndexFilter>> fn)

API name: index_filter

build

public FieldCapsRequest build()

Builds a FieldCapsRequest.

Specified by:

build in interface ObjectBuilder<FieldCapsRequest>

Throws:

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