GetMappingsRequest (rest-high-level 7.12.1 API)

java.lang.Object

org.elasticsearch.client.TimedRequest

org.elasticsearch.client.indices.GetMappingsRequest

All Implemented Interfaces:: Validatable

public class GetMappingsRequest
extends TimedRequest

Field Summary

Fields inherited from class org.elasticsearch.client.TimedRequest
DEFAULT_ACK_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT

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

Constructors

Constructor Description

GetMappingsRequest()

Method Summary

Modifier and Type	Method	Description
`boolean`	`includeDefaults()`
`GetMappingsRequest`	`includeDefaults(boolean includeDefaults)`	Indicates whether default mapping settings should be returned
`java.lang.String[]`	`indices()`
`GetMappingsRequest`	`indices(java.lang.String... indices)`
`org.elasticsearch.action.support.IndicesOptions`	`indicesOptions()`
`GetMappingsRequest`	`indicesOptions(org.elasticsearch.action.support.IndicesOptions indicesOptions)`
`boolean`	`local()`
`GetMappingsRequest`	`local(boolean local)`	Indicates whether the receiving node should operate based on local index information or forward requests, where needed, to other nodes.

Methods inherited from class org.elasticsearch.client.TimedRequest

masterNodeTimeout, setMasterTimeout, setTimeout, timeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.client.Validatable

validate

Constructor Details
- GetMappingsRequest
  
  public GetMappingsRequest()
Method Details
- local
  
  public GetMappingsRequest local(boolean local)
  
  Indicates 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 local index information is missing.
- local
  
  public boolean local()
- indices
  
  public GetMappingsRequest indices(java.lang.String... indices)
- indicesOptions
  
  public GetMappingsRequest indicesOptions(org.elasticsearch.action.support.IndicesOptions indicesOptions)
- indices
  
  public java.lang.String[] indices()
- indicesOptions
  
  public org.elasticsearch.action.support.IndicesOptions indicesOptions()
- includeDefaults
  
  public boolean includeDefaults()
- includeDefaults
  
  public GetMappingsRequest includeDefaults(boolean includeDefaults)
  
  Indicates whether default mapping settings should be returned