Class BatchCreateTableRowsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<BatchCreateTableRowsRequest.Builder,
BatchCreateTableRowsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The request token for performing the batch create operation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RowsToCreate property.final List
<CreateRowData> The list of rows to create at the end of the table.static Class
<? extends BatchCreateTableRowsRequest.Builder> final String
tableId()
The ID of the table where the new rows are being added.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The ID of the workbook where the new rows are being added.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
workbookId
The ID of the workbook where the new rows are being added.
If a workbook with the specified ID could not be found, this API throws ResourceNotFoundException.
- Returns:
- The ID of the workbook where the new rows are being added.
If a workbook with the specified ID could not be found, this API throws ResourceNotFoundException.
-
tableId
The ID of the table where the new rows are being added.
If a table with the specified ID could not be found, this API throws ResourceNotFoundException.
- Returns:
- The ID of the table where the new rows are being added.
If a table with the specified ID could not be found, this API throws ResourceNotFoundException.
-
hasRowsToCreate
public final boolean hasRowsToCreate()For responses, this returns true if the service returned a value for the RowsToCreate property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
rowsToCreate
The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list.
Note that if one of the column ids in any of the rows 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.
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
hasRowsToCreate()
method.- Returns:
- The list of rows to create at the end of the table. Each item in this list needs to have a batch item id
to uniquely identify the element in the request and the cells to create for that row. You need to specify
at least one item in this list.
Note that if one of the column ids in any of the rows in the request does not exist in the table, then the request fails and no updates are made to the table.
-
clientRequestToken
The request token for performing the batch create operation. 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 operation 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 batch create operation. 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 operation 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
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 interfaceToCopyableBuilder<BatchCreateTableRowsRequest.Builder,
BatchCreateTableRowsRequest> - Specified by:
toBuilder
in classHoneycodeRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-