Package org.opensearch.client.opensearch.indices

Class IndexSettingsMappingLimitFieldNameLength.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.IndexSettingsMappingLimitFieldNameLength.Builder

All Implemented Interfaces:

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

Enclosing class:

IndexSettingsMappingLimitFieldNameLength

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

Builder for IndexSettingsMappingLimitFieldNameLength.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IndexSettingsMappingLimitFieldNameLength	build()	Builds a IndexSettingsMappingLimitFieldNameLength.
IndexSettingsMappingLimitFieldNameLength.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndexSettingsMappingLimitFieldNameLength.Builder	limit(Long value)	Setting for the maximum length of a field name.

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 IndexSettingsMappingLimitFieldNameLength.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<IndexSettingsMappingLimitFieldNameLength.Builder,IndexSettingsMappingLimitFieldNameLength>

Returns:

a new builder instance.

limit

@Nonnull
public final IndexSettingsMappingLimitFieldNameLength.Builder limit(@Nullable
 Long value)

Setting for the maximum length of a field name. This setting isn't really something that addresses mappings explosion but might still be useful if you want to limit the field length. It usually shouldn't be necessary to set this setting. The default is okay unless a user starts to add a huge number of fields with really long names. Default is Long.MAX_VALUE (no limit).

API name: limit

build

@Nonnull
public IndexSettingsMappingLimitFieldNameLength build()

Builds a IndexSettingsMappingLimitFieldNameLength.

Specified by:

build in interface ObjectBuilder<IndexSettingsMappingLimitFieldNameLength>

Throws:

NullPointerException - if some of the required fields are null.