Package co.elastic.clients.elasticsearch.security

Class QueryApiKeysResponse

java.lang.Object

co.elastic.clients.elasticsearch.security.QueryApiKeysResponse

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class QueryApiKeysResponse
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryApiKeysResponse.Builder	Builder for QueryApiKeysResponse.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<QueryApiKeysResponse>	_DESERIALIZER	Json deserializer for QueryApiKeysResponse

Method Summary

Modifier and Type	Method	Description
final Map<String,ApiKeyAggregate>	aggregations()	The aggregations result, if requested.
final List<ApiKey>	apiKeys()	Required - A list of API key information.
final int	count()	Required - The number of API keys returned in the response.
static QueryApiKeysResponse	of(Function<QueryApiKeysResponse.Builder,ObjectBuilder<QueryApiKeysResponse>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupQueryApiKeysResponseDeserializer(ObjectDeserializer<QueryApiKeysResponse.Builder> op)
String	toString()
final int	total()	Required - The total number of API keys found.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<QueryApiKeysResponse> _DESERIALIZER

Json deserializer for QueryApiKeysResponse

Method Details

of

public static QueryApiKeysResponse of(Function<QueryApiKeysResponse.Builder,ObjectBuilder<QueryApiKeysResponse>> fn)

total

public final int total()

Required - The total number of API keys found.

API name: total

count

public final int count()

Required - The number of API keys returned in the response.

API name: count

apiKeys

public final List<ApiKey> apiKeys()

Required - A list of API key information.

API name: api_keys

aggregations

public final Map<String,ApiKeyAggregate> aggregations()

The aggregations result, if requested.

API name: aggregations

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

toString

public String toString()

Overrides:

toString in class Object

setupQueryApiKeysResponseDeserializer

protected static void setupQueryApiKeysResponseDeserializer(ObjectDeserializer<QueryApiKeysResponse.Builder> op)