Interface UpdateRecordsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoSyncRequest.Builder
,CopyableBuilder<UpdateRecordsRequest.Builder,
,UpdateRecordsRequest> SdkBuilder<UpdateRecordsRequest.Builder,
,UpdateRecordsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateRecordsRequest
public static interface UpdateRecordsRequest.Builder
extends CognitoSyncRequest.Builder, SdkPojo, CopyableBuilder<UpdateRecordsRequest.Builder,UpdateRecordsRequest>
-
Method Summary
Modifier and TypeMethodDescriptionclientContext
(String clientContext) Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods.datasetName
(String datasetName) A string of up to 128 characters.The unique ID generated for this device by Cognito.identityId
(String identityId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.identityPoolId
(String identityPoolId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.recordPatches
(Collection<RecordPatch> recordPatches) A list of patch operations.recordPatches
(Consumer<RecordPatch.Builder>... recordPatches) A list of patch operations.recordPatches
(RecordPatch... recordPatches) A list of patch operations.syncSessionToken
(String syncSessionToken) The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cognitosync.model.CognitoSyncRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
recordPatches
A list of patch operations. This is a convenience method that creates an instance of theRecordPatch.Builder
avoiding the need to create one manually viaRecordPatch.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torecordPatches(List<RecordPatch>)
.- Parameters:
recordPatches
- a consumer that will call methods onRecordPatch.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
overrideConfiguration
UpdateRecordsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateRecordsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-