com.amazonaws.services.timestreamquery

Class AmazonTimestreamQueryClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.timestreamquery.AmazonTimestreamQueryClient

All Implemented Interfaces:

AmazonTimestreamQuery

Direct Known Subclasses:

AmazonTimestreamQueryAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonTimestreamQueryClient
extends AmazonWebServiceClient
implements AmazonTimestreamQuery

Client for accessing Timestream Query. All service calls made using this client are blocking, and will not return until the service call completes.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.timestreamquery.AmazonTimestreamQuery

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonTimestreamQueryClientBuilder	builder()
CancelQueryResult	cancelQuery(CancelQueryRequest request) Cancels a query that has been issued.
DescribeEndpointsResult	describeEndpoints(DescribeEndpointsRequest request) DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
QueryResult	query(QueryRequest request) Query is a synchronous operation that enables you to execute a query.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonTimestreamQueryClientBuilder builder()

cancelQuery

public CancelQueryResult cancelQuery(CancelQueryRequest request)

Cancels a query that has been issued. Cancellation is guaranteed only if the query has not completed execution 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.

Specified by:

cancelQuery in interface AmazonTimestreamQuery

Parameters:

cancelQueryRequest -

Returns:

Result of the CancelQuery operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

InternalServerException - Timestream 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 invalid.

See Also:

AWS API Documentation

describeEndpoints

public DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest request)

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

Because Timestream’s 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:

• 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 to use DescribeEndpoints, see The Endpoint Discovery Pattern and REST APIs.

Specified by:

describeEndpoints in interface AmazonTimestreamQuery

Parameters:

describeEndpointsRequest -

Returns:

Result of the DescribeEndpoints operation returned by the service.

Throws:

InternalServerException - Timestream 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.

See Also:

AWS API Documentation

query

public QueryResult query(QueryRequest request)

Query is a synchronous operation that enables you to execute a query. Query will timeout after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. The result set will be truncated to 1MB. Service quotas apply. For more information, see Quotas in the Timestream Developer Guide.

Specified by:

query in interface AmazonTimestreamQuery

Parameters:

queryRequest -

Returns:

Result of the Query operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform this action.

ConflictException - Unable to poll results for a cancelled query.

InternalServerException - Timestream 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 invalid.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonTimestreamQuery

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonTimestreamQuery

Overrides:

shutdown in class AmazonWebServiceClient