com.amazonaws.services.cognitoidp.model

Class AdminUserGlobalSignOutRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.AdminUserGlobalSignOutRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AdminUserGlobalSignOutRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

The request to sign out of all devices, as an administrator.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AdminUserGlobalSignOutRequest()

Method Summary

Modifier and Type	Method and Description
AdminUserGlobalSignOutRequest	clone()
boolean	equals(Object obj)
String	getUsername() The username of the user that you want to query or modify.
String	getUserPoolId() The user pool ID.
int	hashCode()
void	setUsername(String username) The username of the user that you want to query or modify.
void	setUserPoolId(String userPoolId) The user pool ID.
String	toString() Returns a string representation of this object.
AdminUserGlobalSignOutRequest	withUsername(String username) The username of the user that you want to query or modify.
AdminUserGlobalSignOutRequest	withUserPoolId(String userPoolId) The user pool ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminUserGlobalSignOutRequest

public AdminUserGlobalSignOutRequest()

Method Detail

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID.

Parameters:

userPoolId - The user pool ID.

getUserPoolId

public String getUserPoolId()

The user pool ID.

Returns:

The user pool ID.

withUserPoolId

public AdminUserGlobalSignOutRequest withUserPoolId(String userPoolId)

The user pool ID.

Parameters:

userPoolId - The user pool ID.

Returns:

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

setUsername

public void setUsername(String username)

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

Parameters:

username - The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

getUsername

public String getUsername()

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

Returns:

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

withUsername

public AdminUserGlobalSignOutRequest withUsername(String username)

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

Parameters:

username - The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

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 AdminUserGlobalSignOutRequest clone()

Overrides:

clone in class AmazonWebServiceRequest