co.elastic.clients.elasticsearch.security.has_privileges.IndexPrivilegesCheck Maven / Gradle / Ivy
/*
* 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.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.security.has_privileges;
import co.elastic.clients.elasticsearch.security.IndexPrivilege;
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.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: security.has_privileges.IndexPrivilegesCheck
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class IndexPrivilegesCheck implements JsonpSerializable {
private final List names;
private final List privileges;
@Nullable
private final Boolean allowRestrictedIndices;
// ---------------------------------------------------------------------------------------------
private IndexPrivilegesCheck(Builder builder) {
this.names = ApiTypeHelper.unmodifiableRequired(builder.names, this, "names");
this.privileges = ApiTypeHelper.unmodifiableRequired(builder.privileges, this, "privileges");
this.allowRestrictedIndices = builder.allowRestrictedIndices;
}
public static IndexPrivilegesCheck of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - A list of indices.
*
* API name: {@code names}
*/
public final List names() {
return this.names;
}
/**
* Required - A list of the privileges that you want to check for the specified
* indices.
*
* API name: {@code privileges}
*/
public final List privileges() {
return this.privileges;
}
/**
* This needs to be set to true (default is false) if using wildcards or regexps
* for patterns that cover restricted indices. Implicitly, restricted indices do
* not match index patterns because restricted indices usually have limited
* privileges and including them in pattern tests would render most such tests
* false. If restricted indices are explicitly included in the names list,
* privileges will be checked against them regardless of the value of
* allow_restricted_indices.
*
* API name: {@code allow_restricted_indices}
*/
@Nullable
public final Boolean allowRestrictedIndices() {
return this.allowRestrictedIndices;
}
/**
* 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.names)) {
generator.writeKey("names");
generator.writeStartArray();
for (String item0 : this.names) {
generator.write(item0);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.privileges)) {
generator.writeKey("privileges");
generator.writeStartArray();
for (IndexPrivilege item0 : this.privileges) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.allowRestrictedIndices != null) {
generator.writeKey("allow_restricted_indices");
generator.write(this.allowRestrictedIndices);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link IndexPrivilegesCheck}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
private List names;
private List privileges;
@Nullable
private Boolean allowRestrictedIndices;
/**
* Required - A list of indices.
*
* API name: {@code names}
*
* Adds all elements of list to names.
*/
public final Builder names(List list) {
this.names = _listAddAll(this.names, list);
return this;
}
/**
* Required - A list of indices.
*
* API name: {@code names}
*
* Adds one or more values to names.
*/
public final Builder names(String value, String... values) {
this.names = _listAdd(this.names, value, values);
return this;
}
/**
* Required - A list of the privileges that you want to check for the specified
* indices.
*
* API name: {@code privileges}
*
* Adds all elements of list to privileges.
*/
public final Builder privileges(List list) {
this.privileges = _listAddAll(this.privileges, list);
return this;
}
/**
* Required - A list of the privileges that you want to check for the specified
* indices.
*
* API name: {@code privileges}
*
* Adds one or more values to privileges.
*/
public final Builder privileges(IndexPrivilege value, IndexPrivilege... values) {
this.privileges = _listAdd(this.privileges, value, values);
return this;
}
/**
* This needs to be set to true (default is false) if using wildcards or regexps
* for patterns that cover restricted indices. Implicitly, restricted indices do
* not match index patterns because restricted indices usually have limited
* privileges and including them in pattern tests would render most such tests
* false. If restricted indices are explicitly included in the names list,
* privileges will be checked against them regardless of the value of
* allow_restricted_indices.
*
* API name: {@code allow_restricted_indices}
*/
public final Builder allowRestrictedIndices(@Nullable Boolean value) {
this.allowRestrictedIndices = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link IndexPrivilegesCheck}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public IndexPrivilegesCheck build() {
_checkSingleUse();
return new IndexPrivilegesCheck(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link IndexPrivilegesCheck}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, IndexPrivilegesCheck::setupIndexPrivilegesCheckDeserializer);
protected static void setupIndexPrivilegesCheckDeserializer(ObjectDeserializer op) {
op.add(Builder::names, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "names");
op.add(Builder::privileges, JsonpDeserializer.arrayDeserializer(IndexPrivilege._DESERIALIZER), "privileges");
op.add(Builder::allowRestrictedIndices, JsonpDeserializer.booleanDeserializer(), "allow_restricted_indices");
}
}