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
A request to post updates to records or add and delete records for a dataset
and user.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods.A string of up to 128 characters.The unique ID generated for this device by Cognito.A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.A list of patch operations.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.toString()
Returns a string representation of this object; useful for testing and debugging.withClientContext
(String clientContext) Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods.withDatasetName
(String datasetName) A string of up to 128 characters.withDeviceId
(String deviceId) The unique ID generated for this device by Cognito.withIdentityId
(String identityId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.withIdentityPoolId
(String identityPoolId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.withRecordPatches
(RecordPatch... recordPatches) A list of patch operations.withRecordPatches
(Collection<RecordPatch> recordPatches) A list of patch operations.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, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
UpdateRecordsRequest
public UpdateRecordsRequest()
-
-
Method Details
-
setIdentityPoolId
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.- 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.
-
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.- 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.
-
withIdentityPoolId
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.- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setIdentityId
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.- 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.
-
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.- 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.
-
withIdentityId
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.- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setDatasetName
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).- Parameters:
datasetName
- A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
-
getDatasetName
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).- Returns:
- A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
-
withDatasetName
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).- Parameters:
datasetName
- A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDeviceId
The unique ID generated for this device by Cognito.
- Parameters:
deviceId
- The unique ID generated for this device by Cognito.
-
getDeviceId
The unique ID generated for this device by Cognito.
- Returns:
- The unique ID generated for this device by Cognito.
-
withDeviceId
The unique ID generated for this device by Cognito.
- Parameters:
deviceId
- The unique ID generated for this device by Cognito.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getRecordPatches
A list of patch operations.- Returns:
- A list of patch operations.
-
setRecordPatches
A list of patch operations.- Parameters:
recordPatches
- A list of patch operations.
-
withRecordPatches
A list of patch operations.NOTE: This method appends the values to the existing list (if any). Use
setRecordPatches(java.util.Collection)
orwithRecordPatches(java.util.Collection)
if you want to override the existing values.- Parameters:
recordPatches
- A list of patch operations.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withRecordPatches
A list of patch operations.- Parameters:
recordPatches
- A list of patch operations.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSyncSessionToken
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.
-
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.
-
withSyncSessionToken
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setClientContext
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.
-
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.
-
withClientContext
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-