java.lang.Object

org.opensearch.client.indices.GetFieldMappingsRequest

public class GetFieldMappingsRequest
extends java.lang.Object
implements Validatable

Request the mappings of specific fields

Field Summary

Fields inherited from interface org.opensearch.client.Validatable
EMPTY
Constructor Summary

Constructors

Constructor Description

GetFieldMappingsRequest()

Method Summary

Modifier and Type	Method	Description
`java.lang.String[]`	`fields()`
`GetFieldMappingsRequest`	`fields(java.lang.String... fields)`
`boolean`	`includeDefaults()`
`GetFieldMappingsRequest`	`includeDefaults(boolean includeDefaults)`	Indicates whether default mapping settings should be returned
`java.lang.String[]`	`indices()`
`GetFieldMappingsRequest`	`indices(java.lang.String... indices)`
`org.opensearch.action.support.IndicesOptions`	`indicesOptions()`
`GetFieldMappingsRequest`	`indicesOptions(org.opensearch.action.support.IndicesOptions indicesOptions)`
`boolean`	`local()`	Deprecated.
`GetFieldMappingsRequest`	`local(boolean local)`	Deprecated.

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

validate

Constructor Details
- GetFieldMappingsRequest
  
  public GetFieldMappingsRequest()
Method Details
- local
  
  @Deprecated public GetFieldMappingsRequest local(boolean local)
  
  Deprecated.
  
  Indicate whether the receiving node should operate based on local index information or forward requests, where needed, to other nodes. If running locally, request will not raise errors if running locally & missing indices.
- local
  
  @Deprecated public boolean local()
  
  Deprecated.
- indices
  
  public GetFieldMappingsRequest indices(java.lang.String... indices)
- indicesOptions
  
  public GetFieldMappingsRequest indicesOptions(org.opensearch.action.support.IndicesOptions indicesOptions)
- indices
  
  public java.lang.String[] indices()
- indicesOptions
  
  public org.opensearch.action.support.IndicesOptions indicesOptions()
- fields
  
  public GetFieldMappingsRequest fields(java.lang.String... fields)
  
  Parameters:
  
  fields - a list of fields to retrieve the mapping for
- fields
  
  public java.lang.String[] fields()
- includeDefaults
  
  public boolean includeDefaults()
- includeDefaults
  
  public GetFieldMappingsRequest includeDefaults(boolean includeDefaults)
  
  Indicates whether default mapping settings should be returned

Class GetFieldMappingsRequest