AbstractAmazonTimestreamQuery (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.timestreamquery.AbstractAmazonTimestreamQuery

All Implemented Interfaces:

AmazonTimestreamQuery

Direct Known Subclasses:

AbstractAmazonTimestreamQueryAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonTimestreamQuery
extends Object
implements AmazonTimestreamQuery
```
Abstract implementation of AmazonTimestreamQuery. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.timestreamquery.AmazonTimestreamQuery
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CancelQueryResult`	`cancelQuery(CancelQueryRequest request)` Cancels a query that has been issued.
`CreateScheduledQueryResult`	`createScheduledQuery(CreateScheduledQueryRequest request)` Create a scheduled query that will be run on your behalf at the configured schedule.
`DeleteScheduledQueryResult`	`deleteScheduledQuery(DeleteScheduledQueryRequest request)` Deletes a given scheduled query.
`DescribeAccountSettingsResult`	`describeAccountSettings(DescribeAccountSettingsRequest request)` 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.
`DescribeEndpointsResult`	`describeEndpoints(DescribeEndpointsRequest request)` DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
`DescribeScheduledQueryResult`	`describeScheduledQuery(DescribeScheduledQueryRequest request)` Provides detailed information about a scheduled query.
`ExecuteScheduledQueryResult`	`executeScheduledQuery(ExecuteScheduledQueryRequest request)` You can use this API to run a scheduled query manually.
`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.
`ListScheduledQueriesResult`	`listScheduledQueries(ListScheduledQueriesRequest request)` Gets a list of all scheduled queries in the caller's Amazon account and Region.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` List all tags on a Timestream query resource.
`PrepareQueryResult`	`prepareQuery(PrepareQueryRequest request)` A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running.
`QueryResult`	`query(QueryRequest request)` `Query` is a synchronous operation that enables you to run a query against your Amazon Timestream data.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Associate a set of tags with a Timestream resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the association of tags from a Timestream query resource.
`UpdateAccountSettingsResult`	`updateAccountSettings(UpdateAccountSettingsRequest request)` Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured.
`UpdateScheduledQueryResult`	`updateScheduledQuery(UpdateScheduledQueryRequest request)` Update a scheduled query.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - cancelQuery
```
public CancelQueryResult cancelQuery(CancelQueryRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    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.
    
    Specified by:
    
    cancelQuery in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the CancelQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createScheduledQuery
```
public CreateScheduledQueryResult createScheduledQuery(CreateScheduledQueryRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    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.
    
    Specified by:
    
    createScheduledQuery in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the CreateScheduledQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteScheduledQuery
```
public DeleteScheduledQueryResult deleteScheduledQuery(DeleteScheduledQueryRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    Deletes a given scheduled query. This is an irreversible operation.
    
    Specified by:
    
    deleteScheduledQuery in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the DeleteScheduledQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAccountSettings
```
public DescribeAccountSettingsResult describeAccountSettings(DescribeAccountSettingsRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    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.
    
    Specified by:
    
    describeAccountSettings in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the DescribeAccountSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEndpoints
```
public DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    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.
    Specified by:
    
    describeEndpoints in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the DescribeEndpoints operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeScheduledQuery
```
public DescribeScheduledQueryResult describeScheduledQuery(DescribeScheduledQueryRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    Provides detailed information about a scheduled query.
    
    Specified by:
    
    describeScheduledQuery in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the DescribeScheduledQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - executeScheduledQuery
```
public ExecuteScheduledQueryResult executeScheduledQuery(ExecuteScheduledQueryRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    You can use this API to run a scheduled query manually.
    
    Specified by:
    
    executeScheduledQuery in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the ExecuteScheduledQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listScheduledQueries
```
public ListScheduledQueriesResult listScheduledQueries(ListScheduledQueriesRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    Gets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.
    
    Specified by:
    
    listScheduledQueries in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the ListScheduledQueries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    List all tags on a Timestream query resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - prepareQuery
```
public PrepareQueryResult prepareQuery(PrepareQueryRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    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.
    
    Specified by:
    
    prepareQuery in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the PrepareQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - query
```
public QueryResult query(QueryRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    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.
    Specified by:
    
    query in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the Query operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    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.
    
    Specified by:
    
    tagResource in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    Removes the association of tags from a Timestream query resource.
    
    Specified by:
    
    untagResource in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAccountSettings
```
public UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    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.
    
    Specified by:
    
    updateAccountSettings in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the UpdateAccountSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateScheduledQuery
```
public UpdateScheduledQueryResult updateScheduledQuery(UpdateScheduledQueryRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    Update a scheduled query.
    
    Specified by:
    
    updateScheduledQuery in interface AmazonTimestreamQuery
    
    Returns:
    
    Result of the UpdateScheduledQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonTimestreamQuery
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonTimestreamQuery
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonTimestreamQuery
    
    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 a 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.

AWS SDK for Java 1.x API Reference - 1.12.773

Class AbstractAmazonTimestreamQuery

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

cancelQuery

createScheduledQuery

deleteScheduledQuery

describeAccountSettings

describeEndpoints

describeScheduledQuery

executeScheduledQuery

listScheduledQueries

listTagsForResource

prepareQuery

query

tagResource

untagResource

updateAccountSettings

updateScheduledQuery

shutdown

getCachedResponseMetadata