Package co.elastic.clients.elasticsearch.security

Class SamlAuthenticateResponse.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<SamlAuthenticateResponse.Builder>

co.elastic.clients.elasticsearch.security.SamlAuthenticateResponse.Builder

All Implemented Interfaces:

WithJson<SamlAuthenticateResponse.Builder>, ObjectBuilder<SamlAuthenticateResponse>

Enclosing class:

SamlAuthenticateResponse

public static class SamlAuthenticateResponse.Builder
extends WithJsonObjectBuilderBase<SamlAuthenticateResponse.Builder>
implements ObjectBuilder<SamlAuthenticateResponse>

Builder for SamlAuthenticateResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final SamlAuthenticateResponse.Builder	accessToken(String value)	Required - The access token that was generated by Elasticsearch.
SamlAuthenticateResponse	build()	Builds a SamlAuthenticateResponse.
final SamlAuthenticateResponse.Builder	expiresIn(int value)	Required - The amount of time (in seconds) left until the token expires.
final SamlAuthenticateResponse.Builder	realm(String value)	Required - The name of the realm where the user was authenticated.
final SamlAuthenticateResponse.Builder	refreshToken(String value)	Required - The refresh token that was generated by Elasticsearch.
protected SamlAuthenticateResponse.Builder	self()
final SamlAuthenticateResponse.Builder	username(String value)	Required - The authenticated user's name.

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

accessToken

public final SamlAuthenticateResponse.Builder accessToken(String value)

Required - The access token that was generated by Elasticsearch.

API name: access_token

username

public final SamlAuthenticateResponse.Builder username(String value)

Required - The authenticated user's name.

API name: username

expiresIn

public final SamlAuthenticateResponse.Builder expiresIn(int value)

Required - The amount of time (in seconds) left until the token expires.

API name: expires_in

refreshToken

public final SamlAuthenticateResponse.Builder refreshToken(String value)

Required - The refresh token that was generated by Elasticsearch.

API name: refresh_token

realm

public final SamlAuthenticateResponse.Builder realm(String value)

Required - The name of the realm where the user was authenticated.

API name: realm

self

protected SamlAuthenticateResponse.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<SamlAuthenticateResponse.Builder>

build

public SamlAuthenticateResponse build()

Builds a SamlAuthenticateResponse.

Specified by:

build in interface ObjectBuilder<SamlAuthenticateResponse>

Throws:

NullPointerException - if some of the required fields are null.