@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListTableRowsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
ListTableRowsRequest() |
Modifier and Type | Method and Description |
---|---|
ListTableRowsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getMaxResults()
The maximum number of rows to return in each page of the results.
|
String |
getNextToken()
This parameter is optional.
|
List<String> |
getRowIds()
This parameter is optional.
|
String |
getTableId()
The ID of the table whose rows are being retrieved.
|
String |
getWorkbookId()
The ID of the workbook that contains the table whose rows are being retrieved.
|
int |
hashCode() |
void |
setMaxResults(Integer maxResults)
The maximum number of rows to return in each page of the results.
|
void |
setNextToken(String nextToken)
This parameter is optional.
|
void |
setRowIds(Collection<String> rowIds)
This parameter is optional.
|
void |
setTableId(String tableId)
The ID of the table whose rows are being retrieved.
|
void |
setWorkbookId(String workbookId)
The ID of the workbook that contains the table whose rows are being retrieved.
|
String |
toString()
Returns a string representation of this object.
|
ListTableRowsRequest |
withMaxResults(Integer maxResults)
The maximum number of rows to return in each page of the results.
|
ListTableRowsRequest |
withNextToken(String nextToken)
This parameter is optional.
|
ListTableRowsRequest |
withRowIds(Collection<String> rowIds)
This parameter is optional.
|
ListTableRowsRequest |
withRowIds(String... rowIds)
This parameter is optional.
|
ListTableRowsRequest |
withTableId(String tableId)
The ID of the table whose rows are being retrieved.
|
ListTableRowsRequest |
withWorkbookId(String workbookId)
The ID of the workbook that contains the table whose rows are being retrieved.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setWorkbookId(String workbookId)
The ID of the workbook that contains the table whose rows are being retrieved.
If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
workbookId
- The ID of the workbook that contains the table whose rows are being retrieved.
If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
public String getWorkbookId()
The ID of the workbook that contains the table whose rows are being retrieved.
If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
public ListTableRowsRequest withWorkbookId(String workbookId)
The ID of the workbook that contains the table whose rows are being retrieved.
If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
workbookId
- The ID of the workbook that contains the table whose rows are being retrieved.
If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
public void setTableId(String tableId)
The ID of the table whose rows are being retrieved.
If a table with the specified id could not be found, this API throws ResourceNotFoundException.
tableId
- The ID of the table whose rows are being retrieved.
If a table with the specified id could not be found, this API throws ResourceNotFoundException.
public String getTableId()
The ID of the table whose rows are being retrieved.
If a table with the specified id could not be found, this API throws ResourceNotFoundException.
If a table with the specified id could not be found, this API throws ResourceNotFoundException.
public ListTableRowsRequest withTableId(String tableId)
The ID of the table whose rows are being retrieved.
If a table with the specified id could not be found, this API throws ResourceNotFoundException.
tableId
- The ID of the table whose rows are being retrieved.
If a table with the specified id could not be found, this API throws ResourceNotFoundException.
public List<String> getRowIds()
This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.
public void setRowIds(Collection<String> rowIds)
This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.
rowIds
- This parameter is optional. If one or more row ids are specified in this list, then only the specified row
ids are returned in the result. If no row ids are specified here, then all the rows in the table are
returned.public ListTableRowsRequest withRowIds(String... rowIds)
This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.
NOTE: This method appends the values to the existing list (if any). Use
setRowIds(java.util.Collection)
or withRowIds(java.util.Collection)
if you want to override the
existing values.
rowIds
- This parameter is optional. If one or more row ids are specified in this list, then only the specified row
ids are returned in the result. If no row ids are specified here, then all the rows in the table are
returned.public ListTableRowsRequest withRowIds(Collection<String> rowIds)
This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.
rowIds
- This parameter is optional. If one or more row ids are specified in this list, then only the specified row
ids are returned in the result. If no row ids are specified here, then all the rows in the table are
returned.public void setMaxResults(Integer maxResults)
The maximum number of rows to return in each page of the results.
maxResults
- The maximum number of rows to return in each page of the results.public Integer getMaxResults()
The maximum number of rows to return in each page of the results.
public ListTableRowsRequest withMaxResults(Integer maxResults)
The maximum number of rows to return in each page of the results.
maxResults
- The maximum number of rows to return in each page of the results.public void setNextToken(String nextToken)
This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
nextToken
- This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
public String getNextToken()
This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
public ListTableRowsRequest withNextToken(String nextToken)
This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
nextToken
- This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
public String toString()
toString
in class Object
Object.toString()
public ListTableRowsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()