com.amazonaws.services.cognitosync.model

Class SubscribeToDatasetRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitosync.model.SubscribeToDatasetRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class SubscribeToDatasetRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the SubscribeToDataset operation.

Subscribes to receive notifications when a dataset is modified by another device.

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

See Also:

AmazonCognitoSync.subscribeToDataset(SubscribeToDatasetRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SubscribeToDatasetRequest()

Method Summary

Methods

Modifier and Type	Method and Description
SubscribeToDatasetRequest	clone()
boolean	equals(Object obj)
String	getDatasetName() The name of the dataset to subcribe to.
String	getDeviceId() The unique ID generated for this device by Cognito.
String	getIdentityId() 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.
int	hashCode()
void	setDatasetName(String datasetName) The name of the dataset to subcribe to.
void	setDeviceId(String deviceId) The unique ID generated for this device by Cognito.
void	setIdentityId(String identityId) 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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SubscribeToDatasetRequest	withDatasetName(String datasetName) The name of the dataset to subcribe to.
SubscribeToDatasetRequest	withDeviceId(String deviceId) The unique ID generated for this device by Cognito.
SubscribeToDatasetRequest	withIdentityId(String identityId) Unique ID for this identity.
SubscribeToDatasetRequest	withIdentityPoolId(String identityPoolId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, 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

SubscribeToDatasetRequest

public SubscribeToDatasetRequest()

Method Detail

getIdentityPoolId

public String getIdentityPoolId()

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

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

Returns:

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

setIdentityPoolId

public void setIdentityPoolId(String identityPoolId)

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

Constraints:
Length: 1 - 55
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. The ID of the pool to which the identity belongs.

withIdentityPoolId

public SubscribeToDatasetRequest withIdentityPoolId(String identityPoolId)

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

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

Constraints:
Length: 1 - 55
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. The ID of the pool to which the identity belongs.

Returns:

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

getIdentityId

public String getIdentityId()

Unique ID for this identity.

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

Returns:

Unique ID for this identity.

setIdentityId

public void setIdentityId(String identityId)

Unique ID for this identity.

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

Parameters:

identityId - Unique ID for this identity.

withIdentityId

public SubscribeToDatasetRequest withIdentityId(String identityId)

Unique ID for this identity.

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

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

Parameters:

identityId - Unique ID for this identity.

Returns:

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

getDatasetName

public String getDatasetName()

The name of the dataset to subcribe to.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+

Returns:

The name of the dataset to subcribe to.

setDatasetName

public void setDatasetName(String datasetName)

The name of the dataset to subcribe to.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+

Parameters:

datasetName - The name of the dataset to subcribe to.

withDatasetName

public SubscribeToDatasetRequest withDatasetName(String datasetName)

The name of the dataset to subcribe to.

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

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+

Parameters:

datasetName - The name of the dataset to subcribe to.

Returns:

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

getDeviceId

public String getDeviceId()

The unique ID generated for this device by Cognito.

Constraints:
Length: 1 - 256

Returns:

The unique ID generated for this device by Cognito.

setDeviceId

public void setDeviceId(String deviceId)

The unique ID generated for this device by Cognito.

Constraints:
Length: 1 - 256

Parameters:

deviceId - The unique ID generated for this device by Cognito.

withDeviceId

public SubscribeToDatasetRequest withDeviceId(String deviceId)

The unique ID generated for this device by Cognito.

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

Constraints:
Length: 1 - 256

Parameters:

deviceId - The unique ID generated for this device by Cognito.

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

Overrides:

clone in class AmazonWebServiceRequest