Package co.elastic.clients.elasticsearch.security

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

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QueryApiKeysRequest	build()	Builds a QueryApiKeysRequest.
final QueryApiKeysRequest.Builder	from(Integer value)	Starting document offset.
final QueryApiKeysRequest.Builder	query(Query value)	A query to filter which API keys to return.
final QueryApiKeysRequest.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	A query to filter which API keys to return.
final QueryApiKeysRequest.Builder	searchAfter(FieldValue value, FieldValue... values)	Search after definition
final QueryApiKeysRequest.Builder	searchAfter(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	Search after definition
final QueryApiKeysRequest.Builder	searchAfter(List<FieldValue> list)	Search after definition
protected QueryApiKeysRequest.Builder	self()
final QueryApiKeysRequest.Builder	size(Integer value)	The number of hits to return.
final QueryApiKeysRequest.Builder	sort(SortOptions value, SortOptions... values)	Other than id, all public fields of an API key are eligible for sorting.
final QueryApiKeysRequest.Builder	sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	Other than id, all public fields of an API key are eligible for sorting.
final QueryApiKeysRequest.Builder	sort(List<SortOptions> list)	Other than id, all public fields of an API key are eligible for sorting.
final QueryApiKeysRequest.Builder	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

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

from

public final QueryApiKeysRequest.Builder from(@Nullable
 Integer value)

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

public final QueryApiKeysRequest.Builder query(@Nullable
 Query value)

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

query

public final QueryApiKeysRequest.Builder query(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 key.

API name: query

searchAfter

public final QueryApiKeysRequest.Builder searchAfter(List<FieldValue> list)

Search after definition

API name: search_after

Adds all elements of list to searchAfter.

searchAfter

public final QueryApiKeysRequest.Builder searchAfter(FieldValue value,
 FieldValue... values)

Search after definition

API name: search_after

Adds one or more values to searchAfter.

searchAfter

public final QueryApiKeysRequest.Builder searchAfter(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

Search after definition

API name: search_after

Adds a value to searchAfter using a builder lambda.

size

public final QueryApiKeysRequest.Builder size(@Nullable
 Integer value)

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 QueryApiKeysRequest.Builder sort(List<SortOptions> list)

Other than id, 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 to sort.

sort

public final QueryApiKeysRequest.Builder sort(SortOptions value,
 SortOptions... values)

Other than id, 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 than id, 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

public final QueryApiKeysRequest.Builder withLimitedBy(@Nullable
 Boolean value)

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

protected QueryApiKeysRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<QueryApiKeysRequest.Builder>

build

public QueryApiKeysRequest build()

Builds a QueryApiKeysRequest.

Specified by:

build in interface ObjectBuilder<QueryApiKeysRequest>

Throws:

NullPointerException - if some of the required fields are null.