Package org.opensearch.client.transport.endpoints

Class DictionaryResponse<TKey,TValue>

java.lang.Object

org.opensearch.client.transport.endpoints.DictionaryResponse<TKey,TValue>

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

Direct Known Subclasses:

GetActionGroupResponse, GetActionGroupsResponse, GetAliasResponse, GetDecommissionAwarenessResponse, GetDistinguishedNameResponse, GetDistinguishedNamesResponse, GetFeatureResponse, GetFeaturesetResponse, GetFieldMappingResponse, GetIndexResponse, GetIndicesSettingsResponse, GetMappingResponse, GetModelResponse, GetPipelineResponse, GetRepositoryResponse, GetRoleMappingResponse, GetRoleMappingsResponse, GetRoleResponse, GetRolesResponse, GetSearchPipelineResponse, GetTemplateResponse, GetTenantResponse, GetTenantsResponse, GetUserLegacyResponse, GetUserResponse, GetUsersLegacyResponse, GetUsersResponse, RecoveryResponse, RemoteInfoResponse, TenantInfoResponse, UndeployModelResponse, UnloadModelResponse

public abstract class DictionaryResponse<TKey,TValue>
extends Object
implements PlainJsonSerializable

Base class for dictionary responses, i.e. a series of key/value pairs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DictionaryResponse.AbstractBuilder<TKey,TValue,BuilderT extends DictionaryResponse.AbstractBuilder<TKey,TValue,BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DictionaryResponse(DictionaryResponse.AbstractBuilder<TKey,TValue,?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
TValue	get(String key)
int	hashCode()
Map<String,TValue>	result()	Returns the response as a map.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <TKey, TValue, BuilderT extends DictionaryResponse.AbstractBuilder<TKey, TValue, BuilderT>> void	setupDictionaryResponseDeserializer(ObjectDeserializer<BuilderT> op, JsonpDeserializer<TKey> tKeyParser, JsonpDeserializer<TValue> tValueParser)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Constructor Details

DictionaryResponse

protected DictionaryResponse(DictionaryResponse.AbstractBuilder<TKey,TValue,?> builder)

Method Details

result

public Map<String,TValue> result()

Returns the response as a map.

get

public TValue get(String key)

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupDictionaryResponseDeserializer

protected static <TKey,
TValue,
BuilderT extends DictionaryResponse.AbstractBuilder<TKey,
TValue,
BuilderT>>
void setupDictionaryResponseDeserializer(ObjectDeserializer<BuilderT> op,
 JsonpDeserializer<TKey> tKeyParser,
 JsonpDeserializer<TValue> tValueParser)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object