Package org.opensearch.action.admin.indices.mapping.put

Class PutMappingRequestBuilder

java.lang.Object

org.opensearch.action.ActionRequestBuilder<PutMappingRequest,AcknowledgedResponse>

org.opensearch.action.support.clustermanager.ClusterManagerNodeOperationRequestBuilder<PutMappingRequest,AcknowledgedResponse,PutMappingRequestBuilder>

org.opensearch.action.support.master.MasterNodeOperationRequestBuilder<PutMappingRequest,AcknowledgedResponse,PutMappingRequestBuilder>

org.opensearch.action.support.master.AcknowledgedRequestBuilder<PutMappingRequest,AcknowledgedResponse,PutMappingRequestBuilder>

org.opensearch.action.admin.indices.mapping.put.PutMappingRequestBuilder

@PublicApi(since="1.0.0")
public class PutMappingRequestBuilder
extends AcknowledgedRequestBuilder<PutMappingRequest,AcknowledgedResponse,PutMappingRequestBuilder>

Builder for a put mapping request

Opensearch.api:

Field Summary

Fields inherited from class org.opensearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
PutMappingRequestBuilder(OpenSearchClient client, PutMappingAction action)

Method Summary

Modifier and Type	Method	Description
PutMappingRequestBuilder	setConcreteIndex(org.opensearch.core.index.Index index)
PutMappingRequestBuilder	setIndices(String... indices)
PutMappingRequestBuilder	setIndicesOptions(IndicesOptions options)	Specifies what type of requested indices to ignore and wildcard indices expressions.
PutMappingRequestBuilder	setSource(String... source)	A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").
PutMappingRequestBuilder	setSource(String mappingSource, org.opensearch.core.xcontent.MediaType mediaType)	The mapping source definition.
PutMappingRequestBuilder	setSource(Map mappingSource)	The mapping source definition.
PutMappingRequestBuilder	setSource(org.opensearch.core.xcontent.XContentBuilder mappingBuilder)	The mapping source definition.

Methods inherited from class org.opensearch.action.support.master.AcknowledgedRequestBuilder

setTimeout, setTimeout

Methods inherited from class org.opensearch.action.support.clustermanager.ClusterManagerNodeOperationRequestBuilder

setClusterManagerNodeTimeout, setClusterManagerNodeTimeout, setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class org.opensearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

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

Constructor Details

PutMappingRequestBuilder

public PutMappingRequestBuilder(OpenSearchClient client,
 PutMappingAction action)

Method Details

setIndices

public PutMappingRequestBuilder setIndices(String... indices)

setConcreteIndex

public PutMappingRequestBuilder setConcreteIndex(org.opensearch.core.index.Index index)

setIndicesOptions

public PutMappingRequestBuilder setIndicesOptions(IndicesOptions options)

Specifies what type of requested indices to ignore and wildcard indices expressions.

For example indices that don't exist.

setSource

public PutMappingRequestBuilder setSource(org.opensearch.core.xcontent.XContentBuilder mappingBuilder)

The mapping source definition.

setSource

public PutMappingRequestBuilder setSource(Map mappingSource)

The mapping source definition.

setSource

public PutMappingRequestBuilder setSource(String mappingSource,
 org.opensearch.core.xcontent.MediaType mediaType)

The mapping source definition.

setSource

public PutMappingRequestBuilder setSource(String... source)

A specialized simplified mapping source method, takes the form of simple properties definition: ("field1", "type=string,store=true").