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:

CopyableBuilder<FieldCapability.Builder,FieldCapability>, MutableBuilder<FieldCapability.Builder,FieldCapability>, ObjectBuilder<FieldCapability>

Enclosing class:

FieldCapability

public static class FieldCapability.Builder
extends ObjectBuilderBase
implements CopyableBuilder<FieldCapability.Builder,FieldCapability>

Builder for FieldCapability.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final FieldCapability.Builder	aggregatable(boolean value)	Required - Whether this field can be aggregated on all indexes.
FieldCapability	build()	Builds a FieldCapability.
FieldCapability.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final FieldCapability.Builder	indices(String value, String... values)	API name: indices
final FieldCapability.Builder	indices(List<String> list)	API name: indices
final FieldCapability.Builder	meta(String key, List<String> value)	API name: meta
final FieldCapability.Builder	meta(Map<String,List<String>> map)	API name: meta
final FieldCapability.Builder	metadataField(Boolean value)	Whether this field is registered as a metadata field.
final FieldCapability.Builder	nonAggregatableIndices(String value, String... values)	API name: non_aggregatable_indices
final FieldCapability.Builder	nonAggregatableIndices(List<String> list)	API name: non_aggregatable_indices
final FieldCapability.Builder	nonSearchableIndices(String value, String... values)	API name: non_searchable_indices
final FieldCapability.Builder	nonSearchableIndices(List<String> list)	API name: non_searchable_indices
final FieldCapability.Builder	searchable(boolean value)	Required - Whether this field is indexed for search on all indexes.
final FieldCapability.Builder	type(String value)	Required - API name: type

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public FieldCapability.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<FieldCapability.Builder,FieldCapability>

Returns:

a new builder instance.

aggregatable

@Nonnull
public final FieldCapability.Builder aggregatable(boolean value)

Required - Whether this field can be aggregated on all indexes.

API name: aggregatable

indices

@Nonnull
public final FieldCapability.Builder indices(List<String> list)

API name: indices

Adds all elements of list to indices.

indices

@Nonnull
public final FieldCapability.Builder indices(String value,
 String... values)

API name: indices

Adds one or more values to indices.

meta

@Nonnull
public final FieldCapability.Builder meta(Map<String,List<String>> map)

API name: meta

Adds all elements of map to meta.

meta

@Nonnull
public final FieldCapability.Builder meta(String key,
 List<String> value)

API name: meta

Adds an entry to meta.

metadataField

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

Whether this field is registered as a metadata field.

API name: metadata_field

nonAggregatableIndices

@Nonnull
public final FieldCapability.Builder nonAggregatableIndices(List<String> list)

API name: non_aggregatable_indices

Adds all elements of list to nonAggregatableIndices.

nonAggregatableIndices

@Nonnull
public final FieldCapability.Builder nonAggregatableIndices(String value,
 String... values)

API name: non_aggregatable_indices

Adds one or more values to nonAggregatableIndices.

nonSearchableIndices

@Nonnull
public final FieldCapability.Builder nonSearchableIndices(List<String> list)

API name: non_searchable_indices

Adds all elements of list to nonSearchableIndices.

nonSearchableIndices

@Nonnull
public final FieldCapability.Builder nonSearchableIndices(String value,
 String... values)

API name: non_searchable_indices

Adds one or more values to nonSearchableIndices.

searchable

@Nonnull
public final FieldCapability.Builder searchable(boolean value)

Required - Whether this field is indexed for search on all indexes.

API name: searchable

type

@Nonnull
public final FieldCapability.Builder type(String value)

Required - API name: type

build

@Nonnull
public FieldCapability build()

Builds a FieldCapability.

Specified by:

build in interface ObjectBuilder<FieldCapability>

Throws:

NullPointerException - if some of the required fields are null.