co.elastic.clients.elasticsearch.security.DisableUserProfileRequest 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.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
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.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
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 co.elastic.clients.util.ObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.String;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: security.disable_user_profile.Request
/**
* Disables a user profile so it's not visible in user profile searches.
*
* @see API
* specification
*/
public class DisableUserProfileRequest extends RequestBase {
@Nullable
private final Refresh refresh;
private final String uid;
// ---------------------------------------------------------------------------------------------
private DisableUserProfileRequest(Builder builder) {
this.refresh = builder.refresh;
this.uid = ApiTypeHelper.requireNonNull(builder.uid, this, "uid");
}
public static DisableUserProfileRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* If 'true', Elasticsearch refreshes 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' do nothing with refreshes.
*
* API name: {@code refresh}
*/
@Nullable
public final Refresh refresh() {
return this.refresh;
}
/**
* Required - Unique identifier for the user profile.
*
* API name: {@code uid}
*/
public final String uid() {
return this.uid;
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DisableUserProfileRequest}.
*/
public static class Builder extends ObjectBuilderBase implements ObjectBuilder {
@Nullable
private Refresh refresh;
private String uid;
/**
* If 'true', Elasticsearch refreshes 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' do nothing with refreshes.
*
* API name: {@code refresh}
*/
public final Builder refresh(@Nullable Refresh value) {
this.refresh = value;
return this;
}
/**
* Required - Unique identifier for the user profile.
*
* API name: {@code uid}
*/
public final Builder uid(String value) {
this.uid = value;
return this;
}
/**
* Builds a {@link DisableUserProfileRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DisableUserProfileRequest build() {
_checkSingleUse();
return new DisableUserProfileRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code security.disable_user_profile}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/security.disable_user_profile",
// Request method
request -> {
return "PUT";
},
// Request path
request -> {
final int _uid = 1 << 0;
int propsSet = 0;
propsSet |= _uid;
if (propsSet == (_uid)) {
StringBuilder buf = new StringBuilder();
buf.append("/_security");
buf.append("/profile");
buf.append("/");
SimpleEndpoint.pathEncode(request.uid, buf);
buf.append("/_disable");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.refresh != null) {
params.put("refresh", request.refresh.jsonValue());
}
return params;
}, SimpleEndpoint.emptyMap(), false, DisableUserProfileResponse._DESERIALIZER);
}