
software.amazon.awssdk.services.honeycode.HoneycodeClient Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.honeycode;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.honeycode.model.AccessDeniedException;
import software.amazon.awssdk.services.honeycode.model.AutomationExecutionException;
import software.amazon.awssdk.services.honeycode.model.AutomationExecutionTimeoutException;
import software.amazon.awssdk.services.honeycode.model.BatchCreateTableRowsRequest;
import software.amazon.awssdk.services.honeycode.model.BatchCreateTableRowsResponse;
import software.amazon.awssdk.services.honeycode.model.BatchDeleteTableRowsRequest;
import software.amazon.awssdk.services.honeycode.model.BatchDeleteTableRowsResponse;
import software.amazon.awssdk.services.honeycode.model.BatchUpdateTableRowsRequest;
import software.amazon.awssdk.services.honeycode.model.BatchUpdateTableRowsResponse;
import software.amazon.awssdk.services.honeycode.model.BatchUpsertTableRowsRequest;
import software.amazon.awssdk.services.honeycode.model.BatchUpsertTableRowsResponse;
import software.amazon.awssdk.services.honeycode.model.DescribeTableDataImportJobRequest;
import software.amazon.awssdk.services.honeycode.model.DescribeTableDataImportJobResponse;
import software.amazon.awssdk.services.honeycode.model.GetScreenDataRequest;
import software.amazon.awssdk.services.honeycode.model.GetScreenDataResponse;
import software.amazon.awssdk.services.honeycode.model.HoneycodeException;
import software.amazon.awssdk.services.honeycode.model.InternalServerException;
import software.amazon.awssdk.services.honeycode.model.InvokeScreenAutomationRequest;
import software.amazon.awssdk.services.honeycode.model.InvokeScreenAutomationResponse;
import software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest;
import software.amazon.awssdk.services.honeycode.model.ListTableColumnsResponse;
import software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest;
import software.amazon.awssdk.services.honeycode.model.ListTableRowsResponse;
import software.amazon.awssdk.services.honeycode.model.ListTablesRequest;
import software.amazon.awssdk.services.honeycode.model.ListTablesResponse;
import software.amazon.awssdk.services.honeycode.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.honeycode.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest;
import software.amazon.awssdk.services.honeycode.model.QueryTableRowsResponse;
import software.amazon.awssdk.services.honeycode.model.RequestTimeoutException;
import software.amazon.awssdk.services.honeycode.model.ResourceNotFoundException;
import software.amazon.awssdk.services.honeycode.model.ServiceQuotaExceededException;
import software.amazon.awssdk.services.honeycode.model.ServiceUnavailableException;
import software.amazon.awssdk.services.honeycode.model.StartTableDataImportJobRequest;
import software.amazon.awssdk.services.honeycode.model.StartTableDataImportJobResponse;
import software.amazon.awssdk.services.honeycode.model.TagResourceRequest;
import software.amazon.awssdk.services.honeycode.model.TagResourceResponse;
import software.amazon.awssdk.services.honeycode.model.ThrottlingException;
import software.amazon.awssdk.services.honeycode.model.UntagResourceRequest;
import software.amazon.awssdk.services.honeycode.model.UntagResourceResponse;
import software.amazon.awssdk.services.honeycode.model.ValidationException;
import software.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable;
import software.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable;
import software.amazon.awssdk.services.honeycode.paginators.ListTablesIterable;
import software.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable;
/**
* Service client for accessing Honeycode. This can be created using the static {@link #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.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface HoneycodeClient extends AwsClient {
String SERVICE_NAME = "honeycode";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "honeycode";
/**
*
* 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.
*
*
* @param batchCreateTableRowsRequest
* @return Result of the BatchCreateTableRows operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceQuotaExceededException
* The request caused service quota to be breached.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.BatchCreateTableRows
* @see AWS API Documentation
*/
default BatchCreateTableRowsResponse batchCreateTableRows(BatchCreateTableRowsRequest batchCreateTableRowsRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceQuotaExceededException, ServiceUnavailableException, ThrottlingException, ValidationException,
AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link BatchCreateTableRowsRequest.Builder} avoiding the
* need to create one manually via {@link BatchCreateTableRowsRequest#builder()}
*
*
* @param batchCreateTableRowsRequest
* A {@link Consumer} that will call methods on {@link BatchCreateTableRowsRequest.Builder} to create a
* request.
* @return Result of the BatchCreateTableRows operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceQuotaExceededException
* The request caused service quota to be breached.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.BatchCreateTableRows
* @see AWS API Documentation
*/
default BatchCreateTableRowsResponse batchCreateTableRows(
Consumer batchCreateTableRowsRequest) throws AccessDeniedException,
InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceQuotaExceededException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
return batchCreateTableRows(BatchCreateTableRowsRequest.builder().applyMutation(batchCreateTableRowsRequest).build());
}
/**
*
* 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.
*
*
* @param batchDeleteTableRowsRequest
* @return Result of the BatchDeleteTableRows operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws RequestTimeoutException
* The request timed out.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.BatchDeleteTableRows
* @see AWS API Documentation
*/
default BatchDeleteTableRowsResponse batchDeleteTableRows(BatchDeleteTableRowsRequest batchDeleteTableRowsRequest)
throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException,
ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException,
HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link BatchDeleteTableRowsRequest.Builder} avoiding the
* need to create one manually via {@link BatchDeleteTableRowsRequest#builder()}
*
*
* @param batchDeleteTableRowsRequest
* A {@link Consumer} that will call methods on {@link BatchDeleteTableRowsRequest.Builder} to create a
* request.
* @return Result of the BatchDeleteTableRows operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws RequestTimeoutException
* The request timed out.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.BatchDeleteTableRows
* @see AWS API Documentation
*/
default BatchDeleteTableRowsResponse batchDeleteTableRows(
Consumer batchDeleteTableRowsRequest) throws AccessDeniedException,
InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException,
RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException {
return batchDeleteTableRows(BatchDeleteTableRowsRequest.builder().applyMutation(batchDeleteTableRowsRequest).build());
}
/**
*
* 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 ("").
*
*
* @param batchUpdateTableRowsRequest
* @return Result of the BatchUpdateTableRows operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws RequestTimeoutException
* The request timed out.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.BatchUpdateTableRows
* @see AWS API Documentation
*/
default BatchUpdateTableRowsResponse batchUpdateTableRows(BatchUpdateTableRowsRequest batchUpdateTableRowsRequest)
throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException,
ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException,
HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link BatchUpdateTableRowsRequest.Builder} avoiding the
* need to create one manually via {@link BatchUpdateTableRowsRequest#builder()}
*
*
* @param batchUpdateTableRowsRequest
* A {@link Consumer} that will call methods on {@link BatchUpdateTableRowsRequest.Builder} to create a
* request.
* @return Result of the BatchUpdateTableRows operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws RequestTimeoutException
* The request timed out.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.BatchUpdateTableRows
* @see AWS API Documentation
*/
default BatchUpdateTableRowsResponse batchUpdateTableRows(
Consumer batchUpdateTableRowsRequest) throws AccessDeniedException,
InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException,
RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException {
return batchUpdateTableRows(BatchUpdateTableRowsRequest.builder().applyMutation(batchUpdateTableRowsRequest).build());
}
/**
*
* 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 ("").
*
*
* @param batchUpsertTableRowsRequest
* @return Result of the BatchUpsertTableRows operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceQuotaExceededException
* The request caused service quota to be breached.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.BatchUpsertTableRows
* @see AWS API Documentation
*/
default BatchUpsertTableRowsResponse batchUpsertTableRows(BatchUpsertTableRowsRequest batchUpsertTableRowsRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceQuotaExceededException, ServiceUnavailableException, ThrottlingException, ValidationException,
AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link BatchUpsertTableRowsRequest.Builder} avoiding the
* need to create one manually via {@link BatchUpsertTableRowsRequest#builder()}
*
*
* @param batchUpsertTableRowsRequest
* A {@link Consumer} that will call methods on {@link BatchUpsertTableRowsRequest.Builder} to create a
* request.
* @return Result of the BatchUpsertTableRows operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceQuotaExceededException
* The request caused service quota to be breached.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.BatchUpsertTableRows
* @see AWS API Documentation
*/
default BatchUpsertTableRowsResponse batchUpsertTableRows(
Consumer batchUpsertTableRowsRequest) throws AccessDeniedException,
InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceQuotaExceededException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
return batchUpsertTableRows(BatchUpsertTableRowsRequest.builder().applyMutation(batchUpsertTableRowsRequest).build());
}
/**
*
* The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.
*
*
* @param describeTableDataImportJobRequest
* @return Result of the DescribeTableDataImportJob operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws RequestTimeoutException
* The request timed out.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.DescribeTableDataImportJob
* @see AWS API Documentation
*/
default DescribeTableDataImportJobResponse describeTableDataImportJob(
DescribeTableDataImportJobRequest describeTableDataImportJobRequest) throws AccessDeniedException,
InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException,
ValidationException, RequestTimeoutException, AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeTableDataImportJobRequest.Builder} avoiding
* the need to create one manually via {@link DescribeTableDataImportJobRequest#builder()}
*
*
* @param describeTableDataImportJobRequest
* A {@link Consumer} that will call methods on {@link DescribeTableDataImportJobRequest.Builder} to create a
* request.
* @return Result of the DescribeTableDataImportJob operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws RequestTimeoutException
* The request timed out.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.DescribeTableDataImportJob
* @see AWS API Documentation
*/
default DescribeTableDataImportJobResponse describeTableDataImportJob(
Consumer describeTableDataImportJobRequest) throws AccessDeniedException,
InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException,
ValidationException, RequestTimeoutException, AwsServiceException, SdkClientException, HoneycodeException {
return describeTableDataImportJob(DescribeTableDataImportJobRequest.builder()
.applyMutation(describeTableDataImportJobRequest).build());
}
/**
*
* 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.
*
*
* @param getScreenDataRequest
* @return Result of the GetScreenData operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.GetScreenData
* @see AWS API
* Documentation
*/
default GetScreenDataResponse getScreenData(GetScreenDataRequest getScreenDataRequest) throws AccessDeniedException,
InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException,
ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetScreenDataRequest.Builder} avoiding the need to
* create one manually via {@link GetScreenDataRequest#builder()}
*
*
* @param getScreenDataRequest
* A {@link Consumer} that will call methods on {@link GetScreenDataRequest.Builder} to create a request.
* @return Result of the GetScreenData operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.GetScreenData
* @see AWS API
* Documentation
*/
default GetScreenDataResponse getScreenData(Consumer getScreenDataRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
return getScreenData(GetScreenDataRequest.builder().applyMutation(getScreenDataRequest).build());
}
/**
*
* 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.
*
*
* @param invokeScreenAutomationRequest
* @return Result of the InvokeScreenAutomation operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws AutomationExecutionException
* The automation execution did not end successfully.
* @throws AutomationExecutionTimeoutException
* The automation execution timed out.
* @throws RequestTimeoutException
* The request timed out.
* @throws ServiceQuotaExceededException
* The request caused service quota to be breached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.InvokeScreenAutomation
* @see AWS API Documentation
*/
default InvokeScreenAutomationResponse invokeScreenAutomation(InvokeScreenAutomationRequest invokeScreenAutomationRequest)
throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException,
ThrottlingException, ServiceUnavailableException, AutomationExecutionException, AutomationExecutionTimeoutException,
RequestTimeoutException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link InvokeScreenAutomationRequest.Builder} avoiding the
* need to create one manually via {@link InvokeScreenAutomationRequest#builder()}
*
*
* @param invokeScreenAutomationRequest
* A {@link Consumer} that will call methods on {@link InvokeScreenAutomationRequest.Builder} to create a
* request.
* @return Result of the InvokeScreenAutomation operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws AutomationExecutionException
* The automation execution did not end successfully.
* @throws AutomationExecutionTimeoutException
* The automation execution timed out.
* @throws RequestTimeoutException
* The request timed out.
* @throws ServiceQuotaExceededException
* The request caused service quota to be breached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.InvokeScreenAutomation
* @see AWS API Documentation
*/
default InvokeScreenAutomationResponse invokeScreenAutomation(
Consumer invokeScreenAutomationRequest) throws AccessDeniedException,
InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException,
ServiceUnavailableException, AutomationExecutionException, AutomationExecutionTimeoutException,
RequestTimeoutException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, HoneycodeException {
return invokeScreenAutomation(InvokeScreenAutomationRequest.builder().applyMutation(invokeScreenAutomationRequest)
.build());
}
/**
*
* The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.
*
*
* @param listTableColumnsRequest
* @return Result of the ListTableColumns operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTableColumns
* @see AWS
* API Documentation
*/
default ListTableColumnsResponse listTableColumns(ListTableColumnsRequest listTableColumnsRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTableColumnsRequest.Builder} avoiding the need
* to create one manually via {@link ListTableColumnsRequest#builder()}
*
*
* @param listTableColumnsRequest
* A {@link Consumer} that will call methods on {@link ListTableColumnsRequest.Builder} to create a request.
* @return Result of the ListTableColumns operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTableColumns
* @see AWS
* API Documentation
*/
default ListTableColumnsResponse listTableColumns(Consumer listTableColumnsRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
return listTableColumns(ListTableColumnsRequest.builder().applyMutation(listTableColumnsRequest).build());
}
/**
*
* The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.
*
*
*
* This is a variant of
* {@link #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 Stream
*
*
* {@code
* software.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client.listTableColumnsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)} operation.
*
*
* @param listTableColumnsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTableColumns
* @see AWS
* API Documentation
*/
default ListTableColumnsIterable listTableColumnsPaginator(ListTableColumnsRequest listTableColumnsRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.
*
*
*
* This is a variant of
* {@link #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 Stream
*
*
* {@code
* software.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client.listTableColumnsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListTableColumnsRequest.Builder} avoiding the need
* to create one manually via {@link ListTableColumnsRequest#builder()}
*
*
* @param listTableColumnsRequest
* A {@link Consumer} that will call methods on {@link ListTableColumnsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTableColumns
* @see AWS
* API Documentation
*/
default ListTableColumnsIterable listTableColumnsPaginator(Consumer listTableColumnsRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
return listTableColumnsPaginator(ListTableColumnsRequest.builder().applyMutation(listTableColumnsRequest).build());
}
/**
*
* The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.
*
*
* @param listTableRowsRequest
* @return Result of the ListTableRows operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws RequestTimeoutException
* The request timed out.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTableRows
* @see AWS API
* Documentation
*/
default ListTableRowsResponse listTableRows(ListTableRowsRequest listTableRowsRequest) throws AccessDeniedException,
InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException,
RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTableRowsRequest.Builder} avoiding the need to
* create one manually via {@link ListTableRowsRequest#builder()}
*
*
* @param listTableRowsRequest
* A {@link Consumer} that will call methods on {@link ListTableRowsRequest.Builder} to create a request.
* @return Result of the ListTableRows operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws RequestTimeoutException
* The request timed out.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTableRows
* @see AWS API
* Documentation
*/
default ListTableRowsResponse listTableRows(Consumer listTableRowsRequest)
throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException,
ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException,
HoneycodeException {
return listTableRows(ListTableRowsRequest.builder().applyMutation(listTableRowsRequest).build());
}
/**
*
* The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.
*
*
*
* This is a variant of {@link #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 Stream
*
*
* {@code
* software.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)} operation.
*
*
* @param listTableRowsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws RequestTimeoutException
* The request timed out.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTableRows
* @see AWS API
* Documentation
*/
default ListTableRowsIterable listTableRowsPaginator(ListTableRowsRequest listTableRowsRequest) throws AccessDeniedException,
InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException,
RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.
*
*
*
* This is a variant of {@link #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 Stream
*
*
* {@code
* software.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListTableRowsRequest.Builder} avoiding the need to
* create one manually via {@link ListTableRowsRequest#builder()}
*
*
* @param listTableRowsRequest
* A {@link Consumer} that will call methods on {@link ListTableRowsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws RequestTimeoutException
* The request timed out.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTableRows
* @see AWS API
* Documentation
*/
default ListTableRowsIterable listTableRowsPaginator(Consumer listTableRowsRequest)
throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException,
ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException,
HoneycodeException {
return listTableRowsPaginator(ListTableRowsRequest.builder().applyMutation(listTableRowsRequest).build());
}
/**
*
* The ListTables API allows you to retrieve a list of all the tables in a workbook.
*
*
* @param listTablesRequest
* @return Result of the ListTables operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTables
* @see AWS API
* Documentation
*/
default ListTablesResponse listTables(ListTablesRequest listTablesRequest) throws AccessDeniedException,
InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException,
ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTablesRequest.Builder} avoiding the need to
* create one manually via {@link ListTablesRequest#builder()}
*
*
* @param listTablesRequest
* A {@link Consumer} that will call methods on {@link ListTablesRequest.Builder} to create a request.
* @return Result of the ListTables operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTables
* @see AWS API
* Documentation
*/
default ListTablesResponse listTables(Consumer listTablesRequest) throws AccessDeniedException,
InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException,
ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException {
return listTables(ListTablesRequest.builder().applyMutation(listTablesRequest).build());
}
/**
*
* The ListTables API allows you to retrieve a list of all the tables in a workbook.
*
*
*
* This is a variant of {@link #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 Stream
*
*
* {@code
* software.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)} operation.
*
*
* @param listTablesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTables
* @see AWS API
* Documentation
*/
default ListTablesIterable listTablesPaginator(ListTablesRequest listTablesRequest) throws AccessDeniedException,
InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException,
ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* The ListTables API allows you to retrieve a list of all the tables in a workbook.
*
*
*
* This is a variant of {@link #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 Stream
*
*
* {@code
* software.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #listTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListTablesRequest.Builder} avoiding the need to
* create one manually via {@link ListTablesRequest#builder()}
*
*
* @param listTablesRequest
* A {@link Consumer} that will call methods on {@link ListTablesRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTables
* @see AWS API
* Documentation
*/
default ListTablesIterable listTablesPaginator(Consumer listTablesRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
return listTablesPaginator(ListTablesRequest.builder().applyMutation(listTablesRequest).build());
}
/**
*
* The ListTagsForResource API allows you to return a resource's tags.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* The ListTagsForResource API allows you to return a resource's tags.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceRequest.Builder} to create a
* request.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws AccessDeniedException,
InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException,
ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.
*
*
* @param queryTableRowsRequest
* @return Result of the QueryTableRows operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.QueryTableRows
* @see AWS API
* Documentation
*/
default QueryTableRowsResponse queryTableRows(QueryTableRowsRequest queryTableRowsRequest) throws AccessDeniedException,
InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException,
ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link QueryTableRowsRequest.Builder} avoiding the need to
* create one manually via {@link QueryTableRowsRequest#builder()}
*
*
* @param queryTableRowsRequest
* A {@link Consumer} that will call methods on {@link QueryTableRowsRequest.Builder} to create a request.
* @return Result of the QueryTableRows operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.QueryTableRows
* @see AWS API
* Documentation
*/
default QueryTableRowsResponse queryTableRows(Consumer queryTableRowsRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
return queryTableRows(QueryTableRowsRequest.builder().applyMutation(queryTableRowsRequest).build());
}
/**
*
* The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.
*
*
*
* This is a variant of
* {@link #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 Stream
*
*
* {@code
* software.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client.queryTableRowsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #queryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)} operation.
*
*
* @param queryTableRowsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.QueryTableRows
* @see AWS API
* Documentation
*/
default QueryTableRowsIterable queryTableRowsPaginator(QueryTableRowsRequest queryTableRowsRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.
*
*
*
* This is a variant of
* {@link #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 Stream
*
*
* {@code
* software.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client.queryTableRowsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @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 directly
*
*
* {@code
* software.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
* {@link #queryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link QueryTableRowsRequest.Builder} avoiding the need to
* create one manually via {@link QueryTableRowsRequest#builder()}
*
*
* @param queryTableRowsRequest
* A {@link Consumer} that will call methods on {@link QueryTableRowsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.QueryTableRows
* @see AWS API
* Documentation
*/
default QueryTableRowsIterable queryTableRowsPaginator(Consumer queryTableRowsRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
return queryTableRowsPaginator(QueryTableRowsRequest.builder().applyMutation(queryTableRowsRequest).build());
}
/**
*
* 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.
*
*
* @param startTableDataImportJobRequest
* @return Result of the StartTableDataImportJob operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws RequestTimeoutException
* The request timed out.
* @throws ServiceQuotaExceededException
* The request caused service quota to be breached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.StartTableDataImportJob
* @see AWS API Documentation
*/
default StartTableDataImportJobResponse startTableDataImportJob(StartTableDataImportJobRequest startTableDataImportJobRequest)
throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException,
ThrottlingException, ValidationException, RequestTimeoutException, ServiceQuotaExceededException,
AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartTableDataImportJobRequest.Builder} avoiding
* the need to create one manually via {@link StartTableDataImportJobRequest#builder()}
*
*
* @param startTableDataImportJobRequest
* A {@link Consumer} that will call methods on {@link StartTableDataImportJobRequest.Builder} to create a
* request.
* @return Result of the StartTableDataImportJob operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws RequestTimeoutException
* The request timed out.
* @throws ServiceQuotaExceededException
* The request caused service quota to be breached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.StartTableDataImportJob
* @see AWS API Documentation
*/
default StartTableDataImportJobResponse startTableDataImportJob(
Consumer startTableDataImportJobRequest) throws AccessDeniedException,
InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException,
ValidationException, RequestTimeoutException, ServiceQuotaExceededException, AwsServiceException, SdkClientException,
HoneycodeException {
return startTableDataImportJob(StartTableDataImportJobRequest.builder().applyMutation(startTableDataImportJobRequest)
.build());
}
/**
*
* The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, screen and
* screen-automation.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AccessDeniedException,
InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException,
ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on {@link TagResourceRequest.Builder} to create a request.
* @return Result of the TagResource operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table,
* screen and screen-automation.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException,
InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException,
ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on {@link UntagResourceRequest.Builder} to create a request.
* @return Result of the UntagResource operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action. Check that the workbook is owned by you and
* your IAM policy allows access to the resource in the request.
* @throws InternalServerException
* There were unexpected errors from the server.
* @throws RequestTimeoutException
* The request timed out.
* @throws ResourceNotFoundException
* A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
* @throws ServiceUnavailableException
* Remote service is unreachable.
* @throws ThrottlingException
* Tps(transactions per second) rate reached.
* @throws ValidationException
* Request is invalid. The message in the response contains details on why the request is invalid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws HoneycodeException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample HoneycodeClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException,
ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException,
HoneycodeException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
* Create a {@link HoneycodeClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static HoneycodeClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link HoneycodeClient}.
*/
static HoneycodeClientBuilder builder() {
return new DefaultHoneycodeClientBuilder();
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
@Override
HoneycodeServiceClientConfiguration serviceClientConfiguration();
}