Package org.opensearch.client.opensearch.indices

Class OpenSearchIndicesClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchIndicesClient>

org.opensearch.client.opensearch.indices.OpenSearchIndicesClientBase<OpenSearchIndicesClient>

org.opensearch.client.opensearch.indices.OpenSearchIndicesClient

public class OpenSearchIndicesClient
extends OpenSearchIndicesClientBase<OpenSearchIndicesClient>

Client for the indices namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchIndicesClient(OpenSearchTransport transport)
OpenSearchIndicesClient(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
final GetFieldMappingResponse	getFieldMapping(Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)	Returns mapping for one or more fields.
GetFieldMappingResponse	getFieldMapping(GetFieldMappingRequest request)	Returns mapping for one or more fields.
OpenSearchIndicesClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.opensearch.indices.OpenSearchIndicesClientBase

addBlock, addBlock, analyze, analyze, analyze, clearCache, clearCache, clearCache, clone, clone, close, close, create, create, createDataStream, createDataStream, dataStreamsStats, dataStreamsStats, dataStreamsStats, delete, delete, deleteAlias, deleteAlias, deleteDataStream, deleteDataStream, deleteIndexTemplate, deleteIndexTemplate, deleteTemplate, deleteTemplate, exists, exists, existsAlias, existsAlias, existsIndexTemplate, existsIndexTemplate, existsTemplate, existsTemplate, flush, flush, flush, forcemerge, forcemerge, forcemerge, get, get, getAlias, getAlias, getAlias, getDataStream, getDataStream, getDataStream, getIndexTemplate, getIndexTemplate, getIndexTemplate, getMapping, getMapping, getMapping, getSettings, getSettings, getSettings, getTemplate, getTemplate, getTemplate, open, open, putAlias, putAlias, putAlias, putIndexTemplate, putIndexTemplate, putMapping, putMapping, putSettings, putSettings, putTemplate, putTemplate, recovery, recovery, recovery, refresh, refresh, refresh, resolveIndex, resolveIndex, rollover, rollover, segments, segments, segments, shardStores, shardStores, shardStores, shrink, shrink, simulateIndexTemplate, simulateIndexTemplate, simulateTemplate, simulateTemplate, split, split, stats, stats, stats, updateAliases, updateAliases, updateAliases, validateQuery, validateQuery, validateQuery

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchIndicesClient

public OpenSearchIndicesClient(OpenSearchTransport transport)

OpenSearchIndicesClient

public OpenSearchIndicesClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchIndicesClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchIndicesClient>

getFieldMapping

public GetFieldMappingResponse getFieldMapping(GetFieldMappingRequest request)
                                        throws IOException,
OpenSearchException

Returns mapping for one or more fields.

Throws:

IOException

OpenSearchException

getFieldMapping

public final GetFieldMappingResponse getFieldMapping(Function<GetFieldMappingRequest.Builder,ObjectBuilder<GetFieldMappingRequest>> fn)
                                              throws IOException,
OpenSearchException

Returns mapping for one or more fields.

Parameters:

fn - a function that initializes a builder to create the GetFieldMappingRequest

Throws:

IOException

OpenSearchException