software.amazon.awssdk.services.honeycode.model

Class BatchUpdateTableRowsRequest

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.BatchUpdateTableRowsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchUpdateTableRowsRequest.Builder,BatchUpdateTableRowsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchUpdateTableRowsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static BatchUpdateTableRowsRequest.Builder	builder()
String	clientRequestToken() The request token for performing the update action.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasRowsToUpdate() Returns true if the RowsToUpdate 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<UpdateRowData>	rowsToUpdate() The list of rows to update in the table.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchUpdateTableRowsRequest.Builder>	serializableBuilderClass()
String	tableId() The ID of the table where the rows are being updated.
BatchUpdateTableRowsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	workbookId() The ID of the workbook where the rows are being updated.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

workbookId

public final String workbookId()

The ID of the workbook where the rows are being updated.

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 updated.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

tableId

public final String tableId()

The ID of the table where the rows are being updated.

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 updated.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

hasRowsToUpdate

public final boolean hasRowsToUpdate()

Returns true if the RowsToUpdate 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.

rowsToUpdate

public final List<UpdateRowData> rowsToUpdate()

The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

Note that if one of the row or column ids in the request 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 hasRowsToUpdate() to see if a value was sent in this field.

Returns:

The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update.

Note that if one of the row or column ids in the request does not exist in the table, then the request fails and no updates are made to the table.

clientRequestToken

public final 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 BatchUpdateTableRowsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<BatchUpdateTableRowsRequest.Builder,BatchUpdateTableRowsRequest>

Specified by:

toBuilder in class HoneycodeRequest

Returns:

a builder for type T

builder

public static BatchUpdateTableRowsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends BatchUpdateTableRowsRequest.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.