Class QueryApiKeysRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<QueryApiKeysRequest.Builder>
co.elastic.clients.elasticsearch.security.QueryApiKeysRequest.Builder
- All Implemented Interfaces:
WithJson<QueryApiKeysRequest.Builder>
,ObjectBuilder<QueryApiKeysRequest>
- Enclosing class:
- QueryApiKeysRequest
public static class QueryApiKeysRequest.Builder
extends RequestBase.AbstractBuilder<QueryApiKeysRequest.Builder>
implements ObjectBuilder<QueryApiKeysRequest>
Builder for
QueryApiKeysRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aQueryApiKeysRequest
.Starting document offset.A query to filter which API keys to return.A query to filter which API keys to return.searchAfter
(FieldValue value, FieldValue... values) Search after definitionSearch after definitionsearchAfter
(List<FieldValue> list) Search after definitionprotected QueryApiKeysRequest.Builder
self()
The number of hits to return.sort
(SortOptions value, SortOptions... values) Other thanid
, all public fields of an API key are eligible for sorting.Other thanid
, all public fields of an API key are eligible for sorting.sort
(List<SortOptions> list) Other thanid
, all public fields of an API key are eligible for sorting.withLimitedBy
(Boolean value) Return the snapshot of the owner user's role descriptors associated with the API key.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
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
Adds all elements of
list
tosearchAfter
. -
searchAfter
Search after definitionAPI name:
search_after
Adds one or more values to
searchAfter
. -
searchAfter
public final QueryApiKeysRequest.Builder searchAfter(Function<FieldValue.Builder, ObjectBuilder<FieldValue>> fn) Search after definitionAPI name:
search_after
Adds a value to
searchAfter
using a builder lambda. -
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
Adds all elements of
list
tosort
. -
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
Adds one or more values to
sort
. -
sort
public final QueryApiKeysRequest.Builder sort(Function<SortOptions.Builder, ObjectBuilder<SortOptions>> fn) 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
Adds a value to
sort
using a builder lambda. -
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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<QueryApiKeysRequest.Builder>
-
build
Builds aQueryApiKeysRequest
.- Specified by:
build
in interfaceObjectBuilder<QueryApiKeysRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-