co.elastic.clients.elasticsearch.security.PutPrivilegesRequest Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* 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.elasticsearch.security.put_privileges.Actions;
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 jakarta.json.stream.JsonParser;
import java.lang.String;
import java.util.Collections;
import java.util.HashMap;
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_privileges.Request
/**
* Create or update application privileges.
*
* To use this API, you must have one of the following privileges:
*
* - The
manage_security cluster privilege (or a greater
* privilege such as all).
* - The "Manage Application Privileges" global privilege for the
* application being referenced in the request.
*
*
* Application names are formed from a prefix, with an optional suffix that
* conform to the following rules:
*
* - The prefix must begin with a lowercase ASCII letter.
* - The prefix must contain only ASCII letters or digits.
* - The prefix must be at least 3 characters long.
* - If the suffix exists, it must begin with either a dash
- or
* _.
* - The suffix cannot contain any of the following characters:
*
\, /, *, ?,
* ", <, >, |,
* ,, *.
* - No part of the name can contain whitespace.
*
*
* Privilege names must begin with a lowercase ASCII letter and must contain
* only ASCII letters and digits along with the characters _,
* -, and ..
*
* Action names can contain any number of printable ASCII characters and must
* contain at least one of the following characters: /,
* *, :.
*
* @see API
* specification
*/
@JsonpDeserializable
public class PutPrivilegesRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final Refresh refresh;
private final Map> privileges;
// ---------------------------------------------------------------------------------------------
private PutPrivilegesRequest(Builder builder) {
this.refresh = builder.refresh;
this.privileges = ApiTypeHelper.unmodifiableRequired(builder.privileges, this, "privileges");
}
public static PutPrivilegesRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* 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;
}
/**
* Required - Request body.
*/
public final Map> privileges() {
return this.privileges;
}
/**
* Get an element of {@code privileges}.
*/
public final @Nullable Map get(String key) {
return this.privileges.get(key);
}
/**
* Serialize this value to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
for (Map.Entry> item0 : this.privileges.entrySet()) {
generator.writeKey(item0.getKey());
generator.writeStartObject();
if (item0.getValue() != null) {
for (Map.Entry item1 : item0.getValue().entrySet()) {
generator.writeKey(item1.getKey());
item1.getValue().serialize(generator, mapper);
}
}
generator.writeEnd();
}
generator.writeEnd();
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link PutPrivilegesRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private Refresh refresh;
private Map> privileges = new HashMap<>();
/**
* 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;
}
/**
* Required - Request body.
*
* Adds all entries of map to privileges.
*/
public final Builder privileges(Map> map) {
this.privileges = _mapPutAll(this.privileges, map);
return this;
}
/**
* Required - Request body.
*
* Adds an entry to privileges.
*/
public final Builder privileges(String key, Map value) {
this.privileges = _mapPut(this.privileges, key, value);
return this;
}
@Override
public Builder withJson(JsonParser parser, JsonpMapper mapper) {
@SuppressWarnings("unchecked")
Map> value = (Map>) JsonpDeserializer
.stringMapDeserializer(JsonpDeserializer.stringMapDeserializer(Actions._DESERIALIZER))
.deserialize(parser, mapper);
return this.privileges(value);
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link PutPrivilegesRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public PutPrivilegesRequest build() {
_checkSingleUse();
return new PutPrivilegesRequest(this);
}
}
public static final JsonpDeserializer _DESERIALIZER = createPutPrivilegesRequestDeserializer();
protected static JsonpDeserializer createPutPrivilegesRequestDeserializer() {
JsonpDeserializer>> valueDeserializer = JsonpDeserializer
.stringMapDeserializer(JsonpDeserializer.stringMapDeserializer(Actions._DESERIALIZER));
return JsonpDeserializer.of(valueDeserializer.acceptedEvents(), (parser, mapper, event) -> new Builder()
.privileges(valueDeserializer.deserialize(parser, mapper, event)).build());
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code security.put_privileges}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/security.put_privileges",
// Request method
request -> {
return "PUT";
},
// Request path
request -> {
return "/_security/privilege";
},
// Path parameters
request -> {
return Collections.emptyMap();
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.refresh != null) {
params.put("refresh", request.refresh.jsonValue());
}
return params;
}, SimpleEndpoint.emptyMap(), true, PutPrivilegesResponse._DESERIALIZER);
}