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
,org.elasticsearch.common.util.concurrent.RefCounted
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class GetFieldMappingsResponse extends ActionResponse implements org.elasticsearch.common.xcontent.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.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Constructor Description GetFieldMappingsResponse(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,GetFieldMappingsResponse.FieldMappingMetadata>>> mappings)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
GetFieldMappingsResponse.FieldMappingMetadata
fieldMappings(java.lang.String index, java.lang.String type, java.lang.String field)
Returns the mappings of a specific field.static GetFieldMappingsResponse
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
int
hashCode()
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.java.lang.String
toString()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, 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.common.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
GetFieldMappingsResponse
public GetFieldMappingsResponse(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,GetFieldMappingsResponse.FieldMappingMetadata>>> mappings)
-
-
Method Details
-
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 theGetFieldMappingsRequest
- Returns:
- FieldMappingMetadata for the requested field or null if not found.
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
fromXContent
public static GetFieldMappingsResponse fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-