BatchUpsertTableRowsRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.honeycode.model.HoneycodeRequest
    - - software.amazon.awssdk.services.honeycode.model.BatchUpsertTableRowsRequest

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

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchUpsertTableRowsRequest
extends HoneycodeRequest
implements ToCopyableBuilder<BatchUpsertTableRowsRequest.Builder,BatchUpsertTableRowsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BatchUpsertTableRowsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BatchUpsertTableRowsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BatchUpsertTableRowsRequest.Builder`	`builder()`
`String`	`clientRequestToken()` The request token for performing the update action.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasRowsToUpsert()` Returns true if the RowsToUpsert property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<UpsertRowData>`	`rowsToUpsert()` The list of rows to upsert in the table.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BatchUpsertTableRowsRequest.Builder>`	`serializableBuilderClass()`
`String`	`tableId()` The ID of the table where the rows are being upserted.
`BatchUpsertTableRowsRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`workbookId()` The ID of the workbook where the rows are being upserted.

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
  - workbookId
```
public String workbookId()
```
    The ID of the workbook where the rows are being upserted.
    
    If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
    
    Returns:
    
    The ID of the workbook where the rows are being upserted.
    
    If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
  - tableId
```
public String tableId()
```
    The ID of the table where the rows are being upserted.
    
    If a table with the specified id could not be found, this API throws ResourceNotFoundException.
    
    Returns:
    
    The ID of the table where the rows are being upserted.
    
    If a table with the specified id could not be found, this API throws ResourceNotFoundException.
  - hasRowsToUpsert
```
public boolean hasRowsToUpsert()
```
    Returns true if the RowsToUpsert property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - rowsToUpsert
```
public List<UpsertRowData> rowsToUpsert()
```
    The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.
    
    Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows does not exist in the table, then the request fails and no updates are made to the table.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasRowsToUpsert() to see if a value was sent in this field.
    
    Returns:
    
    The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list.
    
    Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows does not exist in the table, then the request fails and no updates are made to the table.
  - clientRequestToken
```
public String clientRequestToken()
```
    The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.
    
    Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
    
    Returns:
    
    The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again.
    
    Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
  - toBuilder
```
public BatchUpsertTableRowsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BatchUpsertTableRowsRequest.Builder,BatchUpsertTableRowsRequest>
    
    Specified by:
    
    toBuilder in class HoneycodeRequest
  - builder
```
public static BatchUpsertTableRowsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BatchUpsertTableRowsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class BatchUpsertTableRowsRequest

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

workbookId

tableId

hasRowsToUpsert

rowsToUpsert

clientRequestToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields