java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cognitosync.model.CognitoSyncRequest
    - - software.amazon.awssdk.services.cognitosync.model.UpdateRecordsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateRecordsRequest.Builder,UpdateRecordsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateRecordsRequest
extends CognitoSyncRequest
implements ToCopyableBuilder<UpdateRecordsRequest.Builder,UpdateRecordsRequest>

A request to post updates to records or add and delete records for a dataset and user.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateRecordsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static UpdateRecordsRequest.Builder`	`builder()`
`String`	`clientContext()`	Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods.
`String`	`datasetName()`	A string of up to 128 characters.
`String`	`deviceId()`	The unique ID generated for this device by Cognito.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasRecordPatches()`	For responses, this returns true if the service returned a value for the RecordPatches property.
`String`	`identityId()`	A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
`String`	`identityPoolId()`	A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
`List<RecordPatch>`	`recordPatches()`	A list of patch operations.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateRecordsRequest.Builder>`	`serializableBuilderClass()`
`String`	`syncSessionToken()`	The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.
`UpdateRecordsRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - identityPoolId
```
public final 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 name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
  - identityId
```
public final 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 name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
  - datasetName
```
public final String datasetName()
```
    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).
  - deviceId
```
public final String deviceId()
```
    The unique ID generated for this device by Cognito.
    
    Returns:
    
    The unique ID generated for this device by Cognito.
  - hasRecordPatches
```
public final boolean hasRecordPatches()
```
    For responses, this returns true if the service returned a value for the RecordPatches property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - recordPatches
```
public final List<RecordPatch> recordPatches()
```
    A list of patch operations.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRecordPatches() method.
    
    Returns:
    
    A list of patch operations.
  - syncSessionToken
```
public final String syncSessionToken()
```
    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.
  - clientContext
```
public final 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:
    
    Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.
  - toBuilder
```
public UpdateRecordsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateRecordsRequest.Builder,UpdateRecordsRequest>
    
    Specified by:
    
    toBuilder in class CognitoSyncRequest
  - builder
```
public static UpdateRecordsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateRecordsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class UpdateRecordsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

identityPoolId

identityId

datasetName

deviceId

hasRecordPatches

recordPatches

syncSessionToken

clientContext

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField