GetFieldMappingsRequest

java.lang.Object
- org.elasticsearch.common.ContextAndHeaderHolder
- - org.elasticsearch.transport.TransportMessage<TransportRequest>
  - - org.elasticsearch.transport.TransportRequest
    - - org.elasticsearch.action.ActionRequest<GetFieldMappingsRequest>
      - org.elasticsearch.action.admin.indices.mapping.get.GetFieldMappingsRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable
```
public class GetFieldMappingsRequest
extends ActionRequest<GetFieldMappingsRequest>
implements IndicesRequest.Replaceable
```
Request the mappings of specific fields

Nested Class Summary
- Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
  TransportRequest.Empty
- Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
  IndicesRequest.Replaceable

Field Summary

Fields

Modifier and Type	Field and Description
`protected boolean`	`local`

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder
headers

Constructor Summary

Constructors

Constructor and Description
`GetFieldMappingsRequest()`
`GetFieldMappingsRequest(GetFieldMappingsRequest other)`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`String[]`	`fields()`
`GetFieldMappingsRequest`	`fields(String... fields)`
`boolean`	`includeDefaults()`
`GetFieldMappingsRequest`	`includeDefaults(boolean includeDefaults)` Indicates whether default mapping settings should be returned
`String[]`	`indices()` Returns the array of indices that the action relates to
`GetFieldMappingsRequest`	`indices(String... indices)`
`IndicesOptions`	`indicesOptions()` Returns the indices options used to resolve indices.
`GetFieldMappingsRequest`	`indicesOptions(IndicesOptions indicesOptions)`
`boolean`	`local()`
`GetFieldMappingsRequest`	`local(boolean local)` Indicate whether the receiving node should operate based on local index information or forward requests, where needed, to other nodes.
`void`	`readFrom(StreamInput in)`
`String[]`	`types()`
`GetFieldMappingsRequest`	`types(String... types)`
`ActionRequestValidationException`	`validate()`
`void`	`writeTo(StreamOutput out)`

Methods inherited from class org.elasticsearch.action.ActionRequest
listenerThreaded, listenerThreaded

Methods inherited from class org.elasticsearch.transport.TransportMessage
putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder
contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putInContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - local
```
protected boolean local
```
- Constructor Detail
  - GetFieldMappingsRequest
```
public GetFieldMappingsRequest()
```
  - GetFieldMappingsRequest
```
public GetFieldMappingsRequest(GetFieldMappingsRequest other)
```
- Method Detail
  - local
```
public GetFieldMappingsRequest local(boolean local)
```
    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
```
public boolean local()
```
  - indices
```
public GetFieldMappingsRequest indices(String... indices)
```
  - types
```
public GetFieldMappingsRequest types(String... types)
```
  - indicesOptions
```
public GetFieldMappingsRequest indicesOptions(IndicesOptions indicesOptions)
```
  - indices
```
public String[] indices()
```
    Description copied from interface: IndicesRequest
    
    Returns the array of indices that the action relates to
  - types
```
public String[] types()
```
  - indicesOptions
```
public IndicesOptions indicesOptions()
```
    Description copied from interface: IndicesRequest
    
    Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.
  - fields
```
public GetFieldMappingsRequest fields(String... fields)
```
    Parameters:
    
    fields - a list of fields to retrieve the mapping for
  - fields
```
public String[] fields()
```
  - includeDefaults
```
public boolean includeDefaults()
```
  - includeDefaults
```
public GetFieldMappingsRequest includeDefaults(boolean includeDefaults)
```
    Indicates whether default mapping settings should be returned
  - validate
```
public ActionRequestValidationException validate()
```
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    Specified by:
    
    writeTo in interface Streamable
    
    Overrides:
    
    writeTo in class ActionRequest<GetFieldMappingsRequest>
    
    Throws:
    
    IOException
  - readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
    Specified by:
    
    readFrom in interface Streamable
    
    Overrides:
    
    readFrom in class ActionRequest<GetFieldMappingsRequest>
    
    Throws:
    
    IOException

Class GetFieldMappingsRequest

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

Field Summary

Fields

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

Constructor Summary

Constructors

Method Summary

Methods inherited from class org.elasticsearch.action.ActionRequest

Methods inherited from class org.elasticsearch.transport.TransportMessage

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

Methods inherited from class java.lang.Object

Field Detail

local

Constructor Detail

GetFieldMappingsRequest

GetFieldMappingsRequest

Method Detail

local

local

indices

types

indicesOptions

indices

types

indicesOptions

fields

fields

includeDefaults

includeDefaults

validate

writeTo

readFrom