StartDeviceAuthorizationResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.ssooidc.model.StartDeviceAuthorizationResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartDeviceAuthorizationResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartDeviceAuthorizationResult()

Constructors
Constructor and Description
`StartDeviceAuthorizationResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StartDeviceAuthorizationResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDeviceCode()` The short-lived code that is used by the device when polling for a session token.
`Integer`	`getExpiresIn()` Indicates the number of seconds in which the verification code will become invalid.
`Integer`	`getInterval()` Indicates the number of seconds the client must wait between attempts when polling for a session.
`String`	`getUserCode()` A one-time user verification code.
`String`	`getVerificationUri()` The URI of the verification page that takes the `userCode` to authorize the device.
`String`	`getVerificationUriComplete()` An alternate URL that the client can use to automatically launch a browser.
`int`	`hashCode()`
`void`	`setDeviceCode(String deviceCode)` The short-lived code that is used by the device when polling for a session token.
`void`	`setExpiresIn(Integer expiresIn)` Indicates the number of seconds in which the verification code will become invalid.
`void`	`setInterval(Integer interval)` Indicates the number of seconds the client must wait between attempts when polling for a session.
`void`	`setUserCode(String userCode)` A one-time user verification code.
`void`	`setVerificationUri(String verificationUri)` The URI of the verification page that takes the `userCode` to authorize the device.
`void`	`setVerificationUriComplete(String verificationUriComplete)` An alternate URL that the client can use to automatically launch a browser.
`String`	`toString()` Returns a string representation of this object.
`StartDeviceAuthorizationResult`	`withDeviceCode(String deviceCode)` The short-lived code that is used by the device when polling for a session token.
`StartDeviceAuthorizationResult`	`withExpiresIn(Integer expiresIn)` Indicates the number of seconds in which the verification code will become invalid.
`StartDeviceAuthorizationResult`	`withInterval(Integer interval)` Indicates the number of seconds the client must wait between attempts when polling for a session.
`StartDeviceAuthorizationResult`	`withUserCode(String userCode)` A one-time user verification code.
`StartDeviceAuthorizationResult`	`withVerificationUri(String verificationUri)` The URI of the verification page that takes the `userCode` to authorize the device.
`StartDeviceAuthorizationResult`	`withVerificationUriComplete(String verificationUriComplete)` An alternate URL that the client can use to automatically launch a browser.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StartDeviceAuthorizationResult
```
public StartDeviceAuthorizationResult()
```
- Method Detail
  - setDeviceCode
```
public void setDeviceCode(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.
  - getDeviceCode
```
public String getDeviceCode()
```
    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.
  - withDeviceCode
```
public StartDeviceAuthorizationResult withDeviceCode(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.
  - setUserCode
```
public void setUserCode(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.
  - getUserCode
```
public String getUserCode()
```
    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.
  - withUserCode
```
public StartDeviceAuthorizationResult withUserCode(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.
  - setVerificationUri
```
public void setVerificationUri(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.
  - getVerificationUri
```
public String getVerificationUri()
```
    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.
  - withVerificationUri
```
public StartDeviceAuthorizationResult withVerificationUri(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.
  - setVerificationUriComplete
```
public void setVerificationUriComplete(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.
  - getVerificationUriComplete
```
public String getVerificationUriComplete()
```
    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.
  - withVerificationUriComplete
```
public StartDeviceAuthorizationResult withVerificationUriComplete(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.
  - setExpiresIn
```
public void setExpiresIn(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.
  - getExpiresIn
```
public Integer getExpiresIn()
```
    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.
  - withExpiresIn
```
public StartDeviceAuthorizationResult withExpiresIn(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.
  - setInterval
```
public void setInterval(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.
  - getInterval
```
public Integer getInterval()
```
    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.
  - withInterval
```
public StartDeviceAuthorizationResult withInterval(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.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StartDeviceAuthorizationResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.624

Class StartDeviceAuthorizationResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

StartDeviceAuthorizationResult

Method Detail

setDeviceCode

getDeviceCode

withDeviceCode

setUserCode

getUserCode

withUserCode

setVerificationUri

getVerificationUri

withVerificationUri

setVerificationUriComplete

getVerificationUriComplete

withVerificationUriComplete

setExpiresIn

getExpiresIn

withExpiresIn

setInterval

getInterval

withInterval

toString

equals

hashCode

clone