Class SamlPrepareAuthenticationRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<SamlPrepareAuthenticationRequest.Builder>
co.elastic.clients.elasticsearch.security.SamlPrepareAuthenticationRequest.Builder
- All Implemented Interfaces:
WithJson<SamlPrepareAuthenticationRequest.Builder>
,ObjectBuilder<SamlPrepareAuthenticationRequest>
- Enclosing class:
- SamlPrepareAuthenticationRequest
public static class SamlPrepareAuthenticationRequest.Builder
extends RequestBase.AbstractBuilder<SamlPrepareAuthenticationRequest.Builder>
implements ObjectBuilder<SamlPrepareAuthenticationRequest>
Builder for
SamlPrepareAuthenticationRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch.build()
Builds aSamlPrepareAuthenticationRequest
.The name of the SAML realm in Elasticsearch for which the configuration is used to generate the authentication request.relayState
(String value) A string that will be included in the redirect URL that this API returns as the RelayState query parameter.protected SamlPrepareAuthenticationRequest.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
acs
The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch. The realm is used to generate the authentication request. You must specify either this parameter or the realm parameter.API name:
acs
-
realm
The name of the SAML realm in Elasticsearch for which the configuration is used to generate the authentication request. You must specify either this parameter or the acs parameter.API name:
realm
-
relayState
A string that will be included in the redirect URL that this API returns as the RelayState query parameter. If the Authentication Request is signed, this value is used as part of the signature computation.API name:
relay_state
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<SamlPrepareAuthenticationRequest.Builder>
-
build
Builds aSamlPrepareAuthenticationRequest
.- Specified by:
build
in interfaceObjectBuilder<SamlPrepareAuthenticationRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-