software.amazon.awssdk.services.honeycode.model

Class BatchUpsertTableRowsRequest

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

Method Summary

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() For responses, this returns true if the service returned a value for the RowsToUpsert property.
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 final 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 final 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 final boolean hasRowsToUpsert()

For responses, this returns true if the service returned a value for the RowsToUpsert 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.

rowsToUpsert

public final 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.

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 hasRowsToUpsert() method.

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