Package 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:

Writeable, RefCounted, ToXContent, ToXContentObject

public class GetFieldMappingsResponse
extends ActionResponse
implements ToXContentObject

Response object for GetFieldMappingsRequest API Note: there is a new class with the same name for the Java HLRC that uses a typeless format. Any changes done to this class should go to that client class as well.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetFieldMappingsResponse.FieldMappingMetadata

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GetFieldMappingsResponse(Map<String,Map<String,Map<String,GetFieldMappingsResponse.FieldMappingMetadata>>> mappings)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
GetFieldMappingsResponse.FieldMappingMetadata	fieldMappings(String index, String type, String field)	Returns the mappings of a specific field.
static GetFieldMappingsResponse	fromXContent(XContentParser parser)
int	hashCode()
Map<String,Map<String,Map<String,GetFieldMappingsResponse.FieldMappingMetadata>>>	mappings()	returns the retrieved field mapping.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

GetFieldMappingsResponse

public GetFieldMappingsResponse(Map<String,Map<String,Map<String,GetFieldMappingsResponse.FieldMappingMetadata>>> mappings)

Method Details

mappings

public Map<String,Map<String,Map<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(String index,
 String type,
 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 IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static GetFieldMappingsResponse fromXContent(XContentParser parser)
                                             throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object