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 in a paginated manner. You can optionally
filter the results with a query.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<QueryApiKeysRequest>
Json deserializer forQueryApiKeysRequest
static final Endpoint<QueryApiKeysRequest,
QueryApiKeysResponse, ErrorResponse> Endpoint "security.query_api_keys
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
from()
Starting document offset.static QueryApiKeysRequest
final Query
query()
A query to filter which API keys to return.final List<FieldValue>
Search after definitionvoid
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
final Integer
size()
The number of hits to return.final List<SortOptions>
sort()
Other thanid
, all public fields of an API key are eligible for sorting.final Boolean
Return the snapshot of the owner user's role descriptors associated with the API key.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forQueryApiKeysRequest
-
_ENDPOINT
Endpoint "security.query_api_keys
".
-
-
Method Details
-
of
public static QueryApiKeysRequest of(Function<QueryApiKeysRequest.Builder, ObjectBuilder<QueryApiKeysRequest>> fn) -
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 thesearch_after
parameter.API name:
from
-
query
A query to filter which API keys to return. The query supports a subset of query types, includingmatch_all
,bool
,term
,terms
,ids
,prefix
,wildcard
, andrange
. You can query all public information associated with an API key.API name:
query
-
searchAfter
Search after definitionAPI name:
search_after
-
size
The number of hits to return. By default, you cannot page through more than 10,000 hits using thefrom
andsize
parameters. To page through more hits, use thesearch_after
parameter.API name:
size
-
sort
Other thanid
, all public fields of an API key are eligible for sorting. In addition, sort can also be applied to the_doc
field to sort by index order.API name:
sort
-
withLimitedBy
Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.API name:
with_limited_by
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupQueryApiKeysRequestDeserializer
protected static void setupQueryApiKeysRequestDeserializer(ObjectDeserializer<QueryApiKeysRequest.Builder> op)
-