Package org.opensearch.client.indices

Class GetFieldMappingsResponse

java.lang.Object

org.opensearch.client.indices.GetFieldMappingsResponse

public class GetFieldMappingsResponse
extends Object

Response object for GetFieldMappingsRequest API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetFieldMappingsResponse.FieldMappingMetadata

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
GetFieldMappingsResponse.FieldMappingMetadata	fieldMappings(String index, String field)	Returns the mappings of a specific index and field.
static GetFieldMappingsResponse	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
int	hashCode()
Map<String,Map<String,GetFieldMappingsResponse.FieldMappingMetadata>>	mappings()	Returns the fields mapping.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

mappings

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

Returns the fields mapping. The return map keys are indexes and fields (as specified in the request).

fieldMappings

public GetFieldMappingsResponse.FieldMappingMetadata fieldMappings(String index,
 String field)

Returns the mappings of a specific index and field.

Parameters:

field - field name as specified in the GetFieldMappingsRequest

Returns:

FieldMappingMetadata for the requested field or null if not found.

fromXContent

public static GetFieldMappingsResponse fromXContent(org.opensearch.common.xcontent.XContentParser parser)
                                             throws IOException

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