com.amazonaws.services.cognitosync.model

Class RegisterDeviceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitosync.model.RegisterDeviceRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RegisterDeviceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RegisterDevice operation.

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

See Also:

AmazonCognitoSync.registerDevice(RegisterDeviceRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterDeviceRequest()

Method Summary

Methods

Modifier and Type	Method and Description
RegisterDeviceRequest	clone()
boolean	equals(Object obj)
String	getIdentityId() The unique ID for this identity.
String	getIdentityPoolId() A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
String	getPlatform() The SNS platform type (e.g.
String	getToken() The push token.
int	hashCode()
void	setIdentityId(String identityId) The unique ID for this identity.
void	setIdentityPoolId(String identityPoolId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
void	setPlatform(Platform platform) The SNS platform type (e.g.
void	setPlatform(String platform) The SNS platform type (e.g.
void	setToken(String token) The push token.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RegisterDeviceRequest	withIdentityId(String identityId) The unique ID for this identity.
RegisterDeviceRequest	withIdentityPoolId(String identityPoolId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
RegisterDeviceRequest	withPlatform(Platform platform) The SNS platform type (e.g.
RegisterDeviceRequest	withPlatform(String platform) The SNS platform type (e.g.
RegisterDeviceRequest	withToken(String token) The push token.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisterDeviceRequest

public RegisterDeviceRequest()

Method Detail

getIdentityPoolId

public String getIdentityPoolId()

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Returns:

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.

setIdentityPoolId

public void setIdentityPoolId(String identityPoolId)

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId - A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.

withIdentityPoolId

public RegisterDeviceRequest withIdentityPoolId(String identityPoolId)

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.

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

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId - A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.

Returns:

A reference to this updated object so that method calls can be chained together.

getIdentityId

public String getIdentityId()

The unique ID for this identity.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Returns:

The unique ID for this identity.

setIdentityId

public void setIdentityId(String identityId)

The unique ID for this identity.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityId - The unique ID for this identity.

withIdentityId

public RegisterDeviceRequest withIdentityId(String identityId)

The unique ID for this identity.

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

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityId - The unique ID for this identity.

Returns:

A reference to this updated object so that method calls can be chained together.

getPlatform

public String getPlatform()

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

Constraints:
Allowed Values: APNS, APNS_SANDBOX, GCM, ADM

Returns:

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

See Also:

Platform

setPlatform

public void setPlatform(String platform)

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

Constraints:
Allowed Values: APNS, APNS_SANDBOX, GCM, ADM

Parameters:

platform - The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

See Also:

Platform

withPlatform

public RegisterDeviceRequest withPlatform(String platform)

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

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

Constraints:
Allowed Values: APNS, APNS_SANDBOX, GCM, ADM

Parameters:

platform - The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Platform

setPlatform

public void setPlatform(Platform platform)

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

Constraints:
Allowed Values: APNS, APNS_SANDBOX, GCM, ADM

Parameters:

platform - The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

See Also:

Platform

withPlatform

public RegisterDeviceRequest withPlatform(Platform platform)

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

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

Constraints:
Allowed Values: APNS, APNS_SANDBOX, GCM, ADM

Parameters:

platform - The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Platform

getToken

public String getToken()

The push token.

Returns:

The push token.

setToken

public void setToken(String token)

The push token.

Parameters:

token - The push token.

withToken

public RegisterDeviceRequest withToken(String token)

The push token.

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

Parameters:

token - The push token.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public RegisterDeviceRequest clone()

Overrides:

clone in class AmazonWebServiceRequest