co.elastic.clients.elasticsearch.security.query_role.QueryRole 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.query_role;
import co.elastic.clients.elasticsearch._types.FieldValue;
import co.elastic.clients.elasticsearch.security.RoleDescriptor;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import java.lang.String;
import java.util.ArrayList;
import java.util.List;
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_role.QueryRole
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class QueryRole extends RoleDescriptor {
private final List sort;
private final String name;
// ---------------------------------------------------------------------------------------------
private QueryRole(Builder builder) {
super(builder);
this.sort = ApiTypeHelper.unmodifiable(builder.sort);
this.name = ApiTypeHelper.requireNonNull(builder.name, this, "name");
}
public static QueryRole of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* API name: {@code _sort}
*/
public final List sort() {
return this.sort;
}
/**
* Required - Name of the role.
*
* API name: {@code name}
*/
public final String name() {
return this.name;
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
super.serializeInternal(generator, mapper);
if (ApiTypeHelper.isDefined(this.sort)) {
generator.writeKey("_sort");
generator.writeStartArray();
for (FieldValue item0 : this.sort) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
generator.writeKey("name");
generator.write(this.name);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link QueryRole}.
*/
public static class Builder extends RoleDescriptor.AbstractBuilder implements ObjectBuilder {
@Nullable
private List sort;
private String name;
/**
* 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;
}
/**
* API name: {@code _sort}
*
* Adds one or more values to sort
.
*/
public final Builder sort(FieldValue value, FieldValue... values) {
this.sort = _listAdd(this.sort, value, values);
return this;
}
/**
* API name: {@code _sort}
*
* Adds all passed values to sort
.
*/
public final Builder sort(String value, String... values) {
this.sort = _listAdd(this.sort, FieldValue.of(value));
List fieldValues = new ArrayList<>();
for (String v : values) {
fieldValues.add(FieldValue.of(v));
}
this.sort = _listAddAll(this.sort, fieldValues);
return this;
}
/**
* API name: {@code _sort}
*
* Adds all passed values to sort
.
*/
public final Builder sort(long value, long... values) {
this.sort = _listAdd(this.sort, FieldValue.of(value));
List fieldValues = new ArrayList<>();
for (long v : values) {
fieldValues.add(FieldValue.of(v));
}
this.sort = _listAddAll(this.sort, fieldValues);
return this;
}
/**
* API name: {@code _sort}
*
* Adds all passed values to sort
.
*/
public final Builder sort(double value, double... values) {
this.sort = _listAdd(this.sort, FieldValue.of(value));
List fieldValues = new ArrayList<>();
for (double v : values) {
fieldValues.add(FieldValue.of(v));
}
this.sort = _listAddAll(this.sort, fieldValues);
return this;
}
/**
* API name: {@code _sort}
*
* Adds all passed values to sort
.
*/
public final Builder sort(boolean value, boolean... values) {
this.sort = _listAdd(this.sort, FieldValue.of(value));
List fieldValues = new ArrayList<>();
for (boolean v : values) {
fieldValues.add(FieldValue.of(v));
}
this.sort = _listAddAll(this.sort, fieldValues);
return this;
}
/**
* API name: {@code _sort}
*
* Adds a value to sort
using a builder lambda.
*/
public final Builder sort(Function> fn) {
return sort(fn.apply(new FieldValue.Builder()).build());
}
/**
* Required - Name of the role.
*
* API name: {@code name}
*/
public final Builder name(String value) {
this.name = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link QueryRole}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public QueryRole build() {
_checkSingleUse();
return new QueryRole(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link QueryRole}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
QueryRole::setupQueryRoleDeserializer);
protected static void setupQueryRoleDeserializer(ObjectDeserializer op) {
RoleDescriptor.setupRoleDescriptorDeserializer(op);
op.add(Builder::sort, JsonpDeserializer.arrayDeserializer(FieldValue._DESERIALIZER), "_sort");
op.add(Builder::name, JsonpDeserializer.stringDeserializer(), "name");
}
}