Class QueryApiKeysRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.security.QueryApiKeysRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<QueryApiKeysRequest>
- Enclosing class:
- QueryApiKeysRequest
public static class QueryApiKeysRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<QueryApiKeysRequest>
Builder for
QueryApiKeysRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description QueryApiKeysRequest
build()
Builds aQueryApiKeysRequest
.QueryApiKeysRequest.Builder
from(java.lang.Integer value)
Starting document offset.QueryApiKeysRequest.Builder
query(Query value)
A query to filter which API keys to return.QueryApiKeysRequest.Builder
query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)
A query to filter which API keys to return.QueryApiKeysRequest.Builder
searchAfter(java.lang.String value, java.lang.String... values)
API name:search_after
QueryApiKeysRequest.Builder
searchAfter(java.util.List<java.lang.String> list)
API name:search_after
QueryApiKeysRequest.Builder
size(java.lang.Integer value)
The number of hits to return.QueryApiKeysRequest.Builder
sort(SortOptions value, SortOptions... values)
API name:sort
QueryApiKeysRequest.Builder
sort(java.util.function.Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)
API name:sort
QueryApiKeysRequest.Builder
sort(java.util.List<SortOptions> list)
API name:sort
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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 the search_after parameter.API name:
from
-
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 keyAPI name:
query
-
query
public final QueryApiKeysRequest.Builder query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)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 keyAPI name:
query
-
searchAfter
API name:search_after
Adds all elements of
list
tosearchAfter
. -
searchAfter
public final QueryApiKeysRequest.Builder searchAfter(java.lang.String value, java.lang.String... values)API name:search_after
Adds one or more values to
searchAfter
. -
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
API name:sort
Adds all elements of
list
tosort
. -
sort
API name:sort
Adds one or more values to
sort
. -
sort
public final QueryApiKeysRequest.Builder sort(java.util.function.Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)API name:sort
Adds a value to
sort
using a builder lambda. -
build
Builds aQueryApiKeysRequest
.- Specified by:
build
in interfaceObjectBuilder<QueryApiKeysRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-