co.elastic.clients.elasticsearch.security.SamlAuthenticateRequest 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;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
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 co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.String;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: security.saml_authenticate.Request
/**
* Submits a SAML Response message to Elasticsearch for consumption.
*
* @see API
* specification
*/
@JsonpDeserializable
public class SamlAuthenticateRequest extends RequestBase implements JsonpSerializable {
private final String content;
private final List ids;
@Nullable
private final String realm;
// ---------------------------------------------------------------------------------------------
private SamlAuthenticateRequest(Builder builder) {
this.content = ApiTypeHelper.requireNonNull(builder.content, this, "content");
this.ids = ApiTypeHelper.unmodifiableRequired(builder.ids, this, "ids");
this.realm = builder.realm;
}
public static SamlAuthenticateRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The SAML response as it was sent by the user’s browser, usually a
* Base64 encoded XML document.
*
* API name: {@code content}
*/
public final String content() {
return this.content;
}
/**
* Required - A json array with all the valid SAML Request Ids that the caller
* of the API has for the current user.
*
* API name: {@code ids}
*/
public final List ids() {
return this.ids;
}
/**
* The name of the realm that should authenticate the SAML response. Useful in
* cases where many SAML realms are defined.
*
* API name: {@code realm}
*/
@Nullable
public final String realm() {
return this.realm;
}
/**
* 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) {
generator.writeKey("content");
generator.write(this.content);
if (ApiTypeHelper.isDefined(this.ids)) {
generator.writeKey("ids");
generator.writeStartArray();
for (String item0 : this.ids) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.realm != null) {
generator.writeKey("realm");
generator.write(this.realm);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link SamlAuthenticateRequest}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
private String content;
private List ids;
@Nullable
private String realm;
/**
* Required - The SAML response as it was sent by the user’s browser, usually a
* Base64 encoded XML document.
*
* API name: {@code content}
*/
public final Builder content(String value) {
this.content = value;
return this;
}
/**
* Required - A json array with all the valid SAML Request Ids that the caller
* of the API has for the current user.
*
* API name: {@code ids}
*
* Adds all elements of list to ids.
*/
public final Builder ids(List list) {
this.ids = _listAddAll(this.ids, list);
return this;
}
/**
* Required - A json array with all the valid SAML Request Ids that the caller
* of the API has for the current user.
*
* API name: {@code ids}
*
* Adds one or more values to ids.
*/
public final Builder ids(String value, String... values) {
this.ids = _listAdd(this.ids, value, values);
return this;
}
/**
* The name of the realm that should authenticate the SAML response. Useful in
* cases where many SAML realms are defined.
*
* API name: {@code realm}
*/
public final Builder realm(@Nullable String value) {
this.realm = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link SamlAuthenticateRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public SamlAuthenticateRequest build() {
_checkSingleUse();
return new SamlAuthenticateRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link SamlAuthenticateRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, SamlAuthenticateRequest::setupSamlAuthenticateRequestDeserializer);
protected static void setupSamlAuthenticateRequestDeserializer(
ObjectDeserializer op) {
op.add(Builder::content, JsonpDeserializer.stringDeserializer(), "content");
op.add(Builder::ids, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "ids");
op.add(Builder::realm, JsonpDeserializer.stringDeserializer(), "realm");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code security.saml_authenticate}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/security.saml_authenticate",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
return "/_security/saml/authenticate";
},
// Request parameters
request -> {
return Collections.emptyMap();
}, SimpleEndpoint.emptyMap(), true, SamlAuthenticateResponse._DESERIALIZER);
}