SamlPrepareAuthenticationRequest.Builder (java-client 8.1.0 API)

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.elasticsearch.security.SamlPrepareAuthenticationRequest.Builder

All Implemented Interfaces:: ObjectBuilder<SamlPrepareAuthenticationRequest>

Enclosing class:: SamlPrepareAuthenticationRequest

public static class SamlPrepareAuthenticationRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<SamlPrepareAuthenticationRequest>

Builder for SamlPrepareAuthenticationRequest.

Constructor Summary

Constructors

Constructor Description

Builder()

Method Summary

Modifier and Type	Method	Description
`SamlPrepareAuthenticationRequest.Builder`	`acs(java.lang.String value)`	The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch.
`SamlPrepareAuthenticationRequest`	`build()`	Builds a `SamlPrepareAuthenticationRequest`.
`SamlPrepareAuthenticationRequest.Builder`	`realm(java.lang.String value)`	The name of the SAML realm in Elasticsearch for which the configuration is used to generate the authentication request.
`SamlPrepareAuthenticationRequest.Builder`	`relayState(java.lang.String value)`	A string that will be included in the redirect URL that this API returns as the RelayState query parameter.

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

Constructor Details
- Builder
  
  public Builder()
Method Details
- acs
  
  public final SamlPrepareAuthenticationRequest.Builder acs(@Nullable java.lang.String value)
  
  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
  
  public final SamlPrepareAuthenticationRequest.Builder realm(@Nullable java.lang.String value)
  
  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
  
  public final SamlPrepareAuthenticationRequest.Builder relayState(@Nullable java.lang.String value)
  
  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
- build
  
  public SamlPrepareAuthenticationRequest build()
  
  Builds a SamlPrepareAuthenticationRequest.
  
  Specified by:
  
  build in interface ObjectBuilder<SamlPrepareAuthenticationRequest>
  
  Throws:
  
  java.lang.NullPointerException - if some of the required fields are null.