Class GetFieldMappingsResponse
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.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,org.elasticsearch.core.RefCounted
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/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
-
Method Summary
Modifier and TypeMethodDescriptionboolean
o)
index, type, field)
Returns the mappings of a specific field.static GetFieldMappingsResponse
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
int
hashCode()
<,<,<,GetFieldMappingsResponse.FieldMappingMetadata>>>
mappings()
returns the retrieved field mapping.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.
, , , , , , ,
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
GetFieldMappingsResponse
public GetFieldMappingsResponse(<,<,<,GetFieldMappingsResponse.FieldMappingMetadata>>> mappings)
-
-
Method Details
-
mappings
returns the retrieved field mapping. The return map keys are index, type, field (as specified in the request). -
fieldMappings
public index, type, 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- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
-
fromXContent
public static GetFieldMappingsResponse fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws- Throws:
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
toString
public toString()- Overrides:
in class
-
equals
public boolean equals( o)- Overrides:
in class
-
hashCode
public int hashCode()- Overrides:
in class
-