software.amazon.awssdk.services.ssooidc.model

Class StartDeviceAuthorizationResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.ssooidc.model.SsoOidcResponse

software.amazon.awssdk.services.ssooidc.model.StartDeviceAuthorizationResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartDeviceAuthorizationResponse.Builder,StartDeviceAuthorizationResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartDeviceAuthorizationResponse
extends SsoOidcResponse
implements ToCopyableBuilder<StartDeviceAuthorizationResponse.Builder,StartDeviceAuthorizationResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartDeviceAuthorizationResponse.Builder

Method Summary

Modifier and Type	Method and Description
static StartDeviceAuthorizationResponse.Builder	builder()
String	deviceCode() The short-lived code that is used by the device when polling for a session token.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	expiresIn() Indicates the number of seconds in which the verification code will become invalid.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	interval() Indicates the number of seconds the client must wait between attempts when polling for a session.
List<SdkField<?>>	sdkFields()
static Class<? extends StartDeviceAuthorizationResponse.Builder>	serializableBuilderClass()
StartDeviceAuthorizationResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userCode() A one-time user verification code.
String	verificationUri() The URI of the verification page that takes the userCode to authorize the device.
String	verificationUriComplete() An alternate URL that the client can use to automatically launch a browser.

Methods inherited from class software.amazon.awssdk.services.ssooidc.model.SsoOidcResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

deviceCode

public String deviceCode()

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

Returns:

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

userCode

public String userCode()

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

Returns:

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

verificationUri

public String verificationUri()

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

Returns:

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

verificationUriComplete

public 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.

Returns:

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.

expiresIn

public Integer expiresIn()

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

Returns:

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

interval

public Integer interval()

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

Returns:

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

toBuilder

public StartDeviceAuthorizationResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartDeviceAuthorizationResponse.Builder,StartDeviceAuthorizationResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static StartDeviceAuthorizationResponse.Builder builder()

serializableBuilderClass

public static Class<? extends StartDeviceAuthorizationResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo