Package org.opensearch.client.opensearch.core.field_caps

Class FieldCapability.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.field_caps.FieldCapability.Builder

All Implemented Interfaces:

ObjectBuilder<FieldCapability>

Enclosing class:

FieldCapability

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

Builder for FieldCapability.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FieldCapability.Builder	aggregatable(boolean value)	Required - API name: aggregatable
FieldCapability	build()	Builds a FieldCapability.
FieldCapability.Builder	indices(java.lang.String value, java.lang.String... values)	API name: indices
FieldCapability.Builder	indices(java.util.List<java.lang.String> list)	API name: indices
FieldCapability.Builder	meta(java.lang.String key, java.util.List<java.lang.String> value)	API name: meta
FieldCapability.Builder	meta(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)	API name: meta
FieldCapability.Builder	metadataField(java.lang.Boolean value)	API name: metadata_field
FieldCapability.Builder	nonAggregatableIndices(java.lang.String value, java.lang.String... values)	API name: non_aggregatable_indices
FieldCapability.Builder	nonAggregatableIndices(java.util.List<java.lang.String> list)	API name: non_aggregatable_indices
FieldCapability.Builder	nonSearchableIndices(java.lang.String value, java.lang.String... values)	API name: non_searchable_indices
FieldCapability.Builder	nonSearchableIndices(java.util.List<java.lang.String> list)	API name: non_searchable_indices
FieldCapability.Builder	searchable(boolean value)	Required - API name: searchable
FieldCapability.Builder	type(java.lang.String value)	Required - API name: type

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

aggregatable

public final FieldCapability.Builder aggregatable(boolean value)

Required - API name: aggregatable

indices

public final FieldCapability.Builder indices(java.util.List<java.lang.String> list)

API name: indices

Adds all elements of list to indices.

indices

public final FieldCapability.Builder indices(java.lang.String value,
                                             java.lang.String... values)

API name: indices

Adds one or more values to indices.

meta

public final FieldCapability.Builder meta(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)

API name: meta

Adds all entries of map to meta.

meta

public final FieldCapability.Builder meta(java.lang.String key,
                                          java.util.List<java.lang.String> value)

API name: meta

Adds an entry to meta.

nonAggregatableIndices

public final FieldCapability.Builder nonAggregatableIndices(java.util.List<java.lang.String> list)

API name: non_aggregatable_indices

Adds all elements of list to nonAggregatableIndices.

nonAggregatableIndices

public final FieldCapability.Builder nonAggregatableIndices(java.lang.String value,
                                                            java.lang.String... values)

API name: non_aggregatable_indices

Adds one or more values to nonAggregatableIndices.

nonSearchableIndices

public final FieldCapability.Builder nonSearchableIndices(java.util.List<java.lang.String> list)

API name: non_searchable_indices

Adds all elements of list to nonSearchableIndices.

nonSearchableIndices

public final FieldCapability.Builder nonSearchableIndices(java.lang.String value,
                                                          java.lang.String... values)

API name: non_searchable_indices

Adds one or more values to nonSearchableIndices.

searchable

public final FieldCapability.Builder searchable(boolean value)

Required - API name: searchable

type

public final FieldCapability.Builder type(java.lang.String value)

Required - API name: type

metadataField

public final FieldCapability.Builder metadataField(@Nullable
                                                   java.lang.Boolean value)

API name: metadata_field

build

public FieldCapability build()

Builds a FieldCapability.

Specified by:

build in interface ObjectBuilder<FieldCapability>

Throws:

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