UpdateRecordsRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitosync.model.UpdateRecordsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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:

AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

UpdateRecordsRequest()

Constructors
Constructor and Description
`UpdateRecordsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateRecordsRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`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 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateRecordsRequest
```
public UpdateRecordsRequest()
```
- Method Detail
  - 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.
    
    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
```
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.
    
    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
```
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.
    
    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
```
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.
    
    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
```
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.
    
    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
```
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.
    
    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
```
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).
    
    Parameters:
    
    datasetName - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
  - getDatasetName
```
public String 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
```
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).
    
    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
```
public void setDeviceId(String deviceId)
```
    The unique ID generated for this device by Cognito.
    
    Parameters:
    
    deviceId - The unique ID generated for this device by Cognito.
  - getDeviceId
```
public String getDeviceId()
```
    The unique ID generated for this device by Cognito.
    
    Returns:
    
    The unique ID generated for this device by Cognito.
  - withDeviceId
```
public UpdateRecordsRequest withDeviceId(String deviceId)
```
    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
```
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.
    
    Parameters:
    
    recordPatches - A list of patch operations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRecordPatches
```
public UpdateRecordsRequest withRecordPatches(Collection<RecordPatch> recordPatches)
```
    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
```
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.
  - 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.
  - withSyncSessionToken
```
public UpdateRecordsRequest withSyncSessionToken(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    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
```
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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UpdateRecordsRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class UpdateRecordsRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateRecordsRequest

Method Detail

setIdentityPoolId

getIdentityPoolId

withIdentityPoolId

setIdentityId

getIdentityId

withIdentityId

setDatasetName

getDatasetName

withDatasetName

setDeviceId

getDeviceId

withDeviceId

getRecordPatches

setRecordPatches

withRecordPatches

withRecordPatches

setSyncSessionToken

getSyncSessionToken

withSyncSessionToken

setClientContext

getClientContext

withClientContext

toString

equals

hashCode

clone