com.amazonaws.services.cognitosync.model

Class UpdateRecordsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitosync.model.UpdateRecordsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateRecordsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UpdateRecords operation.

Posts updates to records and adds and deletes records for a dataset and user.

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

See Also:

AmazonCognitoSync.updateRecords(UpdateRecordsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateRecordsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
UpdateRecordsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getClientContext() Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods.
String	getDatasetName() A string of up to 128 characters.
String	getDeviceId() The unique ID generated for this device by Cognito.
String	getIdentityId() A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
String	getIdentityPoolId() A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
List<RecordPatch>	getRecordPatches() A list of patch operations.
String	getSyncSessionToken() The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.
int	hashCode()
void	setClientContext(String clientContext) Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods.
void	setDatasetName(String datasetName) A string of up to 128 characters.
void	setDeviceId(String deviceId) The unique ID generated for this device by Cognito.
void	setIdentityId(String identityId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
void	setIdentityPoolId(String identityPoolId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
void	setRecordPatches(Collection<RecordPatch> recordPatches) A list of patch operations.
void	setSyncSessionToken(String syncSessionToken) The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateRecordsRequest	withClientContext(String clientContext) Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods.
UpdateRecordsRequest	withDatasetName(String datasetName) A string of up to 128 characters.
UpdateRecordsRequest	withDeviceId(String deviceId) The unique ID generated for this device by Cognito.
UpdateRecordsRequest	withIdentityId(String identityId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
UpdateRecordsRequest	withIdentityPoolId(String identityPoolId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
UpdateRecordsRequest	withRecordPatches(Collection<RecordPatch> recordPatches) A list of patch operations.
UpdateRecordsRequest	withRecordPatches(RecordPatch... recordPatches) A list of patch operations.
UpdateRecordsRequest	withSyncSessionToken(String syncSessionToken) The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateRecordsRequest

public UpdateRecordsRequest()

Method Detail

getIdentityPoolId

public String getIdentityPoolId()

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

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. GUID generation is unique within a region.

setIdentityPoolId

public void setIdentityPoolId(String identityPoolId)

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

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. GUID generation is unique within a region.

withIdentityPoolId

public UpdateRecordsRequest withIdentityPoolId(String identityPoolId)

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

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. GUID generation is unique within a region.

Returns:

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

getIdentityId

public String getIdentityId()

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

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. GUID generation is unique within a region.

setIdentityId

public void setIdentityId(String identityId)

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

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

Parameters:

identityId - A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

withIdentityId

public UpdateRecordsRequest withIdentityId(String identityId)

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

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 - A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Returns:

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

getDatasetName

public String getDatasetName()

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

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

Returns:

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

setDatasetName

public void setDatasetName(String datasetName)

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

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

Parameters:

datasetName - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

withDatasetName

public UpdateRecordsRequest withDatasetName(String datasetName)

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

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 - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

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 UpdateRecordsRequest 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.

getRecordPatches

public List<RecordPatch> getRecordPatches()

A list of patch operations.

Returns:

A list of patch operations.

setRecordPatches

public void setRecordPatches(Collection<RecordPatch> recordPatches)

A list of patch operations.

Parameters:

recordPatches - A list of patch operations.

withRecordPatches

public UpdateRecordsRequest withRecordPatches(RecordPatch... recordPatches)

A list of patch operations.

NOTE: This method appends the values to the existing list (if any). Use setRecordPatches(java.util.Collection) or withRecordPatches(java.util.Collection) if you want to override the existing values.

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

Parameters:

recordPatches - A list of patch operations.

Returns:

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

withRecordPatches

public UpdateRecordsRequest withRecordPatches(Collection<RecordPatch> recordPatches)

A list of patch operations.

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

Parameters:

recordPatches - A list of patch operations.

Returns:

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

getSyncSessionToken

public String getSyncSessionToken()

The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.

Returns:

The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.

setSyncSessionToken

public void setSyncSessionToken(String syncSessionToken)

The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.

Parameters:

syncSessionToken - The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.

withSyncSessionToken

public UpdateRecordsRequest withSyncSessionToken(String syncSessionToken)

The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.

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

Parameters:

syncSessionToken - The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.

Returns:

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

getClientContext

public String getClientContext()

Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.

Returns:

Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.

setClientContext

public void setClientContext(String clientContext)

Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.

Parameters:

clientContext - Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.

withClientContext

public UpdateRecordsRequest withClientContext(String clientContext)

Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.

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

Parameters:

clientContext - Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()