co.elastic.clients.elasticsearch.security.QueryApiKeysRequest Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.security;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.FieldValue;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.SortOptions;
import co.elastic.clients.elasticsearch.security.query_api_keys.ApiKeyAggregation;
import co.elastic.clients.elasticsearch.security.query_api_keys.ApiKeyQuery;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: security.query_api_keys.Request
/**
* Find API keys with a query.
*
* Get a paginated list of API keys and their information. You can optionally
* filter the results with a query.
*
* @see API
* specification
*/
@JsonpDeserializable
public class QueryApiKeysRequest extends RequestBase implements JsonpSerializable {
private final Map aggregations;
@Nullable
private final Integer from;
@Nullable
private final ApiKeyQuery query;
private final List searchAfter;
@Nullable
private final Integer size;
private final List sort;
@Nullable
private final Boolean withLimitedBy;
@Nullable
private final Boolean withProfileUid;
// ---------------------------------------------------------------------------------------------
private QueryApiKeysRequest(Builder builder) {
this.aggregations = ApiTypeHelper.unmodifiable(builder.aggregations);
this.from = builder.from;
this.query = builder.query;
this.searchAfter = ApiTypeHelper.unmodifiable(builder.searchAfter);
this.size = builder.size;
this.sort = ApiTypeHelper.unmodifiable(builder.sort);
this.withLimitedBy = builder.withLimitedBy;
this.withProfileUid = builder.withProfileUid;
}
public static QueryApiKeysRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Any aggregations to run over the corpus of returned API keys. Aggregations
* and queries work together. Aggregations are computed only on the API keys
* that match the query. This supports only a subset of aggregation types,
* namely: terms, range, date_range,
* missing, cardinality, value_count,
* composite, filter, and filters.
* Additionally, aggregations only run over the same subset of fields that query
* works with.
*
* API name: {@code aggregations}
*/
public final Map aggregations() {
return this.aggregations;
}
/**
* 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: {@code from}
*/
@Nullable
public final Integer from() {
return this.from;
}
/**
* A query to filter which API keys to return. If the query parameter is
* missing, it is equivalent to a match_all query. The query
* supports a subset of query types, including match_all,
* bool, term, terms, match,
* ids, prefix, wildcard,
* exists, range, and
* simple_query_string. You can query the following public
* information associated with an API key: id, type,
* name, creation, expiration,
* invalidated, invalidation, username,
* realm, and metadata.
*
* API name: {@code query}
*/
@Nullable
public final ApiKeyQuery query() {
return this.query;
}
/**
* Search after definition
*
* API name: {@code search_after}
*/
public final List searchAfter() {
return this.searchAfter;
}
/**
* 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: {@code size}
*/
@Nullable
public final Integer size() {
return this.size;
}
/**
* 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: {@code sort}
*/
public final List sort() {
return this.sort;
}
/**
* 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: {@code with_limited_by}
*/
@Nullable
public final Boolean withLimitedBy() {
return this.withLimitedBy;
}
/**
* Determines whether to also retrieve the profile uid, for the API key owner
* principal, if it exists.
*
* API name: {@code with_profile_uid}
*/
@Nullable
public final Boolean withProfileUid() {
return this.withProfileUid;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (ApiTypeHelper.isDefined(this.aggregations)) {
generator.writeKey("aggregations");
generator.writeStartObject();
for (Map.Entry item0 : this.aggregations.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.from != null) {
generator.writeKey("from");
generator.write(this.from);
}
if (this.query != null) {
generator.writeKey("query");
this.query.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.searchAfter)) {
generator.writeKey("search_after");
generator.writeStartArray();
for (FieldValue item0 : this.searchAfter) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.size != null) {
generator.writeKey("size");
generator.write(this.size);
}
if (ApiTypeHelper.isDefined(this.sort)) {
generator.writeKey("sort");
generator.writeStartArray();
for (SortOptions item0 : this.sort) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link QueryApiKeysRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Map aggregations;
@Nullable
private Integer from;
@Nullable
private ApiKeyQuery query;
@Nullable
private List searchAfter;
@Nullable
private Integer size;
@Nullable
private List sort;
@Nullable
private Boolean withLimitedBy;
@Nullable
private Boolean withProfileUid;
/**
* Any aggregations to run over the corpus of returned API keys. Aggregations
* and queries work together. Aggregations are computed only on the API keys
* that match the query. This supports only a subset of aggregation types,
* namely: terms, range, date_range,
* missing, cardinality, value_count,
* composite, filter, and filters.
* Additionally, aggregations only run over the same subset of fields that query
* works with.
*
* API name: {@code aggregations}
*
* Adds all entries of map to aggregations.
*/
public final Builder aggregations(Map map) {
this.aggregations = _mapPutAll(this.aggregations, map);
return this;
}
/**
* Any aggregations to run over the corpus of returned API keys. Aggregations
* and queries work together. Aggregations are computed only on the API keys
* that match the query. This supports only a subset of aggregation types,
* namely: terms, range, date_range,
* missing, cardinality, value_count,
* composite, filter, and filters.
* Additionally, aggregations only run over the same subset of fields that query
* works with.
*
* API name: {@code aggregations}
*
* Adds an entry to aggregations.
*/
public final Builder aggregations(String key, ApiKeyAggregation value) {
this.aggregations = _mapPut(this.aggregations, key, value);
return this;
}
/**
* Any aggregations to run over the corpus of returned API keys. Aggregations
* and queries work together. Aggregations are computed only on the API keys
* that match the query. This supports only a subset of aggregation types,
* namely: terms, range, date_range,
* missing, cardinality, value_count,
* composite, filter, and filters.
* Additionally, aggregations only run over the same subset of fields that query
* works with.
*
* API name: {@code aggregations}
*
* Adds an entry to aggregations using a builder lambda.
*/
public final Builder aggregations(String key,
Function> fn) {
return aggregations(key, fn.apply(new ApiKeyAggregation.Builder()).build());
}
/**
* 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: {@code from}
*/
public final Builder from(@Nullable Integer value) {
this.from = value;
return this;
}
/**
* A query to filter which API keys to return. If the query parameter is
* missing, it is equivalent to a match_all query. The query
* supports a subset of query types, including match_all,
* bool, term, terms, match,
* ids, prefix, wildcard,
* exists, range, and
* simple_query_string. You can query the following public
* information associated with an API key: id, type,
* name, creation, expiration,
* invalidated, invalidation, username,
* realm, and metadata.
*
* API name: {@code query}
*/
public final Builder query(@Nullable ApiKeyQuery value) {
this.query = value;
return this;
}
/**
* A query to filter which API keys to return. If the query parameter is
* missing, it is equivalent to a match_all query. The query
* supports a subset of query types, including match_all,
* bool, term, terms, match,
* ids, prefix, wildcard,
* exists, range, and
* simple_query_string. You can query the following public
* information associated with an API key: id, type,
* name, creation, expiration,
* invalidated, invalidation, username,
* realm, and metadata.
*
* API name: {@code query}
*/
public final Builder query(Function> fn) {
return this.query(fn.apply(new ApiKeyQuery.Builder()).build());
}
/**
* Search after definition
*
* API name: {@code search_after}
*
* Adds all elements of list to searchAfter.
*/
public final Builder searchAfter(List list) {
this.searchAfter = _listAddAll(this.searchAfter, list);
return this;
}
/**
* Search after definition
*
* API name: {@code search_after}
*
* Adds one or more values to searchAfter.
*/
public final Builder searchAfter(FieldValue value, FieldValue... values) {
this.searchAfter = _listAdd(this.searchAfter, value, values);
return this;
}
/**
* Search after definition
*
* API name: {@code search_after}
*
* Adds all passed values to searchAfter.
*/
public final Builder searchAfter(String value, String... values) {
this.searchAfter = _listAdd(this.searchAfter, FieldValue.of(value));
List fieldValues = new ArrayList<>();
for (String v : values) {
fieldValues.add(FieldValue.of(v));
}
this.searchAfter = _listAddAll(this.searchAfter, fieldValues);
return this;
}
/**
* Search after definition
*
* API name: {@code search_after}
*
* Adds all passed values to searchAfter.
*/
public final Builder searchAfter(long value, long... values) {
this.searchAfter = _listAdd(this.searchAfter, FieldValue.of(value));
List fieldValues = new ArrayList<>();
for (long v : values) {
fieldValues.add(FieldValue.of(v));
}
this.searchAfter = _listAddAll(this.searchAfter, fieldValues);
return this;
}
/**
* Search after definition
*
* API name: {@code search_after}
*
* Adds all passed values to searchAfter.
*/
public final Builder searchAfter(double value, double... values) {
this.searchAfter = _listAdd(this.searchAfter, FieldValue.of(value));
List fieldValues = new ArrayList<>();
for (double v : values) {
fieldValues.add(FieldValue.of(v));
}
this.searchAfter = _listAddAll(this.searchAfter, fieldValues);
return this;
}
/**
* Search after definition
*
* API name: {@code search_after}
*
* Adds all passed values to searchAfter.
*/
public final Builder searchAfter(boolean value, boolean... values) {
this.searchAfter = _listAdd(this.searchAfter, FieldValue.of(value));
List fieldValues = new ArrayList<>();
for (boolean v : values) {
fieldValues.add(FieldValue.of(v));
}
this.searchAfter = _listAddAll(this.searchAfter, fieldValues);
return this;
}
/**
* Search after definition
*
* API name: {@code search_after}
*
* Adds a value to searchAfter using a builder lambda.
*/
public final Builder searchAfter(Function> fn) {
return searchAfter(fn.apply(new FieldValue.Builder()).build());
}
/**
* 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: {@code size}
*/
public final Builder size(@Nullable Integer value) {
this.size = value;
return this;
}
/**
* 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: {@code sort}
*
* Adds all elements of list to sort.
*/
public final Builder sort(List list) {
this.sort = _listAddAll(this.sort, list);
return this;
}
/**
* 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: {@code sort}
*
* Adds one or more values to sort.
*/
public final Builder sort(SortOptions value, SortOptions... values) {
this.sort = _listAdd(this.sort, value, values);
return this;
}
/**
* 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: {@code sort}
*
* Adds a value to sort using a builder lambda.
*/
public final Builder sort(Function> fn) {
return sort(fn.apply(new SortOptions.Builder()).build());
}
/**
* 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: {@code with_limited_by}
*/
public final Builder withLimitedBy(@Nullable Boolean value) {
this.withLimitedBy = value;
return this;
}
/**
* Determines whether to also retrieve the profile uid, for the API key owner
* principal, if it exists.
*
* API name: {@code with_profile_uid}
*/
public final Builder withProfileUid(@Nullable Boolean value) {
this.withProfileUid = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link QueryApiKeysRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public QueryApiKeysRequest build() {
_checkSingleUse();
return new QueryApiKeysRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link QueryApiKeysRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, QueryApiKeysRequest::setupQueryApiKeysRequestDeserializer);
protected static void setupQueryApiKeysRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::aggregations, JsonpDeserializer.stringMapDeserializer(ApiKeyAggregation._DESERIALIZER),
"aggregations", "aggs");
op.add(Builder::from, JsonpDeserializer.integerDeserializer(), "from");
op.add(Builder::query, ApiKeyQuery._DESERIALIZER, "query");
op.add(Builder::searchAfter, JsonpDeserializer.arrayDeserializer(FieldValue._DESERIALIZER), "search_after");
op.add(Builder::size, JsonpDeserializer.integerDeserializer(), "size");
op.add(Builder::sort, JsonpDeserializer.arrayDeserializer(SortOptions._DESERIALIZER), "sort");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code security.query_api_keys}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/security.query_api_keys",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
return "/_security/_query/api_key";
},
// Path parameters
request -> {
return Collections.emptyMap();
},
// Request parameters
request -> {
Map params = new HashMap<>();
params.put("typed_keys", "true");
if (request.withProfileUid != null) {
params.put("with_profile_uid", String.valueOf(request.withProfileUid));
}
if (request.withLimitedBy != null) {
params.put("with_limited_by", String.valueOf(request.withLimitedBy));
}
return params;
}, SimpleEndpoint.emptyMap(), true, QueryApiKeysResponse._DESERIALIZER);
}