@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface TimestreamQueryAsyncClient extends AwsClient
builder()
method.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static TimestreamQueryAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
TimestreamQueryAsyncClient. |
default CompletableFuture<CancelQueryResponse> |
cancelQuery(CancelQueryRequest cancelQueryRequest)
Cancels a query that has been issued.
|
default CompletableFuture<CancelQueryResponse> |
cancelQuery(Consumer<CancelQueryRequest.Builder> cancelQueryRequest)
Cancels a query that has been issued.
|
static TimestreamQueryAsyncClient |
create()
Create a
TimestreamQueryAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateScheduledQueryResponse> |
createScheduledQuery(Consumer<CreateScheduledQueryRequest.Builder> createScheduledQueryRequest)
Create a scheduled query that will be run on your behalf at the configured schedule.
|
default CompletableFuture<CreateScheduledQueryResponse> |
createScheduledQuery(CreateScheduledQueryRequest createScheduledQueryRequest)
Create a scheduled query that will be run on your behalf at the configured schedule.
|
default CompletableFuture<DeleteScheduledQueryResponse> |
deleteScheduledQuery(Consumer<DeleteScheduledQueryRequest.Builder> deleteScheduledQueryRequest)
Deletes a given scheduled query.
|
default CompletableFuture<DeleteScheduledQueryResponse> |
deleteScheduledQuery(DeleteScheduledQueryRequest deleteScheduledQueryRequest)
Deletes a given scheduled query.
|
default CompletableFuture<DescribeEndpointsResponse> |
describeEndpoints(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest)
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
|
default CompletableFuture<DescribeEndpointsResponse> |
describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
|
default CompletableFuture<DescribeScheduledQueryResponse> |
describeScheduledQuery(Consumer<DescribeScheduledQueryRequest.Builder> describeScheduledQueryRequest)
Provides detailed information about a scheduled query.
|
default CompletableFuture<DescribeScheduledQueryResponse> |
describeScheduledQuery(DescribeScheduledQueryRequest describeScheduledQueryRequest)
Provides detailed information about a scheduled query.
|
default CompletableFuture<ExecuteScheduledQueryResponse> |
executeScheduledQuery(Consumer<ExecuteScheduledQueryRequest.Builder> executeScheduledQueryRequest)
You can use this API to run a scheduled query manually.
|
default CompletableFuture<ExecuteScheduledQueryResponse> |
executeScheduledQuery(ExecuteScheduledQueryRequest executeScheduledQueryRequest)
You can use this API to run a scheduled query manually.
|
default CompletableFuture<ListScheduledQueriesResponse> |
listScheduledQueries(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest)
Gets a list of all scheduled queries in the caller's Amazon account and Region.
|
default CompletableFuture<ListScheduledQueriesResponse> |
listScheduledQueries(ListScheduledQueriesRequest listScheduledQueriesRequest)
Gets a list of all scheduled queries in the caller's Amazon account and Region.
|
default ListScheduledQueriesPublisher |
listScheduledQueriesPaginator(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest)
Gets a list of all scheduled queries in the caller's Amazon account and Region.
|
default ListScheduledQueriesPublisher |
listScheduledQueriesPaginator(ListScheduledQueriesRequest listScheduledQueriesRequest)
Gets a list of all scheduled queries in the caller's Amazon account and Region.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List all tags on a Timestream query resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags on a Timestream query resource.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List all tags on a Timestream query resource.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags on a Timestream query resource.
|
default CompletableFuture<PrepareQueryResponse> |
prepareQuery(Consumer<PrepareQueryRequest.Builder> prepareQueryRequest)
A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later
running.
|
default CompletableFuture<PrepareQueryResponse> |
prepareQuery(PrepareQueryRequest prepareQueryRequest)
A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later
running.
|
default CompletableFuture<QueryResponse> |
query(Consumer<QueryRequest.Builder> queryRequest)
Query is a synchronous operation that enables you to run a query against your Amazon Timestream
data. |
default CompletableFuture<QueryResponse> |
query(QueryRequest queryRequest)
Query is a synchronous operation that enables you to run a query against your Amazon Timestream
data. |
default QueryPublisher |
queryPaginator(Consumer<QueryRequest.Builder> queryRequest)
Query is a synchronous operation that enables you to run a query against your Amazon Timestream
data. |
default QueryPublisher |
queryPaginator(QueryRequest queryRequest)
Query is a synchronous operation that enables you to run a query against your Amazon Timestream
data. |
default TimestreamQueryServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associate a set of tags with a Timestream resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Associate a set of tags with a Timestream resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the association of tags from a Timestream query resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the association of tags from a Timestream query resource.
|
default CompletableFuture<UpdateScheduledQueryResponse> |
updateScheduledQuery(Consumer<UpdateScheduledQueryRequest.Builder> updateScheduledQueryRequest)
Update a scheduled query.
|
default CompletableFuture<UpdateScheduledQueryResponse> |
updateScheduledQuery(UpdateScheduledQueryRequest updateScheduledQueryRequest)
Update a scheduled query.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CancelQueryResponse> cancelQuery(CancelQueryRequest cancelQueryRequest)
Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before
the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation
requests will return a CancellationMessage, indicating that the query has already been canceled. See
code
sample for details.
cancelQueryRequest - default CompletableFuture<CancelQueryResponse> cancelQuery(Consumer<CancelQueryRequest.Builder> cancelQueryRequest)
Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before
the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation
requests will return a CancellationMessage, indicating that the query has already been canceled. See
code
sample for details.
This is a convenience which creates an instance of the CancelQueryRequest.Builder avoiding the need to
create one manually via CancelQueryRequest.builder()
cancelQueryRequest - A Consumer that will call methods on CancelQueryRequest.Builder to create a request.default CompletableFuture<CreateScheduledQueryResponse> createScheduledQuery(CreateScheduledQueryRequest createScheduledQueryRequest)
Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the
execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query.
You can use the NotificationConfiguration parameter to configure notification for your scheduled
query operations.
createScheduledQueryRequest - default CompletableFuture<CreateScheduledQueryResponse> createScheduledQuery(Consumer<CreateScheduledQueryRequest.Builder> createScheduledQueryRequest)
Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the
execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query.
You can use the NotificationConfiguration parameter to configure notification for your scheduled
query operations.
This is a convenience which creates an instance of the CreateScheduledQueryRequest.Builder avoiding the
need to create one manually via CreateScheduledQueryRequest.builder()
createScheduledQueryRequest - A Consumer that will call methods on CreateScheduledQueryRequest.Builder to create a
request.default CompletableFuture<DeleteScheduledQueryResponse> deleteScheduledQuery(DeleteScheduledQueryRequest deleteScheduledQueryRequest)
Deletes a given scheduled query. This is an irreversible operation.
deleteScheduledQueryRequest - default CompletableFuture<DeleteScheduledQueryResponse> deleteScheduledQuery(Consumer<DeleteScheduledQueryRequest.Builder> deleteScheduledQueryRequest)
Deletes a given scheduled query. This is an irreversible operation.
This is a convenience which creates an instance of the DeleteScheduledQueryRequest.Builder avoiding the
need to create one manually via DeleteScheduledQueryRequest.builder()
deleteScheduledQueryRequest - A Consumer that will call methods on DeleteScheduledQueryRequest.Builder to create a
request.default CompletableFuture<DescribeEndpointsResponse> describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest)
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.
Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless:
You are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream
Your application uses a programming language that does not yet have SDK support
You require better control over the client-side implementation
For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.
describeEndpointsRequest - default CompletableFuture<DescribeEndpointsResponse> describeEndpoints(Consumer<DescribeEndpointsRequest.Builder> describeEndpointsRequest)
DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.
Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, it is not recommended that you use this API unless:
You are using VPC endpoints (Amazon Web Services PrivateLink) with Timestream
Your application uses a programming language that does not yet have SDK support
You require better control over the client-side implementation
For detailed information on how and when to use and implement DescribeEndpoints, see The Endpoint Discovery Pattern.
This is a convenience which creates an instance of the DescribeEndpointsRequest.Builder avoiding the need
to create one manually via DescribeEndpointsRequest.builder()
describeEndpointsRequest - A Consumer that will call methods on DescribeEndpointsRequest.Builder to create a request.default CompletableFuture<DescribeScheduledQueryResponse> describeScheduledQuery(DescribeScheduledQueryRequest describeScheduledQueryRequest)
Provides detailed information about a scheduled query.
describeScheduledQueryRequest - default CompletableFuture<DescribeScheduledQueryResponse> describeScheduledQuery(Consumer<DescribeScheduledQueryRequest.Builder> describeScheduledQueryRequest)
Provides detailed information about a scheduled query.
This is a convenience which creates an instance of the DescribeScheduledQueryRequest.Builder avoiding the
need to create one manually via DescribeScheduledQueryRequest.builder()
describeScheduledQueryRequest - A Consumer that will call methods on DescribeScheduledQueryRequest.Builder to create a
request.default CompletableFuture<ExecuteScheduledQueryResponse> executeScheduledQuery(ExecuteScheduledQueryRequest executeScheduledQueryRequest)
You can use this API to run a scheduled query manually.
executeScheduledQueryRequest - default CompletableFuture<ExecuteScheduledQueryResponse> executeScheduledQuery(Consumer<ExecuteScheduledQueryRequest.Builder> executeScheduledQueryRequest)
You can use this API to run a scheduled query manually.
This is a convenience which creates an instance of the ExecuteScheduledQueryRequest.Builder avoiding the
need to create one manually via ExecuteScheduledQueryRequest.builder()
executeScheduledQueryRequest - A Consumer that will call methods on ExecuteScheduledQueryRequest.Builder to create a
request.default CompletableFuture<ListScheduledQueriesResponse> listScheduledQueries(ListScheduledQueriesRequest listScheduledQueriesRequest)
Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries
is eventually consistent.
listScheduledQueriesRequest - default CompletableFuture<ListScheduledQueriesResponse> listScheduledQueries(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest)
Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries
is eventually consistent.
This is a convenience which creates an instance of the ListScheduledQueriesRequest.Builder avoiding the
need to create one manually via ListScheduledQueriesRequest.builder()
listScheduledQueriesRequest - A Consumer that will call methods on ListScheduledQueriesRequest.Builder to create a
request.default ListScheduledQueriesPublisher listScheduledQueriesPaginator(ListScheduledQueriesRequest listScheduledQueriesRequest)
Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries
is eventually consistent.
This is a variant of
listScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher publisher = client.listScheduledQueriesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher publisher = client.listScheduledQueriesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)
operation.
listScheduledQueriesRequest - default ListScheduledQueriesPublisher listScheduledQueriesPaginator(Consumer<ListScheduledQueriesRequest.Builder> listScheduledQueriesRequest)
Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries
is eventually consistent.
This is a variant of
listScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher publisher = client.listScheduledQueriesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher publisher = client.listScheduledQueriesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)
operation.
This is a convenience which creates an instance of the ListScheduledQueriesRequest.Builder avoiding the
need to create one manually via ListScheduledQueriesRequest.builder()
listScheduledQueriesRequest - A Consumer that will call methods on ListScheduledQueriesRequest.Builder to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags on a Timestream query resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List all tags on a Timestream query resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags on a Timestream query resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)
operation.
listTagsForResourceRequest - default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List all tags on a Timestream query resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<PrepareQueryResponse> prepareQuery(PrepareQueryRequest prepareQueryRequest)
A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later
running. Timestream only supports using this operation with the PrepareQueryRequest$ValidateOnly
set to true.
prepareQueryRequest - default CompletableFuture<PrepareQueryResponse> prepareQuery(Consumer<PrepareQueryRequest.Builder> prepareQueryRequest)
A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later
running. Timestream only supports using this operation with the PrepareQueryRequest$ValidateOnly
set to true.
This is a convenience which creates an instance of the PrepareQueryRequest.Builder avoiding the need to
create one manually via PrepareQueryRequest.builder()
prepareQueryRequest - A Consumer that will call methods on PrepareQueryRequest.Builder to create a request.default CompletableFuture<QueryResponse> query(QueryRequest queryRequest)
Query is a synchronous operation that enables you to run a query against your Amazon Timestream
data. Query will time out after 60 seconds. You must update the default timeout in the SDK to
support a timeout of 60 seconds. See the code sample
for details.
Your query request will fail in the following cases:
If you submit a Query request with the same client token outside of the 5-minute idempotency window.
If you submit a Query request with the same client token, but change other parameters, within the
5-minute idempotency window.
If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message:
Query aborted as max page response size has been exceeded by the output result row
If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and
the result reader do not have the same query string in the query requests, the query will fail with an
Invalid pagination token error.
queryRequest - default CompletableFuture<QueryResponse> query(Consumer<QueryRequest.Builder> queryRequest)
Query is a synchronous operation that enables you to run a query against your Amazon Timestream
data. Query will time out after 60 seconds. You must update the default timeout in the SDK to
support a timeout of 60 seconds. See the code sample
for details.
Your query request will fail in the following cases:
If you submit a Query request with the same client token outside of the 5-minute idempotency window.
If you submit a Query request with the same client token, but change other parameters, within the
5-minute idempotency window.
If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message:
Query aborted as max page response size has been exceeded by the output result row
If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and
the result reader do not have the same query string in the query requests, the query will fail with an
Invalid pagination token error.
This is a convenience which creates an instance of the QueryRequest.Builder avoiding the need to create
one manually via QueryRequest.builder()
queryRequest - A Consumer that will call methods on QueryRequest.Builder to create a request.default QueryPublisher queryPaginator(QueryRequest queryRequest)
Query is a synchronous operation that enables you to run a query against your Amazon Timestream
data. Query will time out after 60 seconds. You must update the default timeout in the SDK to
support a timeout of 60 seconds. See the code sample
for details.
Your query request will fail in the following cases:
If you submit a Query request with the same client token outside of the 5-minute idempotency window.
If you submit a Query request with the same client token, but change other parameters, within the
5-minute idempotency window.
If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message:
Query aborted as max page response size has been exceeded by the output result row
If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and
the result reader do not have the same query string in the query requests, the query will fail with an
Invalid pagination token error.
This is a variant of query(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher publisher = client.queryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher publisher = client.queryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamquery.model.QueryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.timestreamquery.model.QueryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxRows 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
query(software.amazon.awssdk.services.timestreamquery.model.QueryRequest) operation.
queryRequest - default QueryPublisher queryPaginator(Consumer<QueryRequest.Builder> queryRequest)
Query is a synchronous operation that enables you to run a query against your Amazon Timestream
data. Query will time out after 60 seconds. You must update the default timeout in the SDK to
support a timeout of 60 seconds. See the code sample
for details.
Your query request will fail in the following cases:
If you submit a Query request with the same client token outside of the 5-minute idempotency window.
If you submit a Query request with the same client token, but change other parameters, within the
5-minute idempotency window.
If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message:
Query aborted as max page response size has been exceeded by the output result row
If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and
the result reader do not have the same query string in the query requests, the query will fail with an
Invalid pagination token error.
This is a variant of query(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher publisher = client.queryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher publisher = client.queryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreamquery.model.QueryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.timestreamquery.model.QueryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxRows 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
query(software.amazon.awssdk.services.timestreamquery.model.QueryRequest) operation.
This is a convenience which creates an instance of the QueryRequest.Builder avoiding the need to create
one manually via QueryRequest.builder()
queryRequest - A Consumer that will call methods on QueryRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes the association of tags from a Timestream query resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the association of tags from a Timestream query resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateScheduledQueryResponse> updateScheduledQuery(UpdateScheduledQueryRequest updateScheduledQueryRequest)
Update a scheduled query.
updateScheduledQueryRequest - default CompletableFuture<UpdateScheduledQueryResponse> updateScheduledQuery(Consumer<UpdateScheduledQueryRequest.Builder> updateScheduledQueryRequest)
Update a scheduled query.
This is a convenience which creates an instance of the UpdateScheduledQueryRequest.Builder avoiding the
need to create one manually via UpdateScheduledQueryRequest.builder()
updateScheduledQueryRequest - A Consumer that will call methods on UpdateScheduledQueryRequest.Builder to create a
request.default TimestreamQueryServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic TimestreamQueryAsyncClient create()
TimestreamQueryAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static TimestreamQueryAsyncClientBuilder builder()
TimestreamQueryAsyncClient.Copyright © 2023. All rights reserved.