Package software.amazon.awssdk.services.ssooidc.model

Interface StartDeviceAuthorizationResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<StartDeviceAuthorizationResponse.Builder,StartDeviceAuthorizationResponse>, SdkBuilder<StartDeviceAuthorizationResponse.Builder,StartDeviceAuthorizationResponse>, SdkPojo, SdkResponse.Builder, SsoOidcResponse.Builder

Enclosing class:

StartDeviceAuthorizationResponse

public static interface StartDeviceAuthorizationResponse.Builder
extends SsoOidcResponse.Builder, SdkPojo, CopyableBuilder<StartDeviceAuthorizationResponse.Builder,StartDeviceAuthorizationResponse>

Method Summary

Modifier and Type	Method	Description
StartDeviceAuthorizationResponse.Builder	deviceCode(String deviceCode)	The short-lived code that is used by the device when polling for a session token.
StartDeviceAuthorizationResponse.Builder	expiresIn(Integer expiresIn)	Indicates the number of seconds in which the verification code will become invalid.
StartDeviceAuthorizationResponse.Builder	interval(Integer interval)	Indicates the number of seconds the client must wait between attempts when polling for a session.
StartDeviceAuthorizationResponse.Builder	userCode(String userCode)	A one-time user verification code.
StartDeviceAuthorizationResponse.Builder	verificationUri(String verificationUri)	The URI of the verification page that takes the userCode to authorize the device.
StartDeviceAuthorizationResponse.Builder	verificationUriComplete(String verificationUriComplete)	An alternate URL that the client can use to automatically launch a browser.

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

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.services.ssooidc.model.SsoOidcResponse.Builder

build, responseMetadata, responseMetadata

Method Detail

deviceCode

StartDeviceAuthorizationResponse.Builder deviceCode(String deviceCode)

The short-lived code that is used by the device when polling for a session token.

Parameters:

deviceCode - The short-lived code that is used by the device when polling for a session token.

Returns:

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

userCode

StartDeviceAuthorizationResponse.Builder userCode(String userCode)

A one-time user verification code. This is needed to authorize an in-use device.

Parameters:

userCode - A one-time user verification code. This is needed to authorize an in-use device.

Returns:

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

verificationUri

StartDeviceAuthorizationResponse.Builder verificationUri(String verificationUri)

The URI of the verification page that takes the userCode to authorize the device.

Parameters:

verificationUri - The URI of the verification page that takes the userCode to authorize the device.

Returns:

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

verificationUriComplete

StartDeviceAuthorizationResponse.Builder verificationUriComplete(String verificationUriComplete)

An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.

Parameters:

verificationUriComplete - An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.

Returns:

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

expiresIn

StartDeviceAuthorizationResponse.Builder expiresIn(Integer expiresIn)

Indicates the number of seconds in which the verification code will become invalid.

Parameters:

expiresIn - Indicates the number of seconds in which the verification code will become invalid.

Returns:

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

interval

StartDeviceAuthorizationResponse.Builder interval(Integer interval)

Indicates the number of seconds the client must wait between attempts when polling for a session.

Parameters:

interval - Indicates the number of seconds the client must wait between attempts when polling for a session.

Returns:

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