Package org.opensearch.client.opensearch.indices

Class PutMappingRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<PutMappingRequest.Builder>

org.opensearch.client.opensearch.indices.PutMappingRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

PutMappingRequest

public static class PutMappingRequest.Builder
extends RequestBase.AbstractBuilder<PutMappingRequest.Builder>
implements CopyableBuilder<PutMappingRequest.Builder,PutMappingRequest>

Builder for PutMappingRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final PutMappingRequest.Builder	allowNoIndices(Boolean value)	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.
PutMappingRequest	build()	Builds a PutMappingRequest.
final PutMappingRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final PutMappingRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
PutMappingRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PutMappingRequest.Builder	dateDetection(Boolean value)	Controls whether dynamic date detection is enabled.
final PutMappingRequest.Builder	dynamic(DynamicMapping value)	API name: dynamic
final PutMappingRequest.Builder	dynamicDateFormats(String value, String... values)	If date detection is enabled then new string fields are checked against dynamic_date_formats and if the value matches then a new date field is added instead of string.
final PutMappingRequest.Builder	dynamicDateFormats(List<String> list)	If date detection is enabled then new string fields are checked against dynamic_date_formats and if the value matches then a new date field is added instead of string.
final PutMappingRequest.Builder	dynamicTemplates(List<Map<String,DynamicTemplate>> list)	Specify dynamic templates for the mapping.
final PutMappingRequest.Builder	dynamicTemplates(Map<String,DynamicTemplate> value, Map<String,DynamicTemplate>... values)	Specify dynamic templates for the mapping.
final PutMappingRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Type of index that wildcard patterns can match.
final PutMappingRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of index that wildcard patterns can match.
final PutMappingRequest.Builder	fieldNames(Function<FieldNamesField.Builder,ObjectBuilder<FieldNamesField>> fn)	API name: _field_names
final PutMappingRequest.Builder	fieldNames(FieldNamesField value)	API name: _field_names
final PutMappingRequest.Builder	ignoreUnavailable(Boolean value)	If false, the request returns an error if it targets a missing or closed index.
final PutMappingRequest.Builder	index(String value, String... values)	Required - A comma-separated list of index names the mapping should be added to (supports wildcards); use _all or omit to add the mapping on all indexes.
final PutMappingRequest.Builder	index(List<String> list)	Required - A comma-separated list of index names the mapping should be added to (supports wildcards); use _all or omit to add the mapping on all indexes.
final PutMappingRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final PutMappingRequest.Builder	masterTimeout(Time value)	Deprecated.
final PutMappingRequest.Builder	meta(String key, JsonData value)	API name: _meta
final PutMappingRequest.Builder	meta(Map<String,JsonData> map)	API name: _meta
final PutMappingRequest.Builder	numericDetection(Boolean value)	Automatically map strings into numeric data types for all fields.
final PutMappingRequest.Builder	properties(String key, Function<Property.Builder,ObjectBuilder<Property>> fn)	Mapping for a field.
final PutMappingRequest.Builder	properties(String key, Property value)	Mapping for a field.
final PutMappingRequest.Builder	properties(Map<String,Property> map)	Mapping for a field.
final PutMappingRequest.Builder	routing(Function<RoutingField.Builder,ObjectBuilder<RoutingField>> fn)	API name: _routing
final PutMappingRequest.Builder	routing(RoutingField value)	API name: _routing
protected PutMappingRequest.Builder	self()
final PutMappingRequest.Builder	source(Function<SourceField.Builder,ObjectBuilder<SourceField>> fn)	API name: _source
final PutMappingRequest.Builder	source(SourceField value)	API name: _source
final PutMappingRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final PutMappingRequest.Builder	timeout(Time value)	Period to wait for a response.
final PutMappingRequest.Builder	writeIndexOnly(Boolean value)	If true, the mappings are applied only to the current write index for the target.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

Returns:

a new builder instance.

self

@Nonnull
protected PutMappingRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutMappingRequest.Builder>

allowNoIndices

@Nonnull
public final PutMappingRequest.Builder allowNoIndices(@Nullable
 Boolean value)

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

API name: allow_no_indices

clusterManagerTimeout

@Nonnull
public final PutMappingRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final PutMappingRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

dateDetection

@Nonnull
public final PutMappingRequest.Builder dateDetection(@Nullable
 Boolean value)

Controls whether dynamic date detection is enabled.

API name: date_detection

dynamic

@Nonnull
public final PutMappingRequest.Builder dynamic(@Nullable
 DynamicMapping value)

API name: dynamic

dynamicDateFormats

@Nonnull
public final PutMappingRequest.Builder dynamicDateFormats(List<String> list)

If date detection is enabled then new string fields are checked against dynamic_date_formats and if the value matches then a new date field is added instead of string.

API name: dynamic_date_formats

Adds all elements of list to dynamicDateFormats.

dynamicDateFormats

@Nonnull
public final PutMappingRequest.Builder dynamicDateFormats(String value,
 String... values)

If date detection is enabled then new string fields are checked against dynamic_date_formats and if the value matches then a new date field is added instead of string.

API name: dynamic_date_formats

Adds one or more values to dynamicDateFormats.

dynamicTemplates

@Nonnull
public final PutMappingRequest.Builder dynamicTemplates(List<Map<String,DynamicTemplate>> list)

Specify dynamic templates for the mapping.

API name: dynamic_templates

Adds all elements of list to dynamicTemplates.

dynamicTemplates

@Nonnull
public final PutMappingRequest.Builder dynamicTemplates(Map<String,DynamicTemplate> value,
 Map<String,DynamicTemplate>... values)

Specify dynamic templates for the mapping.

API name: dynamic_templates

Adds one or more values to dynamicTemplates.

expandWildcards

@Nonnull
public final PutMappingRequest.Builder expandWildcards(List<ExpandWildcard> list)

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

@Nonnull
public final PutMappingRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

API name: expand_wildcards

Adds one or more values to expandWildcards.

fieldNames

@Nonnull
public final PutMappingRequest.Builder fieldNames(@Nullable
 FieldNamesField value)

API name: _field_names

fieldNames

@Nonnull
public final PutMappingRequest.Builder fieldNames(Function<FieldNamesField.Builder,ObjectBuilder<FieldNamesField>> fn)

API name: _field_names

ignoreUnavailable

@Nonnull
public final PutMappingRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

If false, the request returns an error if it targets a missing or closed index.

API name: ignore_unavailable

index

@Nonnull
public final PutMappingRequest.Builder index(List<String> list)

Required - A comma-separated list of index names the mapping should be added to (supports wildcards); use _all or omit to add the mapping on all indexes.

API name: index

Adds all elements of list to index.

index

@Nonnull
public final PutMappingRequest.Builder index(String value,
 String... values)

Required - A comma-separated list of index names the mapping should be added to (supports wildcards); use _all or omit to add the mapping on all indexes.

API name: index

Adds one or more values to index.

masterTimeout

@Deprecated
@Nonnull
public final PutMappingRequest.Builder masterTimeout(@Nullable
 Time value)

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

@Deprecated
@Nonnull
public final PutMappingRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

meta

@Nonnull
public final PutMappingRequest.Builder meta(Map<String,JsonData> map)

API name: _meta

Adds all elements of map to meta.

meta

@Nonnull
public final PutMappingRequest.Builder meta(String key,
 JsonData value)

API name: _meta

Adds an entry to meta.

numericDetection

@Nonnull
public final PutMappingRequest.Builder numericDetection(@Nullable
 Boolean value)

Automatically map strings into numeric data types for all fields.

API name: numeric_detection

properties

@Nonnull
public final PutMappingRequest.Builder properties(Map<String,Property> map)

Mapping for a field. For new fields, this mapping can include:

• Field name
• Field data type
• Mapping parameters

API name: properties

Adds all elements of map to properties.

properties

@Nonnull
public final PutMappingRequest.Builder properties(String key,
 Property value)

Mapping for a field. For new fields, this mapping can include:

• Field name
• Field data type
• Mapping parameters

API name: properties

Adds an entry to properties.

properties

@Nonnull
public final PutMappingRequest.Builder properties(String key,
 Function<Property.Builder,ObjectBuilder<Property>> fn)

Mapping for a field. For new fields, this mapping can include:

• Field name
• Field data type
• Mapping parameters

API name: properties

Adds a value to properties using a builder lambda.

routing

@Nonnull
public final PutMappingRequest.Builder routing(@Nullable
 RoutingField value)

API name: _routing

routing

@Nonnull
public final PutMappingRequest.Builder routing(Function<RoutingField.Builder,ObjectBuilder<RoutingField>> fn)

API name: _routing

source

@Nonnull
public final PutMappingRequest.Builder source(@Nullable
 SourceField value)

API name: _source

source

@Nonnull
public final PutMappingRequest.Builder source(Function<SourceField.Builder,ObjectBuilder<SourceField>> fn)

API name: _source

timeout

@Nonnull
public final PutMappingRequest.Builder timeout(@Nullable
 Time value)

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

timeout

@Nonnull
public final PutMappingRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

writeIndexOnly

@Nonnull
public final PutMappingRequest.Builder writeIndexOnly(@Nullable
 Boolean value)

If true, the mappings are applied only to the current write index for the target.

API name: write_index_only

build

@Nonnull
public PutMappingRequest build()

Builds a PutMappingRequest.

Specified by:

build in interface ObjectBuilder<PutMappingRequest>

Throws:

NullPointerException - if some of the required fields are null.