Package co.elastic.clients.elasticsearch.security

Class QueryApiKeysResponse.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<QueryApiKeysResponse.Builder>

co.elastic.clients.elasticsearch.security.QueryApiKeysResponse.Builder

All Implemented Interfaces:

WithJson<QueryApiKeysResponse.Builder>, ObjectBuilder<QueryApiKeysResponse>

Enclosing class:

QueryApiKeysResponse

public static class QueryApiKeysResponse.Builder
extends WithJsonObjectBuilderBase<QueryApiKeysResponse.Builder>
implements ObjectBuilder<QueryApiKeysResponse>

Builder for QueryApiKeysResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final QueryApiKeysResponse.Builder	aggregations(String key, ApiKeyAggregate value)	The aggregations result, if requested.
final QueryApiKeysResponse.Builder	aggregations(String key, Function<ApiKeyAggregate.Builder,ObjectBuilder<ApiKeyAggregate>> fn)	The aggregations result, if requested.
final QueryApiKeysResponse.Builder	aggregations(Map<String,ApiKeyAggregate> map)	The aggregations result, if requested.
final QueryApiKeysResponse.Builder	apiKeys(ApiKey value, ApiKey... values)	Required - A list of API key information.
final QueryApiKeysResponse.Builder	apiKeys(Function<ApiKey.Builder,ObjectBuilder<ApiKey>> fn)	Required - A list of API key information.
final QueryApiKeysResponse.Builder	apiKeys(List<ApiKey> list)	Required - A list of API key information.
QueryApiKeysResponse	build()	Builds a QueryApiKeysResponse.
final QueryApiKeysResponse.Builder	count(int value)	Required - The number of API keys returned in the response.
protected QueryApiKeysResponse.Builder	self()
final QueryApiKeysResponse.Builder	total(int value)	Required - The total number of API keys found.

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

total

public final QueryApiKeysResponse.Builder total(int value)

Required - The total number of API keys found.

API name: total

count

public final QueryApiKeysResponse.Builder count(int value)

Required - The number of API keys returned in the response.

API name: count

apiKeys

public final QueryApiKeysResponse.Builder apiKeys(List<ApiKey> list)

Required - A list of API key information.

API name: api_keys

Adds all elements of list to apiKeys.

apiKeys

public final QueryApiKeysResponse.Builder apiKeys(ApiKey value,
 ApiKey... values)

Required - A list of API key information.

API name: api_keys

Adds one or more values to apiKeys.

apiKeys

public final QueryApiKeysResponse.Builder apiKeys(Function<ApiKey.Builder,ObjectBuilder<ApiKey>> fn)

Required - A list of API key information.

API name: api_keys

Adds a value to apiKeys using a builder lambda.

aggregations

public final QueryApiKeysResponse.Builder aggregations(Map<String,ApiKeyAggregate> map)

The aggregations result, if requested.

API name: aggregations

Adds all entries of map to aggregations.

aggregations

public final QueryApiKeysResponse.Builder aggregations(String key,
 ApiKeyAggregate value)

The aggregations result, if requested.

API name: aggregations

Adds an entry to aggregations.

aggregations

public final QueryApiKeysResponse.Builder aggregations(String key,
 Function<ApiKeyAggregate.Builder,ObjectBuilder<ApiKeyAggregate>> fn)

The aggregations result, if requested.

API name: aggregations

Adds an entry to aggregations using a builder lambda.

self

protected QueryApiKeysResponse.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<QueryApiKeysResponse.Builder>

build

public QueryApiKeysResponse build()

Builds a QueryApiKeysResponse.

Specified by:

build in interface ObjectBuilder<QueryApiKeysResponse>

Throws:

NullPointerException - if some of the required fields are null.