co.elastic.clients.elasticsearch.security.PutRoleMappingRequest 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.
*/
package co.elastic.clients.elasticsearch.security;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.Refresh;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.json.JsonData;
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.String;
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.put_role_mapping.Request
/**
* Create or update role mappings.
*
* Role mappings define which roles are assigned to each user. Each mapping has
* rules that identify users and a list of roles that are granted to those
* users. The role mapping APIs are generally the preferred way to manage role
* mappings rather than using role mapping files. The create or update role
* mappings API cannot update role mappings that are defined in role mapping
* files.
*
* This API does not create roles. Rather, it maps users to existing roles.
* Roles can be created by using the create or update roles API or roles files.
*
* @see API
* specification
*/
@JsonpDeserializable
public class PutRoleMappingRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final Boolean enabled;
private final Map metadata;
private final String name;
@Nullable
private final Refresh refresh;
private final List roleTemplates;
private final List roles;
@Nullable
private final RoleMappingRule rules;
private final List runAs;
// ---------------------------------------------------------------------------------------------
private PutRoleMappingRequest(Builder builder) {
this.enabled = builder.enabled;
this.metadata = ApiTypeHelper.unmodifiable(builder.metadata);
this.name = ApiTypeHelper.requireNonNull(builder.name, this, "name");
this.refresh = builder.refresh;
this.roleTemplates = ApiTypeHelper.unmodifiable(builder.roleTemplates);
this.roles = ApiTypeHelper.unmodifiable(builder.roles);
this.rules = builder.rules;
this.runAs = ApiTypeHelper.unmodifiable(builder.runAs);
}
public static PutRoleMappingRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* API name: {@code enabled}
*/
@Nullable
public final Boolean enabled() {
return this.enabled;
}
/**
* API name: {@code metadata}
*/
public final Map metadata() {
return this.metadata;
}
/**
* Required - Role-mapping name
*
* API name: {@code name}
*/
public final String name() {
return this.name;
}
/**
* If true (the default) then refresh the affected shards to make
* this operation visible to search, if wait_for then wait for a
* refresh to make this operation visible to search, if false then
* do nothing with refreshes.
*
* API name: {@code refresh}
*/
@Nullable
public final Refresh refresh() {
return this.refresh;
}
/**
* API name: {@code role_templates}
*/
public final List roleTemplates() {
return this.roleTemplates;
}
/**
* API name: {@code roles}
*/
public final List roles() {
return this.roles;
}
/**
* API name: {@code rules}
*/
@Nullable
public final RoleMappingRule rules() {
return this.rules;
}
/**
* API name: {@code run_as}
*/
public final List runAs() {
return this.runAs;
}
/**
* 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 (this.enabled != null) {
generator.writeKey("enabled");
generator.write(this.enabled);
}
if (ApiTypeHelper.isDefined(this.metadata)) {
generator.writeKey("metadata");
generator.writeStartObject();
for (Map.Entry item0 : this.metadata.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.roleTemplates)) {
generator.writeKey("role_templates");
generator.writeStartArray();
for (RoleTemplate item0 : this.roleTemplates) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.roles)) {
generator.writeKey("roles");
generator.writeStartArray();
for (String item0 : this.roles) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.rules != null) {
generator.writeKey("rules");
this.rules.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.runAs)) {
generator.writeKey("run_as");
generator.writeStartArray();
for (String item0 : this.runAs) {
generator.write(item0);
}
generator.writeEnd();
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link PutRoleMappingRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Boolean enabled;
@Nullable
private Map metadata;
private String name;
@Nullable
private Refresh refresh;
@Nullable
private List roleTemplates;
@Nullable
private List roles;
@Nullable
private RoleMappingRule rules;
@Nullable
private List runAs;
/**
* API name: {@code enabled}
*/
public final Builder enabled(@Nullable Boolean value) {
this.enabled = value;
return this;
}
/**
* API name: {@code metadata}
*
* Adds all entries of map to metadata.
*/
public final Builder metadata(Map map) {
this.metadata = _mapPutAll(this.metadata, map);
return this;
}
/**
* API name: {@code metadata}
*
* Adds an entry to metadata.
*/
public final Builder metadata(String key, JsonData value) {
this.metadata = _mapPut(this.metadata, key, value);
return this;
}
/**
* Required - Role-mapping name
*
* API name: {@code name}
*/
public final Builder name(String value) {
this.name = value;
return this;
}
/**
* If true (the default) then refresh the affected shards to make
* this operation visible to search, if wait_for then wait for a
* refresh to make this operation visible to search, if false then
* do nothing with refreshes.
*
* API name: {@code refresh}
*/
public final Builder refresh(@Nullable Refresh value) {
this.refresh = value;
return this;
}
/**
* API name: {@code role_templates}
*
* Adds all elements of list to roleTemplates.
*/
public final Builder roleTemplates(List list) {
this.roleTemplates = _listAddAll(this.roleTemplates, list);
return this;
}
/**
* API name: {@code role_templates}
*
* Adds one or more values to roleTemplates.
*/
public final Builder roleTemplates(RoleTemplate value, RoleTemplate... values) {
this.roleTemplates = _listAdd(this.roleTemplates, value, values);
return this;
}
/**
* API name: {@code role_templates}
*
* Adds a value to roleTemplates using a builder lambda.
*/
public final Builder roleTemplates(Function> fn) {
return roleTemplates(fn.apply(new RoleTemplate.Builder()).build());
}
/**
* API name: {@code roles}
*
* Adds all elements of list to roles.
*/
public final Builder roles(List list) {
this.roles = _listAddAll(this.roles, list);
return this;
}
/**
* API name: {@code roles}
*
* Adds one or more values to roles.
*/
public final Builder roles(String value, String... values) {
this.roles = _listAdd(this.roles, value, values);
return this;
}
/**
* API name: {@code rules}
*/
public final Builder rules(@Nullable RoleMappingRule value) {
this.rules = value;
return this;
}
/**
* API name: {@code rules}
*/
public final Builder rules(Function> fn) {
return this.rules(fn.apply(new RoleMappingRule.Builder()).build());
}
/**
* API name: {@code run_as}
*
* Adds all elements of list to runAs.
*/
public final Builder runAs(List list) {
this.runAs = _listAddAll(this.runAs, list);
return this;
}
/**
* API name: {@code run_as}
*
* Adds one or more values to runAs.
*/
public final Builder runAs(String value, String... values) {
this.runAs = _listAdd(this.runAs, value, values);
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link PutRoleMappingRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public PutRoleMappingRequest build() {
_checkSingleUse();
return new PutRoleMappingRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link PutRoleMappingRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, PutRoleMappingRequest::setupPutRoleMappingRequestDeserializer);
protected static void setupPutRoleMappingRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::enabled, JsonpDeserializer.booleanDeserializer(), "enabled");
op.add(Builder::metadata, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER), "metadata");
op.add(Builder::roleTemplates, JsonpDeserializer.arrayDeserializer(RoleTemplate._DESERIALIZER),
"role_templates");
op.add(Builder::roles, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "roles");
op.add(Builder::rules, RoleMappingRule._DESERIALIZER, "rules");
op.add(Builder::runAs, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "run_as");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code security.put_role_mapping}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/security.put_role_mapping",
// Request method
request -> {
return "PUT";
},
// Request path
request -> {
final int _name = 1 << 0;
int propsSet = 0;
propsSet |= _name;
if (propsSet == (_name)) {
StringBuilder buf = new StringBuilder();
buf.append("/_security");
buf.append("/role_mapping");
buf.append("/");
SimpleEndpoint.pathEncode(request.name, buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Path parameters
request -> {
Map params = new HashMap<>();
final int _name = 1 << 0;
int propsSet = 0;
propsSet |= _name;
if (propsSet == (_name)) {
params.put("name", request.name);
}
return params;
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.refresh != null) {
params.put("refresh", request.refresh.jsonValue());
}
return params;
}, SimpleEndpoint.emptyMap(), true, PutRoleMappingResponse._DESERIALIZER);
}