software.amazon.awssdk.services.timestreamquery.TimestreamQueryAsyncClient Maven / Gradle / Ivy
Show all versions of timestreamquery Show documentation
/*
* 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.timestreamquery;
import java.util.concurrent.CompletableFuture;
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.services.timestreamquery.model.CancelQueryRequest;
import software.amazon.awssdk.services.timestreamquery.model.CancelQueryResponse;
import software.amazon.awssdk.services.timestreamquery.model.CreateScheduledQueryRequest;
import software.amazon.awssdk.services.timestreamquery.model.CreateScheduledQueryResponse;
import software.amazon.awssdk.services.timestreamquery.model.DeleteScheduledQueryRequest;
import software.amazon.awssdk.services.timestreamquery.model.DeleteScheduledQueryResponse;
import software.amazon.awssdk.services.timestreamquery.model.DescribeAccountSettingsRequest;
import software.amazon.awssdk.services.timestreamquery.model.DescribeAccountSettingsResponse;
import software.amazon.awssdk.services.timestreamquery.model.DescribeEndpointsRequest;
import software.amazon.awssdk.services.timestreamquery.model.DescribeEndpointsResponse;
import software.amazon.awssdk.services.timestreamquery.model.DescribeScheduledQueryRequest;
import software.amazon.awssdk.services.timestreamquery.model.DescribeScheduledQueryResponse;
import software.amazon.awssdk.services.timestreamquery.model.ExecuteScheduledQueryRequest;
import software.amazon.awssdk.services.timestreamquery.model.ExecuteScheduledQueryResponse;
import software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest;
import software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesResponse;
import software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.timestreamquery.model.PrepareQueryRequest;
import software.amazon.awssdk.services.timestreamquery.model.PrepareQueryResponse;
import software.amazon.awssdk.services.timestreamquery.model.QueryRequest;
import software.amazon.awssdk.services.timestreamquery.model.QueryResponse;
import software.amazon.awssdk.services.timestreamquery.model.TagResourceRequest;
import software.amazon.awssdk.services.timestreamquery.model.TagResourceResponse;
import software.amazon.awssdk.services.timestreamquery.model.UntagResourceRequest;
import software.amazon.awssdk.services.timestreamquery.model.UntagResourceResponse;
import software.amazon.awssdk.services.timestreamquery.model.UpdateAccountSettingsRequest;
import software.amazon.awssdk.services.timestreamquery.model.UpdateAccountSettingsResponse;
import software.amazon.awssdk.services.timestreamquery.model.UpdateScheduledQueryRequest;
import software.amazon.awssdk.services.timestreamquery.model.UpdateScheduledQueryResponse;
import software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher;
import software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher;
import software.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher;
/**
* Service client for accessing Timestream Query asynchronously. This can be created using the static {@link #builder()}
* method.The asynchronous client performs non-blocking I/O when configured with any {@code SdkAsyncHttpClient}
* supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
* some cases such as credentials retrieval and endpoint discovery as part of the async API call.
*
* Amazon Timestream Query
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface TimestreamQueryAsyncClient extends AwsClient {
String SERVICE_NAME = "timestream";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "query.timestream";
/**
*
* 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.
*
*
* @param cancelQueryRequest
* @return A Java Future containing the result of the CancelQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.CancelQuery
* @see AWS
* API Documentation
*/
default CompletableFuture cancelQuery(CancelQueryRequest cancelQueryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CancelQueryRequest.Builder} avoiding the need to
* create one manually via {@link CancelQueryRequest#builder()}
*
*
* @param cancelQueryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.CancelQueryRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CancelQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.CancelQuery
* @see AWS
* API Documentation
*/
default CompletableFuture cancelQuery(Consumer cancelQueryRequest) {
return cancelQuery(CancelQueryRequest.builder().applyMutation(cancelQueryRequest).build());
}
/**
*
* 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.
*
*
* @param createScheduledQueryRequest
* @return A Java Future containing the result of the CreateScheduledQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - ConflictException Unable to poll results for a cancelled query.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ServiceQuotaExceededException You have exceeded the service quota.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.CreateScheduledQuery
* @see AWS API Documentation
*/
default CompletableFuture createScheduledQuery(
CreateScheduledQueryRequest createScheduledQueryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateScheduledQueryRequest.Builder} avoiding the
* need to create one manually via {@link CreateScheduledQueryRequest#builder()}
*
*
* @param createScheduledQueryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.CreateScheduledQueryRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the CreateScheduledQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - ConflictException Unable to poll results for a cancelled query.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ServiceQuotaExceededException You have exceeded the service quota.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.CreateScheduledQuery
* @see AWS API Documentation
*/
default CompletableFuture createScheduledQuery(
Consumer createScheduledQueryRequest) {
return createScheduledQuery(CreateScheduledQueryRequest.builder().applyMutation(createScheduledQueryRequest).build());
}
/**
*
* Deletes a given scheduled query. This is an irreversible operation.
*
*
* @param deleteScheduledQueryRequest
* @return A Java Future containing the result of the DeleteScheduledQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ResourceNotFoundException The requested resource could not be found.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.DeleteScheduledQuery
* @see AWS API Documentation
*/
default CompletableFuture deleteScheduledQuery(
DeleteScheduledQueryRequest deleteScheduledQueryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a given scheduled query. This is an irreversible operation.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteScheduledQueryRequest.Builder} avoiding the
* need to create one manually via {@link DeleteScheduledQueryRequest#builder()}
*
*
* @param deleteScheduledQueryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.DeleteScheduledQueryRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeleteScheduledQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ResourceNotFoundException The requested resource could not be found.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.DeleteScheduledQuery
* @see AWS API Documentation
*/
default CompletableFuture deleteScheduledQuery(
Consumer deleteScheduledQueryRequest) {
return deleteScheduledQuery(DeleteScheduledQueryRequest.builder().applyMutation(deleteScheduledQueryRequest).build());
}
/**
*
* Describes the settings for your account that include the query pricing model and the configured maximum TCUs the
* service can use for your query workload.
*
*
* You're charged only for the duration of compute units used for your workloads.
*
*
* @param describeAccountSettingsRequest
* @return A Java Future containing the result of the DescribeAccountSettings operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ThrottlingException The request was denied due to request throttling.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.DescribeAccountSettings
* @see AWS API Documentation
*/
default CompletableFuture describeAccountSettings(
DescribeAccountSettingsRequest describeAccountSettingsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the settings for your account that include the query pricing model and the configured maximum TCUs the
* service can use for your query workload.
*
*
* You're charged only for the duration of compute units used for your workloads.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAccountSettingsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeAccountSettingsRequest#builder()}
*
*
* @param describeAccountSettingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.DescribeAccountSettingsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeAccountSettings operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ThrottlingException The request was denied due to request throttling.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.DescribeAccountSettings
* @see AWS API Documentation
*/
default CompletableFuture describeAccountSettings(
Consumer describeAccountSettingsRequest) {
return describeAccountSettings(DescribeAccountSettingsRequest.builder().applyMutation(describeAccountSettingsRequest)
.build());
}
/**
*
* 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.
*
*
* @param describeEndpointsRequest
* @return A Java Future containing the result of the DescribeEndpoints operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ValidationException Invalid or malformed request.
* - ThrottlingException The request was denied due to request throttling.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.DescribeEndpoints
* @see AWS API Documentation
*/
default CompletableFuture describeEndpoints(DescribeEndpointsRequest describeEndpointsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeEndpointsRequest.Builder} avoiding the need
* to create one manually via {@link DescribeEndpointsRequest#builder()}
*
*
* @param describeEndpointsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.DescribeEndpointsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeEndpoints operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ValidationException Invalid or malformed request.
* - ThrottlingException The request was denied due to request throttling.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.DescribeEndpoints
* @see AWS API Documentation
*/
default CompletableFuture describeEndpoints(
Consumer describeEndpointsRequest) {
return describeEndpoints(DescribeEndpointsRequest.builder().applyMutation(describeEndpointsRequest).build());
}
/**
*
* Provides detailed information about a scheduled query.
*
*
* @param describeScheduledQueryRequest
* @return A Java Future containing the result of the DescribeScheduledQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ResourceNotFoundException The requested resource could not be found.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.DescribeScheduledQuery
* @see AWS API Documentation
*/
default CompletableFuture describeScheduledQuery(
DescribeScheduledQueryRequest describeScheduledQueryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Provides detailed information about a scheduled query.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeScheduledQueryRequest.Builder} avoiding the
* need to create one manually via {@link DescribeScheduledQueryRequest#builder()}
*
*
* @param describeScheduledQueryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.DescribeScheduledQueryRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribeScheduledQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ResourceNotFoundException The requested resource could not be found.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.DescribeScheduledQuery
* @see AWS API Documentation
*/
default CompletableFuture describeScheduledQuery(
Consumer describeScheduledQueryRequest) {
return describeScheduledQuery(DescribeScheduledQueryRequest.builder().applyMutation(describeScheduledQueryRequest)
.build());
}
/**
*
* You can use this API to run a scheduled query manually.
*
*
* @param executeScheduledQueryRequest
* @return A Java Future containing the result of the ExecuteScheduledQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ResourceNotFoundException The requested resource could not be found.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.ExecuteScheduledQuery
* @see AWS API Documentation
*/
default CompletableFuture executeScheduledQuery(
ExecuteScheduledQueryRequest executeScheduledQueryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* You can use this API to run a scheduled query manually.
*
*
*
* This is a convenience which creates an instance of the {@link ExecuteScheduledQueryRequest.Builder} avoiding the
* need to create one manually via {@link ExecuteScheduledQueryRequest#builder()}
*
*
* @param executeScheduledQueryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.ExecuteScheduledQueryRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ExecuteScheduledQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ResourceNotFoundException The requested resource could not be found.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.ExecuteScheduledQuery
* @see AWS API Documentation
*/
default CompletableFuture executeScheduledQuery(
Consumer executeScheduledQueryRequest) {
return executeScheduledQuery(ExecuteScheduledQueryRequest.builder().applyMutation(executeScheduledQueryRequest).build());
}
/**
*
* Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries
* is eventually consistent.
*
*
* @param listScheduledQueriesRequest
* @return A Java Future containing the result of the ListScheduledQueries operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.ListScheduledQueries
* @see AWS API Documentation
*/
default CompletableFuture listScheduledQueries(
ListScheduledQueriesRequest listScheduledQueriesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListScheduledQueriesRequest.Builder} avoiding the
* need to create one manually via {@link ListScheduledQueriesRequest#builder()}
*
*
* @param listScheduledQueriesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListScheduledQueries operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.ListScheduledQueries
* @see AWS API Documentation
*/
default CompletableFuture listScheduledQueries(
Consumer listScheduledQueriesRequest) {
return listScheduledQueries(ListScheduledQueriesRequest.builder().applyMutation(listScheduledQueriesRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher publisher = client.listScheduledQueriesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher publisher = client.listScheduledQueriesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)}
* operation.
*
*
* @param listScheduledQueriesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.ListScheduledQueries
* @see AWS API Documentation
*/
default ListScheduledQueriesPublisher listScheduledQueriesPaginator(ListScheduledQueriesRequest listScheduledQueriesRequest) {
return new ListScheduledQueriesPublisher(this, listScheduledQueriesRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher publisher = client.listScheduledQueriesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.timestreamquery.paginators.ListScheduledQueriesPublisher publisher = client.listScheduledQueriesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listScheduledQueries(software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListScheduledQueriesRequest.Builder} avoiding the
* need to create one manually via {@link ListScheduledQueriesRequest#builder()}
*
*
* @param listScheduledQueriesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.ListScheduledQueriesRequest.Builder} to
* create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.ListScheduledQueries
* @see AWS API Documentation
*/
default ListScheduledQueriesPublisher listScheduledQueriesPaginator(
Consumer listScheduledQueriesRequest) {
return listScheduledQueriesPaginator(ListScheduledQueriesRequest.builder().applyMutation(listScheduledQueriesRequest)
.build());
}
/**
*
* List all tags on a Timestream query resource.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The requested resource could not be found.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* List all tags on a Timestream query resource.
*
*
*
* 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 software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The requested resource could not be found.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)}
* operation.
*
*
* @param listTagsForResourceRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The requested resource could not be found.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) {
return new ListTagsForResourcePublisher(this, listTagsForResourceRequest);
}
/**
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.timestreamquery.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #listTagsForResource(software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest)}
* operation.
*
*
*
* 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 software.amazon.awssdk.services.timestreamquery.model.ListTagsForResourceRequest.Builder} to create
* a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The requested resource could not be found.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.ListTagsForResource
* @see AWS API Documentation
*/
default ListTagsForResourcePublisher listTagsForResourcePaginator(
Consumer listTagsForResourceRequest) {
return listTagsForResourcePaginator(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest)
.build());
}
/**
*
* 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 ValidateOnly set to true.
*
*
* @param prepareQueryRequest
* @return A Java Future containing the result of the PrepareQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.PrepareQuery
* @see AWS
* API Documentation
*/
default CompletableFuture prepareQuery(PrepareQueryRequest prepareQueryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 ValidateOnly set to true.
*
*
*
* This is a convenience which creates an instance of the {@link PrepareQueryRequest.Builder} avoiding the need to
* create one manually via {@link PrepareQueryRequest#builder()}
*
*
* @param prepareQueryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.PrepareQueryRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PrepareQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.PrepareQuery
* @see AWS
* API Documentation
*/
default CompletableFuture prepareQuery(Consumer prepareQueryRequest) {
return prepareQuery(PrepareQueryRequest.builder().applyMutation(prepareQueryRequest).build());
}
/**
*
* 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.
*
*
*
*
* @param queryRequest
* @return A Java Future containing the result of the Query operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - ConflictException Unable to poll results for a cancelled query.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - QueryExecutionException Timestream was unable to run the query successfully.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.Query
* @see AWS API
* Documentation
*/
default CompletableFuture query(QueryRequest queryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link QueryRequest.Builder} avoiding the need to create
* one manually via {@link QueryRequest#builder()}
*
*
* @param queryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.QueryRequest.Builder} to create a request.
* @return A Java Future containing the result of the Query operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - ConflictException Unable to poll results for a cancelled query.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - QueryExecutionException Timestream was unable to run the query successfully.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.Query
* @see AWS API
* Documentation
*/
default CompletableFuture query(Consumer queryRequest) {
return query(QueryRequest.builder().applyMutation(queryRequest).build());
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher publisher = client.queryPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher publisher = client.queryPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #query(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)} operation.
*
*
* @param queryRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - ConflictException Unable to poll results for a cancelled query.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - QueryExecutionException Timestream was unable to run the query successfully.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.Query
* @see AWS API
* Documentation
*/
default QueryPublisher queryPaginator(QueryRequest queryRequest) {
return new QueryPublisher(this, queryRequest);
}
/**
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.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
*
*
* {@code
* software.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher publisher = client.queryPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.timestreamquery.paginators.QueryPublisher publisher = client.queryPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* 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
* {@link #query(software.amazon.awssdk.services.timestreamquery.model.QueryRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link QueryRequest.Builder} avoiding the need to create
* one manually via {@link QueryRequest#builder()}
*
*
* @param queryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.QueryRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - ConflictException Unable to poll results for a cancelled query.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - QueryExecutionException Timestream was unable to run the query successfully.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.Query
* @see AWS API
* Documentation
*/
default QueryPublisher queryPaginator(Consumer queryRequest) {
return queryPaginator(QueryRequest.builder().applyMutation(queryRequest).build());
}
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The requested resource could not be found.
* - ServiceQuotaExceededException You have exceeded the service quota.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.TagResource
* @see AWS
* API Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@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 software.amazon.awssdk.services.timestreamquery.model.TagResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ResourceNotFoundException The requested resource could not be found.
* - ServiceQuotaExceededException You have exceeded the service quota.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.TagResource
* @see AWS
* API Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes the association of tags from a Timestream query resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ValidationException Invalid or malformed request.
* - ThrottlingException The request was denied due to request throttling.
* - ResourceNotFoundException The requested resource could not be found.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.UntagResource
* @see AWS API Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes the association of tags from a Timestream query resource.
*
*
*
* 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 software.amazon.awssdk.services.timestreamquery.model.UntagResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - ValidationException Invalid or malformed request.
* - ThrottlingException The request was denied due to request throttling.
* - ResourceNotFoundException The requested resource could not be found.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.UntagResource
* @see AWS API Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've
* configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can
* take up to 24 hours to be effective.
*
*
*
* After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned
* for query pricing.
*
*
*
* @param updateAccountSettingsRequest
* @return A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.UpdateAccountSettings
* @see AWS API Documentation
*/
default CompletableFuture updateAccountSettings(
UpdateAccountSettingsRequest updateAccountSettingsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've
* configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can
* take up to 24 hours to be effective.
*
*
*
* After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned
* for query pricing.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateAccountSettingsRequest.Builder} avoiding the
* need to create one manually via {@link UpdateAccountSettingsRequest#builder()}
*
*
* @param updateAccountSettingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.UpdateAccountSettingsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the UpdateAccountSettings operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.UpdateAccountSettings
* @see AWS API Documentation
*/
default CompletableFuture updateAccountSettings(
Consumer updateAccountSettingsRequest) {
return updateAccountSettings(UpdateAccountSettingsRequest.builder().applyMutation(updateAccountSettingsRequest).build());
}
/**
*
* Update a scheduled query.
*
*
* @param updateScheduledQueryRequest
* @return A Java Future containing the result of the UpdateScheduledQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ResourceNotFoundException The requested resource could not be found.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.UpdateScheduledQuery
* @see AWS API Documentation
*/
default CompletableFuture updateScheduledQuery(
UpdateScheduledQueryRequest updateScheduledQueryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Update a scheduled query.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateScheduledQueryRequest.Builder} avoiding the
* need to create one manually via {@link UpdateScheduledQueryRequest#builder()}
*
*
* @param updateScheduledQueryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.timestreamquery.model.UpdateScheduledQueryRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the UpdateScheduledQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - AccessDeniedException You are not authorized to perform this action.
* - InternalServerException The service was unable to fully process this request because of an internal
* server error.
* - ResourceNotFoundException The requested resource could not be found.
* - ThrottlingException The request was denied due to request throttling.
* - ValidationException Invalid or malformed request.
* - InvalidEndpointException The requested endpoint was not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - TimestreamQueryException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample TimestreamQueryAsyncClient.UpdateScheduledQuery
* @see AWS API Documentation
*/
default CompletableFuture updateScheduledQuery(
Consumer updateScheduledQueryRequest) {
return updateScheduledQuery(UpdateScheduledQueryRequest.builder().applyMutation(updateScheduledQueryRequest).build());
}
@Override
default TimestreamQueryServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link TimestreamQueryAsyncClient} 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 TimestreamQueryAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link TimestreamQueryAsyncClient}.
*/
static TimestreamQueryAsyncClientBuilder builder() {
return new DefaultTimestreamQueryAsyncClientBuilder();
}
}