Interface HoneycodeClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without programming. Build Honeycode apps for managing almost anything, like projects, customers, operations, approvals, resources, and even your team.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault BatchCreateTableRowsResponse
batchCreateTableRows
(Consumer<BatchCreateTableRowsRequest.Builder> batchCreateTableRowsRequest) The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook.default BatchCreateTableRowsResponse
batchCreateTableRows
(BatchCreateTableRowsRequest batchCreateTableRowsRequest) The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook.default BatchDeleteTableRowsResponse
batchDeleteTableRows
(Consumer<BatchDeleteTableRowsRequest.Builder> batchDeleteTableRowsRequest) The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook.default BatchDeleteTableRowsResponse
batchDeleteTableRows
(BatchDeleteTableRowsRequest batchDeleteTableRowsRequest) The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook.default BatchUpdateTableRowsResponse
batchUpdateTableRows
(Consumer<BatchUpdateTableRowsRequest.Builder> batchUpdateTableRowsRequest) The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.default BatchUpdateTableRowsResponse
batchUpdateTableRows
(BatchUpdateTableRowsRequest batchUpdateTableRowsRequest) The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.default BatchUpsertTableRowsResponse
batchUpsertTableRows
(Consumer<BatchUpsertTableRowsRequest.Builder> batchUpsertTableRowsRequest) The BatchUpsertTableRows API allows you to upsert one or more rows in a table.default BatchUpsertTableRowsResponse
batchUpsertTableRows
(BatchUpsertTableRowsRequest batchUpsertTableRowsRequest) The BatchUpsertTableRows API allows you to upsert one or more rows in a table.static HoneycodeClientBuilder
builder()
Create a builder that can be used to configure and create aHoneycodeClient
.static HoneycodeClient
create()
Create aHoneycodeClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.describeTableDataImportJob
(Consumer<DescribeTableDataImportJobRequest.Builder> describeTableDataImportJobRequest) The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.describeTableDataImportJob
(DescribeTableDataImportJobRequest describeTableDataImportJobRequest) The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.default GetScreenDataResponse
getScreenData
(Consumer<GetScreenDataRequest.Builder> getScreenDataRequest) The GetScreenData API allows retrieval of data from a screen in a Honeycode app.default GetScreenDataResponse
getScreenData
(GetScreenDataRequest getScreenDataRequest) The GetScreenData API allows retrieval of data from a screen in a Honeycode app.default InvokeScreenAutomationResponse
invokeScreenAutomation
(Consumer<InvokeScreenAutomationRequest.Builder> invokeScreenAutomationRequest) The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.default InvokeScreenAutomationResponse
invokeScreenAutomation
(InvokeScreenAutomationRequest invokeScreenAutomationRequest) The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.default ListTableColumnsResponse
listTableColumns
(Consumer<ListTableColumnsRequest.Builder> listTableColumnsRequest) The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.default ListTableColumnsResponse
listTableColumns
(ListTableColumnsRequest listTableColumnsRequest) The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.default ListTableColumnsIterable
listTableColumnsPaginator
(Consumer<ListTableColumnsRequest.Builder> listTableColumnsRequest) This is a variant oflistTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)
operation.default ListTableColumnsIterable
listTableColumnsPaginator
(ListTableColumnsRequest listTableColumnsRequest) This is a variant oflistTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)
operation.default ListTableRowsResponse
listTableRows
(Consumer<ListTableRowsRequest.Builder> listTableRowsRequest) The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.default ListTableRowsResponse
listTableRows
(ListTableRowsRequest listTableRowsRequest) The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.default ListTableRowsIterable
listTableRowsPaginator
(Consumer<ListTableRowsRequest.Builder> listTableRowsRequest) This is a variant oflistTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)
operation.default ListTableRowsIterable
listTableRowsPaginator
(ListTableRowsRequest listTableRowsRequest) This is a variant oflistTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)
operation.default ListTablesResponse
listTables
(Consumer<ListTablesRequest.Builder> listTablesRequest) The ListTables API allows you to retrieve a list of all the tables in a workbook.default ListTablesResponse
listTables
(ListTablesRequest listTablesRequest) The ListTables API allows you to retrieve a list of all the tables in a workbook.default ListTablesIterable
listTablesPaginator
(Consumer<ListTablesRequest.Builder> listTablesRequest) This is a variant oflistTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)
operation.default ListTablesIterable
listTablesPaginator
(ListTablesRequest listTablesRequest) This is a variant oflistTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) The ListTagsForResource API allows you to return a resource's tags.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) The ListTagsForResource API allows you to return a resource's tags.default QueryTableRowsResponse
queryTableRows
(Consumer<QueryTableRowsRequest.Builder> queryTableRowsRequest) The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.default QueryTableRowsResponse
queryTableRows
(QueryTableRowsRequest queryTableRowsRequest) The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.default QueryTableRowsIterable
queryTableRowsPaginator
(Consumer<QueryTableRowsRequest.Builder> queryTableRowsRequest) This is a variant ofqueryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)
operation.default QueryTableRowsIterable
queryTableRowsPaginator
(QueryTableRowsRequest queryTableRowsRequest) This is a variant ofqueryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartTableDataImportJobResponse
startTableDataImportJob
(Consumer<StartTableDataImportJobRequest.Builder> startTableDataImportJobRequest) The StartTableDataImportJob API allows you to start an import job on a table.default StartTableDataImportJobResponse
startTableDataImportJob
(StartTableDataImportJobRequest startTableDataImportJobRequest) The StartTableDataImportJob API allows you to start an import job on a table.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) The TagResource API allows you to add tags to an ARN-able resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) The TagResource API allows you to add tags to an ARN-able resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) The UntagResource API allows you to removes tags from an ARN-able resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) The UntagResource API allows you to removes tags from an ARN-able resource.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchCreateTableRows
default BatchCreateTableRowsResponse batchCreateTableRows(BatchCreateTableRowsRequest batchCreateTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceQuotaExceededException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook. The API allows you to specify the values to set in some or all of the columns in the new rows.
If a column is not explicitly set in a specific row, then the column level formula specified in the table will be applied to the new row. If there is no column level formula but the last row of the table has a formula, then that formula will be copied down to the new row. If there is no column level formula and no formula in the last row of the table, then that column will be left blank for the new rows.
- Parameters:
batchCreateTableRowsRequest
-- Returns:
- Result of the BatchCreateTableRows operation returned by the service.
- See Also:
-
batchCreateTableRows
default BatchCreateTableRowsResponse batchCreateTableRows(Consumer<BatchCreateTableRowsRequest.Builder> batchCreateTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceQuotaExceededException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook. The API allows you to specify the values to set in some or all of the columns in the new rows.
If a column is not explicitly set in a specific row, then the column level formula specified in the table will be applied to the new row. If there is no column level formula but the last row of the table has a formula, then that formula will be copied down to the new row. If there is no column level formula and no formula in the last row of the table, then that column will be left blank for the new rows.
This is a convenience which creates an instance of the
BatchCreateTableRowsRequest.Builder
avoiding the need to create one manually viaBatchCreateTableRowsRequest.builder()
- Parameters:
batchCreateTableRowsRequest
- AConsumer
that will call methods onBatchCreateTableRowsRequest.Builder
to create a request.- Returns:
- Result of the BatchCreateTableRows operation returned by the service.
- See Also:
-
batchDeleteTableRows
default BatchDeleteTableRowsResponse batchDeleteTableRows(BatchDeleteTableRowsRequest batchDeleteTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook. You need to specify the ids of the rows that you want to delete from the table.
- Parameters:
batchDeleteTableRowsRequest
-- Returns:
- Result of the BatchDeleteTableRows operation returned by the service.
- See Also:
-
batchDeleteTableRows
default BatchDeleteTableRowsResponse batchDeleteTableRows(Consumer<BatchDeleteTableRowsRequest.Builder> batchDeleteTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook. You need to specify the ids of the rows that you want to delete from the table.
This is a convenience which creates an instance of the
BatchDeleteTableRowsRequest.Builder
avoiding the need to create one manually viaBatchDeleteTableRowsRequest.builder()
- Parameters:
batchDeleteTableRowsRequest
- AConsumer
that will call methods onBatchDeleteTableRowsRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteTableRows operation returned by the service.
- See Also:
-
batchUpdateTableRows
default BatchUpdateTableRowsResponse batchUpdateTableRows(BatchUpdateTableRowsRequest batchUpdateTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.
You can specify the values to set in some or all of the columns in the table for the specified rows. If a column is not explicitly specified in a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string ("").
- Parameters:
batchUpdateTableRowsRequest
-- Returns:
- Result of the BatchUpdateTableRows operation returned by the service.
- See Also:
-
batchUpdateTableRows
default BatchUpdateTableRowsResponse batchUpdateTableRows(Consumer<BatchUpdateTableRowsRequest.Builder> batchUpdateTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.
You can specify the values to set in some or all of the columns in the table for the specified rows. If a column is not explicitly specified in a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string ("").
This is a convenience which creates an instance of the
BatchUpdateTableRowsRequest.Builder
avoiding the need to create one manually viaBatchUpdateTableRowsRequest.builder()
- Parameters:
batchUpdateTableRowsRequest
- AConsumer
that will call methods onBatchUpdateTableRowsRequest.Builder
to create a request.- Returns:
- Result of the BatchUpdateTableRows operation returned by the service.
- See Also:
-
batchUpsertTableRows
default BatchUpsertTableRowsResponse batchUpsertTableRows(BatchUpsertTableRowsRequest batchUpsertTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceQuotaExceededException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The BatchUpsertTableRows API allows you to upsert one or more rows in a table. The upsert operation takes a filter expression as input and evaluates it to find matching rows on the destination table. If matching rows are found, it will update the cells in the matching rows to new values specified in the request. If no matching rows are found, a new row is added at the end of the table and the cells in that row are set to the new values specified in the request.
You can specify the values to set in some or all of the columns in the table for the matching or newly appended rows. If a column is not explicitly specified for a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string ("").
- Parameters:
batchUpsertTableRowsRequest
-- Returns:
- Result of the BatchUpsertTableRows operation returned by the service.
- See Also:
-
batchUpsertTableRows
default BatchUpsertTableRowsResponse batchUpsertTableRows(Consumer<BatchUpsertTableRowsRequest.Builder> batchUpsertTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceQuotaExceededException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The BatchUpsertTableRows API allows you to upsert one or more rows in a table. The upsert operation takes a filter expression as input and evaluates it to find matching rows on the destination table. If matching rows are found, it will update the cells in the matching rows to new values specified in the request. If no matching rows are found, a new row is added at the end of the table and the cells in that row are set to the new values specified in the request.
You can specify the values to set in some or all of the columns in the table for the matching or newly appended rows. If a column is not explicitly specified for a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string ("").
This is a convenience which creates an instance of the
BatchUpsertTableRowsRequest.Builder
avoiding the need to create one manually viaBatchUpsertTableRowsRequest.builder()
- Parameters:
batchUpsertTableRowsRequest
- AConsumer
that will call methods onBatchUpsertTableRowsRequest.Builder
to create a request.- Returns:
- Result of the BatchUpsertTableRows operation returned by the service.
- See Also:
-
describeTableDataImportJob
default DescribeTableDataImportJobResponse describeTableDataImportJob(DescribeTableDataImportJobRequest describeTableDataImportJobRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, RequestTimeoutException, AwsServiceException, SdkClientException, HoneycodeException The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.
- Parameters:
describeTableDataImportJobRequest
-- Returns:
- Result of the DescribeTableDataImportJob operation returned by the service.
- See Also:
-
describeTableDataImportJob
default DescribeTableDataImportJobResponse describeTableDataImportJob(Consumer<DescribeTableDataImportJobRequest.Builder> describeTableDataImportJobRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, RequestTimeoutException, AwsServiceException, SdkClientException, HoneycodeException The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.
This is a convenience which creates an instance of the
DescribeTableDataImportJobRequest.Builder
avoiding the need to create one manually viaDescribeTableDataImportJobRequest.builder()
- Parameters:
describeTableDataImportJobRequest
- AConsumer
that will call methods onDescribeTableDataImportJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeTableDataImportJob operation returned by the service.
- See Also:
-
getScreenData
default GetScreenDataResponse getScreenData(GetScreenDataRequest getScreenDataRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The GetScreenData API allows retrieval of data from a screen in a Honeycode app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen.
- Parameters:
getScreenDataRequest
-- Returns:
- Result of the GetScreenData operation returned by the service.
- See Also:
-
getScreenData
default GetScreenDataResponse getScreenData(Consumer<GetScreenDataRequest.Builder> getScreenDataRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The GetScreenData API allows retrieval of data from a screen in a Honeycode app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen.
This is a convenience which creates an instance of the
GetScreenDataRequest.Builder
avoiding the need to create one manually viaGetScreenDataRequest.builder()
- Parameters:
getScreenDataRequest
- AConsumer
that will call methods onGetScreenDataRequest.Builder
to create a request.- Returns:
- Result of the GetScreenData operation returned by the service.
- See Also:
-
invokeScreenAutomation
default InvokeScreenAutomationResponse invokeScreenAutomation(InvokeScreenAutomationRequest invokeScreenAutomationRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, ServiceUnavailableException, AutomationExecutionException, AutomationExecutionTimeoutException, RequestTimeoutException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, HoneycodeException The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook.
- Parameters:
invokeScreenAutomationRequest
-- Returns:
- Result of the InvokeScreenAutomation operation returned by the service.
- See Also:
-
invokeScreenAutomation
default InvokeScreenAutomationResponse invokeScreenAutomation(Consumer<InvokeScreenAutomationRequest.Builder> invokeScreenAutomationRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, ServiceUnavailableException, AutomationExecutionException, AutomationExecutionTimeoutException, RequestTimeoutException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, HoneycodeException The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook.
This is a convenience which creates an instance of the
InvokeScreenAutomationRequest.Builder
avoiding the need to create one manually viaInvokeScreenAutomationRequest.builder()
- Parameters:
invokeScreenAutomationRequest
- AConsumer
that will call methods onInvokeScreenAutomationRequest.Builder
to create a request.- Returns:
- Result of the InvokeScreenAutomation operation returned by the service.
- See Also:
-
listTableColumns
default ListTableColumnsResponse listTableColumns(ListTableColumnsRequest listTableColumnsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.
- Parameters:
listTableColumnsRequest
-- Returns:
- Result of the ListTableColumns operation returned by the service.
- See Also:
-
listTableColumns
default ListTableColumnsResponse listTableColumns(Consumer<ListTableColumnsRequest.Builder> listTableColumnsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.
This is a convenience which creates an instance of the
ListTableColumnsRequest.Builder
avoiding the need to create one manually viaListTableColumnsRequest.builder()
- Parameters:
listTableColumnsRequest
- AConsumer
that will call methods onListTableColumnsRequest.Builder
to create a request.- Returns:
- Result of the ListTableColumns operation returned by the service.
- See Also:
-
listTableColumnsPaginator
default ListTableColumnsIterable listTableColumnsPaginator(ListTableColumnsRequest listTableColumnsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException This is a variant of
listTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client.listTableColumnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client .listTableColumnsPaginator(request); for (software.amazon.awssdk.services.honeycode.model.ListTableColumnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client.listTableColumnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)
operation.- Parameters:
listTableColumnsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTableColumnsPaginator
default ListTableColumnsIterable listTableColumnsPaginator(Consumer<ListTableColumnsRequest.Builder> listTableColumnsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException This is a variant of
listTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client.listTableColumnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client .listTableColumnsPaginator(request); for (software.amazon.awssdk.services.honeycode.model.ListTableColumnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client.listTableColumnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)
operation.
This is a convenience which creates an instance of the
ListTableColumnsRequest.Builder
avoiding the need to create one manually viaListTableColumnsRequest.builder()
- Parameters:
listTableColumnsRequest
- AConsumer
that will call methods onListTableColumnsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTableRows
default ListTableRowsResponse listTableRows(ListTableRowsRequest listTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.
- Parameters:
listTableRowsRequest
-- Returns:
- Result of the ListTableRows operation returned by the service.
- See Also:
-
listTableRows
default ListTableRowsResponse listTableRows(Consumer<ListTableRowsRequest.Builder> listTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.
This is a convenience which creates an instance of the
ListTableRowsRequest.Builder
avoiding the need to create one manually viaListTableRowsRequest.builder()
- Parameters:
listTableRowsRequest
- AConsumer
that will call methods onListTableRowsRequest.Builder
to create a request.- Returns:
- Result of the ListTableRows operation returned by the service.
- See Also:
-
listTableRowsPaginator
default ListTableRowsIterable listTableRowsPaginator(ListTableRowsRequest listTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException This is a variant of
listTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request); for (software.amazon.awssdk.services.honeycode.model.ListTableRowsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)
operation.- Parameters:
listTableRowsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTableRowsPaginator
default ListTableRowsIterable listTableRowsPaginator(Consumer<ListTableRowsRequest.Builder> listTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException This is a variant of
listTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request); for (software.amazon.awssdk.services.honeycode.model.ListTableRowsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)
operation.
This is a convenience which creates an instance of the
ListTableRowsRequest.Builder
avoiding the need to create one manually viaListTableRowsRequest.builder()
- Parameters:
listTableRowsRequest
- AConsumer
that will call methods onListTableRowsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTables
default ListTablesResponse listTables(ListTablesRequest listTablesRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The ListTables API allows you to retrieve a list of all the tables in a workbook.
- Parameters:
listTablesRequest
-- Returns:
- Result of the ListTables operation returned by the service.
- See Also:
-
listTables
default ListTablesResponse listTables(Consumer<ListTablesRequest.Builder> listTablesRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The ListTables API allows you to retrieve a list of all the tables in a workbook.
This is a convenience which creates an instance of the
ListTablesRequest.Builder
avoiding the need to create one manually viaListTablesRequest.builder()
- Parameters:
listTablesRequest
- AConsumer
that will call methods onListTablesRequest.Builder
to create a request.- Returns:
- Result of the ListTables operation returned by the service.
- See Also:
-
listTablesPaginator
default ListTablesIterable listTablesPaginator(ListTablesRequest listTablesRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException This is a variant of
listTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request); for (software.amazon.awssdk.services.honeycode.model.ListTablesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)
operation.- Parameters:
listTablesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTablesPaginator
default ListTablesIterable listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException This is a variant of
listTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request); for (software.amazon.awssdk.services.honeycode.model.ListTablesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)
operation.
This is a convenience which creates an instance of the
ListTablesRequest.Builder
avoiding the need to create one manually viaListTablesRequest.builder()
- Parameters:
listTablesRequest
- AConsumer
that will call methods onListTablesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The ListTagsForResource API allows you to return a resource's tags.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The ListTagsForResource API allows you to return a resource's tags.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
queryTableRows
default QueryTableRowsResponse queryTableRows(QueryTableRowsRequest queryTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.
- Parameters:
queryTableRowsRequest
-- Returns:
- Result of the QueryTableRows operation returned by the service.
- See Also:
-
queryTableRows
default QueryTableRowsResponse queryTableRows(Consumer<QueryTableRowsRequest.Builder> queryTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.
This is a convenience which creates an instance of the
QueryTableRowsRequest.Builder
avoiding the need to create one manually viaQueryTableRowsRequest.builder()
- Parameters:
queryTableRowsRequest
- AConsumer
that will call methods onQueryTableRowsRequest.Builder
to create a request.- Returns:
- Result of the QueryTableRows operation returned by the service.
- See Also:
-
queryTableRowsPaginator
default QueryTableRowsIterable queryTableRowsPaginator(QueryTableRowsRequest queryTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException This is a variant of
queryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client.queryTableRowsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client .queryTableRowsPaginator(request); for (software.amazon.awssdk.services.honeycode.model.QueryTableRowsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client.queryTableRowsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
queryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)
operation.- Parameters:
queryTableRowsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
queryTableRowsPaginator
default QueryTableRowsIterable queryTableRowsPaginator(Consumer<QueryTableRowsRequest.Builder> queryTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException This is a variant of
queryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client.queryTableRowsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client .queryTableRowsPaginator(request); for (software.amazon.awssdk.services.honeycode.model.QueryTableRowsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client.queryTableRowsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
queryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)
operation.
This is a convenience which creates an instance of the
QueryTableRowsRequest.Builder
avoiding the need to create one manually viaQueryTableRowsRequest.builder()
- Parameters:
queryTableRowsRequest
- AConsumer
that will call methods onQueryTableRowsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
startTableDataImportJob
default StartTableDataImportJobResponse startTableDataImportJob(StartTableDataImportJobRequest startTableDataImportJobRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, RequestTimeoutException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, HoneycodeException The StartTableDataImportJob API allows you to start an import job on a table. This API will only return the id of the job that was started. To find out the status of the import request, you need to call the DescribeTableDataImportJob API.
- Parameters:
startTableDataImportJobRequest
-- Returns:
- Result of the StartTableDataImportJob operation returned by the service.
- See Also:
-
startTableDataImportJob
default StartTableDataImportJobResponse startTableDataImportJob(Consumer<StartTableDataImportJobRequest.Builder> startTableDataImportJobRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, RequestTimeoutException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, HoneycodeException The StartTableDataImportJob API allows you to start an import job on a table. This API will only return the id of the job that was started. To find out the status of the import request, you need to call the DescribeTableDataImportJob API.
This is a convenience which creates an instance of the
StartTableDataImportJobRequest.Builder
avoiding the need to create one manually viaStartTableDataImportJobRequest.builder()
- Parameters:
startTableDataImportJobRequest
- AConsumer
that will call methods onStartTableDataImportJobRequest.Builder
to create a request.- Returns:
- Result of the StartTableDataImportJob operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, screen and screen-automation.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, screen and screen-automation.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, screen and screen-automation.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, screen and screen-automation.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
create
Create aHoneycodeClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aHoneycodeClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-