org.elasticsearch.action.admin.indices.mapping.get

Class GetFieldMappingsResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.admin.indices.mapping.get.GetFieldMappingsResponse

All Implemented Interfaces:

Streamable, ToXContent

public class GetFieldMappingsResponse
extends ActionResponse
implements ToXContent

Response object for GetFieldMappingsRequest API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetFieldMappingsResponse.FieldMappingMetaData

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

TransportResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
GetFieldMappingsResponse.FieldMappingMetaData	fieldMappings(java.lang.String index, java.lang.String type, java.lang.String field) Returns the mappings of a specific field.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,GetFieldMappingsResponse.FieldMappingMetaData>>>	mappings() returns the retrieved field mapping.
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

isFragment

Method Detail

mappings

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,GetFieldMappingsResponse.FieldMappingMetaData>>> mappings()

returns the retrieved field mapping. The return map keys are index, type, field (as specified in the request).

fieldMappings

public GetFieldMappingsResponse.FieldMappingMetaData fieldMappings(java.lang.String index,
                                                                   java.lang.String type,
                                                                   java.lang.String field)

Returns the mappings of a specific field.

Parameters:

field - field name as specified in the GetFieldMappingsRequest

Returns:

FieldMappingMetaData for the requested field or null if not found.

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionResponse

Throws:

java.io.IOException