AbstractAmazonTimestreamWrite (AWS Java SDK for Amazon Timestream Write 1.12.450 API)

java.lang.Object
- com.amazonaws.services.timestreamwrite.AbstractAmazonTimestreamWrite

All Implemented Interfaces:

AmazonTimestreamWrite

Direct Known Subclasses:

AbstractAmazonTimestreamWriteAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonTimestreamWrite
extends Object
implements AmazonTimestreamWrite
```
Abstract implementation of AmazonTimestreamWrite. 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.timestreamwrite.AmazonTimestreamWrite
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAmazonTimestreamWrite()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAmazonTimestreamWrite()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateBatchLoadTaskResult`	`createBatchLoadTask(CreateBatchLoadTaskRequest request)` Creates a new Timestream batch load task.
`CreateDatabaseResult`	`createDatabase(CreateDatabaseRequest request)` Creates a new Timestream database.
`CreateTableResult`	`createTable(CreateTableRequest request)` Adds a new table to an existing database in your account.
`DeleteDatabaseResult`	`deleteDatabase(DeleteDatabaseRequest request)` Deletes a given Timestream database.
`DeleteTableResult`	`deleteTable(DeleteTableRequest request)` Deletes a given Timestream table.
`DescribeBatchLoadTaskResult`	`describeBatchLoadTask(DescribeBatchLoadTaskRequest request)` Returns information about the batch load task, including configurations, mappings, progress, and other details.
`DescribeDatabaseResult`	`describeDatabase(DescribeDatabaseRequest request)` Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database.
`DescribeEndpointsResult`	`describeEndpoints(DescribeEndpointsRequest request)` Returns a list of available endpoints to make Timestream API calls against.
`DescribeTableResult`	`describeTable(DescribeTableRequest request)` Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store.
`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.
`ListBatchLoadTasksResult`	`listBatchLoadTasks(ListBatchLoadTasksRequest request)` Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details.
`ListDatabasesResult`	`listDatabases(ListDatabasesRequest request)` Returns a list of your Timestream databases.
`ListTablesResult`	`listTables(ListTablesRequest request)` Provides a list of tables, along with the name, status, and retention properties of each table.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists all tags on a Timestream resource.
`ResumeBatchLoadTaskResult`	`resumeBatchLoadTask(ResumeBatchLoadTaskRequest request)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Associates a set of tags with a Timestream resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the association of tags from a Timestream resource.
`UpdateDatabaseResult`	`updateDatabase(UpdateDatabaseRequest request)` Modifies the KMS key for an existing database.
`UpdateTableResult`	`updateTable(UpdateTableRequest request)` Modifies the retention duration of the memory store and magnetic store for your Timestream table.
`WriteRecordsResult`	`writeRecords(WriteRecordsRequest request)` Enables you to write your time-series data into Timestream.

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

- Constructor Detail
  - AbstractAmazonTimestreamWrite
```
protected AbstractAmazonTimestreamWrite()
```
- Method Detail
  - createBatchLoadTask
```
public CreateBatchLoadTaskResult createBatchLoadTask(CreateBatchLoadTaskRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Creates a new Timestream batch load task. A batch load task processes data from a CSV source in an S3 location and writes to a Timestream table. A mapping from source to target is defined in a batch load task. Errors and events are written to a report at an S3 location. For the report, if the KMS key is not specified, the batch load task will be encrypted with a Timestream managed KMS key located in your account. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.
    
    Specified by:
    
    createBatchLoadTask in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the CreateBatchLoadTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDatabase
```
public CreateDatabaseResult createDatabase(CreateDatabaseRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.
    
    Specified by:
    
    createDatabase in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the CreateDatabase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTable
```
public CreateTableResult createTable(CreateTableRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same database. You might have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. Service quotas apply. See code sample for details.
    
    Specified by:
    
    createTable in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the CreateTable operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDatabase
```
public DeleteDatabaseResult deleteDatabase(DeleteDatabaseRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Deletes a given Timestream database. This is an irreversible operation. After a database is deleted, the time-series data from its tables cannot be recovered.
    
    All tables in the database must be deleted first, or a ValidationException error will be thrown.
    
    Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
    
    See code sample for details.
    
    Specified by:
    
    deleteDatabase in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the DeleteDatabase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTable
```
public DeleteTableResult deleteTable(DeleteTableRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Deletes a given Timestream table. This is an irreversible operation. After a Timestream database table is deleted, the time-series data stored in the table cannot be recovered.
    
    Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.
    
    See code sample for details.
    
    Specified by:
    
    deleteTable in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the DeleteTable operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeBatchLoadTask
```
public DescribeBatchLoadTaskResult describeBatchLoadTask(DescribeBatchLoadTaskRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Returns information about the batch load task, including configurations, mappings, progress, and other details. Service quotas apply. See code sample for details.
    
    Specified by:
    
    describeBatchLoadTask in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the DescribeBatchLoadTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDatabase
```
public DescribeDatabaseResult describeDatabase(DescribeDatabaseRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply. See code sample for details.
    
    Specified by:
    
    describeDatabase in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the DescribeDatabase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEndpoints
```
public DescribeEndpointsResult describeEndpoints(DescribeEndpointsRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    Returns a list of available endpoints to make Timestream API calls against. This API operation is available through both the Write and Query APIs.
    
    Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, we don't recommend that you use this API operation 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 AmazonTimestreamWrite
    
    Returns:
    
    Result of the DescribeEndpoints operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTable
```
public DescribeTableResult describeTable(DescribeTableRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply. See code sample for details.
    
    Specified by:
    
    describeTable in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the DescribeTable operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listBatchLoadTasks
```
public ListBatchLoadTasksResult listBatchLoadTasks(ListBatchLoadTasksRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See code sample for details.
    
    Specified by:
    
    listBatchLoadTasks in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the ListBatchLoadTasks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDatabases
```
public ListDatabasesResult listDatabases(ListDatabasesRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Returns a list of your Timestream databases. Service quotas apply. See code sample for details.
    
    Specified by:
    
    listDatabases in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the ListDatabases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTables
```
public ListTablesResult listTables(ListTablesRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Provides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.
    
    Specified by:
    
    listTables in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the ListTables operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Lists all tags on a Timestream resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - resumeBatchLoadTask
```
public ResumeBatchLoadTaskResult resumeBatchLoadTask(ResumeBatchLoadTaskRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Specified by:
    
    resumeBatchLoadTask in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the ResumeBatchLoadTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Associates 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 AmazonTimestreamWrite
    
    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: AmazonTimestreamWrite
    
    Removes the association of tags from a Timestream resource.
    
    Specified by:
    
    untagResource in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDatabase
```
public UpdateDatabaseResult updateDatabase(UpdateDatabaseRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Modifies the KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId). If there are any concurrent UpdateDatabase requests, first writer wins.
    
    See code sample for details.
    
    Specified by:
    
    updateDatabase in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the UpdateDatabase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTable
```
public UpdateTableResult updateTable(UpdateTableRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately. For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but will be populated with 24 hours of data 22 hours after this change was made. Timestream does not retrieve data from the magnetic store to populate the memory store.
    
    See code sample for details.
    
    Specified by:
    
    updateTable in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the UpdateTable operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - writeRecords
```
public WriteRecordsResult writeRecords(WriteRecordsRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    Enables you to write your time-series data into Timestream. You can specify a single data point or a batch of data points to be inserted into the system. Timestream offers you a flexible schema that auto detects the column names and data types for your Timestream tables based on the dimension names and data types of the data points you specify when invoking writes into the database.
    
    Timestream supports eventual consistency read semantics. This means that when you query data immediately after writing a batch of data into Timestream, the query results might not reflect the results of a recently completed write operation. The results may also include some stale data. If you repeat the query request after a short time, the results should return the latest data. Service quotas apply.
    
    See code sample for details.
    
    Upserts
    
    You can use the Version parameter in a WriteRecords request to update data points. Timestream tracks a version number with each record. Version defaults to 1 when it's not specified for the record in the request. Timestream updates an existing record’s measure value along with its Version when it receives a write request with a higher Version number for that record. When it receives an update request where the measure value is the same as that of the existing record, Timestream still updates Version, if it is greater than the existing value of Version. You can update a data point as many times as desired, as long as the value of Version continuously increases.
    
    For example, suppose you write a new record without indicating Version in the request. Timestream stores this record, and set Version to 1. Now, suppose you try to update this record with a WriteRecords request of the same record with a different measure value but, like before, do not provide Version. In this case, Timestream will reject this update with a RejectedRecordsException since the updated record’s version is not greater than the existing value of Version.
    
    However, if you were to resend the update request with Version set to 2, Timestream would then succeed in updating the record’s value, and the Version would be set to 2. Next, suppose you sent a WriteRecords request with this same record and an identical measure value, but with Version set to 3. In this case, Timestream would only update Version to 3. Any further updates would need to send a version number greater than 3, or the update requests would receive a RejectedRecordsException.
    
    Specified by:
    
    writeRecords in interface AmazonTimestreamWrite
    
    Returns:
    
    Result of the WriteRecords operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonTimestreamWrite
    
    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 AmazonTimestreamWrite
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonTimestreamWrite
    
    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 AmazonTimestreamWrite
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AbstractAmazonTimestreamWrite

Field Summary

Fields inherited from interface com.amazonaws.services.timestreamwrite.AmazonTimestreamWrite

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAmazonTimestreamWrite

Method Detail

createBatchLoadTask

createDatabase

createTable

deleteDatabase

deleteTable

describeBatchLoadTask

describeDatabase

describeEndpoints

describeTable

listBatchLoadTasks

listDatabases

listTables

listTagsForResource

resumeBatchLoadTask

tagResource

untagResource

updateDatabase

updateTable

writeRecords

shutdown

getCachedResponseMetadata