Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface AuthenticationResultType.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AuthenticationResultType.Builder,AuthenticationResultType>, SdkBuilder<AuthenticationResultType.Builder,AuthenticationResultType>, SdkPojo

Enclosing class:

AuthenticationResultType

public static interface AuthenticationResultType.Builder
extends SdkPojo, CopyableBuilder<AuthenticationResultType.Builder,AuthenticationResultType>

Method Summary

Modifier and Type	Method	Description
AuthenticationResultType.Builder	accessToken(String accessToken)	A valid access token that Amazon Cognito issued to the user who you want to authenticate.
AuthenticationResultType.Builder	expiresIn(Integer expiresIn)	The expiration period of the authentication result in seconds.
AuthenticationResultType.Builder	idToken(String idToken)	The ID token.
default AuthenticationResultType.Builder	newDeviceMetadata(Consumer<NewDeviceMetadataType.Builder> newDeviceMetadata)	The new device metadata from an authentication result.
AuthenticationResultType.Builder	newDeviceMetadata(NewDeviceMetadataType newDeviceMetadata)	The new device metadata from an authentication result.
AuthenticationResultType.Builder	refreshToken(String refreshToken)	The refresh token.
AuthenticationResultType.Builder	tokenType(String tokenType)	The token type.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

accessToken

AuthenticationResultType.Builder accessToken(String accessToken)

A valid access token that Amazon Cognito issued to the user who you want to authenticate.

Parameters:

accessToken - A valid access token that Amazon Cognito issued to the user who you want to authenticate.

Returns:

Returns a reference to this object so that method calls can be chained together.

expiresIn

AuthenticationResultType.Builder expiresIn(Integer expiresIn)

The expiration period of the authentication result in seconds.

Parameters:

expiresIn - The expiration period of the authentication result in seconds.

Returns:

Returns a reference to this object so that method calls can be chained together.

tokenType

AuthenticationResultType.Builder tokenType(String tokenType)

The token type.

Parameters:

tokenType - The token type.

Returns:

Returns a reference to this object so that method calls can be chained together.

refreshToken

AuthenticationResultType.Builder refreshToken(String refreshToken)

The refresh token.

Parameters:

refreshToken - The refresh token.

Returns:

Returns a reference to this object so that method calls can be chained together.

idToken

AuthenticationResultType.Builder idToken(String idToken)

The ID token.

Parameters:

idToken - The ID token.

Returns:

Returns a reference to this object so that method calls can be chained together.

newDeviceMetadata

AuthenticationResultType.Builder newDeviceMetadata(NewDeviceMetadataType newDeviceMetadata)

The new device metadata from an authentication result.

Parameters:

newDeviceMetadata - The new device metadata from an authentication result.

Returns:

Returns a reference to this object so that method calls can be chained together.

newDeviceMetadata

default AuthenticationResultType.Builder newDeviceMetadata(Consumer<NewDeviceMetadataType.Builder> newDeviceMetadata)

The new device metadata from an authentication result.

This is a convenience method that creates an instance of the NewDeviceMetadataType.Builder avoiding the need to create one manually via NewDeviceMetadataType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to newDeviceMetadata(NewDeviceMetadataType).

Parameters:

newDeviceMetadata - a consumer that will call methods on NewDeviceMetadataType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

newDeviceMetadata(NewDeviceMetadataType)