Package co.elastic.clients.elasticsearch.security

Class SamlAuthenticateRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<SamlAuthenticateRequest.Builder>

co.elastic.clients.elasticsearch.security.SamlAuthenticateRequest.Builder

All Implemented Interfaces:

WithJson<SamlAuthenticateRequest.Builder>, ObjectBuilder<SamlAuthenticateRequest>

Enclosing class:

SamlAuthenticateRequest

public static class SamlAuthenticateRequest.Builder
extends RequestBase.AbstractBuilder<SamlAuthenticateRequest.Builder>
implements ObjectBuilder<SamlAuthenticateRequest>

Builder for SamlAuthenticateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SamlAuthenticateRequest	build()	Builds a SamlAuthenticateRequest.
SamlAuthenticateRequest.Builder	content(java.lang.String value)	Required - The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document.
SamlAuthenticateRequest.Builder	ids(java.lang.String value, java.lang.String... values)	Required - A json array with all the valid SAML Request Ids that the caller of the API has for the current user.
SamlAuthenticateRequest.Builder	ids(java.util.List<java.lang.String> list)	Required - A json array with all the valid SAML Request Ids that the caller of the API has for the current user.
SamlAuthenticateRequest.Builder	realm(java.lang.String value)	The name of the realm that should authenticate the SAML response.
protected SamlAuthenticateRequest.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

content

public final SamlAuthenticateRequest.Builder content(java.lang.String value)

Required - The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document.

API name: content

ids

public final SamlAuthenticateRequest.Builder ids(java.util.List<java.lang.String> list)

Required - A json array with all the valid SAML Request Ids that the caller of the API has for the current user.

API name: ids

Adds all elements of list to ids.

ids

public final SamlAuthenticateRequest.Builder ids(java.lang.String value,
java.lang.String... values)

Required - A json array with all the valid SAML Request Ids that the caller of the API has for the current user.

API name: ids

Adds one or more values to ids.

realm

public final SamlAuthenticateRequest.Builder realm(@Nullable
java.lang.String value)

The name of the realm that should authenticate the SAML response. Useful in cases where many SAML realms are defined.

API name: realm

self

protected SamlAuthenticateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SamlAuthenticateRequest.Builder>

build

public SamlAuthenticateRequest build()

Builds a SamlAuthenticateRequest.

Specified by:

build in interface ObjectBuilder<SamlAuthenticateRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.