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>

  • Method Details

    • deviceCode

      public final 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 final 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 final 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 final 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 final 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 final 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()
      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 interface ToCopyableBuilder<StartDeviceAuthorizationResponse.Builder,StartDeviceAuthorizationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static StartDeviceAuthorizationResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.