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("software.amazon.awssdk:codegen")
public final class StartDeviceAuthorizationResponse
extends SsoOidcResponse
implements ToCopyableBuilder<StartDeviceAuthorizationResponse.Builder,StartDeviceAuthorizationResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The short-lived code that is used by the device when polling for a session token.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
Indicates the number of seconds in which the verification code will become invalid.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final Integer
interval()
Indicates the number of seconds the client must wait between attempts when polling for a session.static Class
<? extends StartDeviceAuthorizationResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userCode()
A one-time user verification code.final String
The URI of the verification page that takes theuserCode
to authorize the device.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StartDeviceAuthorizationResponse.Builder,
StartDeviceAuthorizationResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-