Package co.elastic.clients.elasticsearch.security

Class QueryApiKeysRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.QueryApiKeysRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class QueryApiKeysRequest
extends RequestBase
implements JsonpSerializable

Retrieves information for API keys using a subset of query DSL

See Also:

API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<QueryApiKeysRequest>	_DESERIALIZER	Json deserializer for QueryApiKeysRequest
static Endpoint<QueryApiKeysRequest,QueryApiKeysResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.query_api_keys".

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	from()	Starting document offset.
static QueryApiKeysRequest	of(java.util.function.Function<QueryApiKeysRequest.Builder,ObjectBuilder<QueryApiKeysRequest>> fn)
Query	query()	A query to filter which API keys to return.
java.util.List<java.lang.String>	searchAfter()	API name: search_after
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	setupQueryApiKeysRequestDeserializer(ObjectDeserializer<QueryApiKeysRequest.Builder> op)
java.lang.Integer	size()	The number of hits to return.
java.util.List<SortOptions>	sort()	API name: sort

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<QueryApiKeysRequest> _DESERIALIZER

Json deserializer for QueryApiKeysRequest

_ENDPOINT

public static final Endpoint<QueryApiKeysRequest,QueryApiKeysResponse,ErrorResponse> _ENDPOINT

Endpoint "security.query_api_keys".

Method Details

of

public static QueryApiKeysRequest of(java.util.function.Function<QueryApiKeysRequest.Builder,ObjectBuilder<QueryApiKeysRequest>> fn)

from

@Nullable
public final java.lang.Integer from()

Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

API name: from

query

@Nullable
public final Query query()

A query to filter which API keys to return. The query supports a subset of query types, including match_all, bool, term, terms, ids, prefix, wildcard, and range. You can query all public information associated with an API key

API name: query

searchAfter

public final java.util.List<java.lang.String> searchAfter()

API name: search_after

size

@Nullable
public final java.lang.Integer size()

The number of hits to return. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

API name: size

sort

public final java.util.List<SortOptions> sort()

API name: sort

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)

setupQueryApiKeysRequestDeserializer

protected static void setupQueryApiKeysRequestDeserializer(ObjectDeserializer<QueryApiKeysRequest.Builder> op)