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

Class GetFieldMappingsRequestBuilder

java.lang.Object

org.opensearch.action.ActionRequestBuilder<GetFieldMappingsRequest,GetFieldMappingsResponse>

org.opensearch.action.admin.indices.mapping.get.GetFieldMappingsRequestBuilder

public class GetFieldMappingsRequestBuilder
extends ActionRequestBuilder<GetFieldMappingsRequest,GetFieldMappingsResponse>

A helper class to build GetFieldMappingsRequest objects

Field Summary

Fields inherited from class org.opensearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
GetFieldMappingsRequestBuilder(OpenSearchClient client, GetFieldMappingsAction action, java.lang.String... indices)

Method Summary

Modifier and Type	Method	Description
GetFieldMappingsRequestBuilder	addIndices(java.lang.String... indices)
GetFieldMappingsRequestBuilder	addTypes(java.lang.String... types)
GetFieldMappingsRequestBuilder	includeDefaults(boolean includeDefaults)	Indicates whether default mapping settings should be returned
GetFieldMappingsRequestBuilder	setFields(java.lang.String... fields)	Sets the fields to retrieve.
GetFieldMappingsRequestBuilder	setIndices(java.lang.String... indices)
GetFieldMappingsRequestBuilder	setIndicesOptions(IndicesOptions indicesOptions)
GetFieldMappingsRequestBuilder	setTypes(java.lang.String... types)

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

GetFieldMappingsRequestBuilder

public GetFieldMappingsRequestBuilder(OpenSearchClient client, GetFieldMappingsAction action, java.lang.String... indices)

Method Details

setIndices

public GetFieldMappingsRequestBuilder setIndices(java.lang.String... indices)

addIndices

public GetFieldMappingsRequestBuilder addIndices(java.lang.String... indices)

setTypes

public GetFieldMappingsRequestBuilder setTypes(java.lang.String... types)

addTypes

public GetFieldMappingsRequestBuilder addTypes(java.lang.String... types)

setIndicesOptions

public GetFieldMappingsRequestBuilder setIndicesOptions(IndicesOptions indicesOptions)

setFields

public GetFieldMappingsRequestBuilder setFields(java.lang.String... fields)

Sets the fields to retrieve.

includeDefaults

public GetFieldMappingsRequestBuilder includeDefaults(boolean includeDefaults)

Indicates whether default mapping settings should be returned