com.amazonaws.services.dynamodbv2.AmazonDynamoDBStreamsAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2010-2016 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 com.amazonaws.services.dynamodbv2;
import com.amazonaws.services.dynamodbv2.model.*;
/**
* Interface for accessing Amazon DynamoDB Streams asynchronously. Each
* asynchronous method will return a Java Future object representing the
* asynchronous operation; overloads which accept an {@code AsyncHandler} can be
* used to receive notification when an asynchronous operation completes.
*
* Amazon DynamoDB Streams
*
* This is the Amazon DynamoDB Streams API Reference. This guide describes the
* low-level API actions for accessing streams and processing stream records.
* For information about application development with DynamoDB Streams, see the
* Amazon DynamoDB Developer Guide.
*
*
* Note that this document is intended for use with the following DynamoDB
* documentation:
*
*
* -
*
*
* -
*
*
*
*
* The following are short descriptions of each low-level DynamoDB Streams API
* action, organized by function.
*
*
* -
*
* DescribeStream - Returns detailed information about a particular
* stream.
*
*
* -
*
* GetRecords - Retrieves the stream records from within a shard.
*
*
* -
*
* GetShardIterator - Returns information on how to retrieve the streams
* record from a shard with a given shard ID.
*
*
* -
*
* ListStreams - Returns a list of all the streams associated with the
* current AWS account and endpoint.
*
*
*
*/
public interface AmazonDynamoDBStreamsAsync extends AmazonDynamoDBStreams {
/**
*
* Returns information about a stream, including the current status of the
* stream, its Amazon Resource Name (ARN), the composition of its shards,
* and its corresponding DynamoDB table.
*
*
*
* You can call DescribeStream at a maximum rate of 10 times per
* second.
*
*
*
* Each shard in the stream has a SequenceNumberRange
* associated with it. If the SequenceNumberRange has a
* StartingSequenceNumber but no
* EndingSequenceNumber, then the shard is still open (able to
* receive more stream records). If both StartingSequenceNumber
* and EndingSequenceNumber are present, the that shared is
* closed and can no longer receive more data.
*
*
* @param describeStreamRequest
* Represents the input of a DescribeStream operation.
* @return A Java Future containing the result of the DescribeStream
* operation returned by the service.
* @sample AmazonDynamoDBStreamsAsync.DescribeStream
*/
java.util.concurrent.Future describeStreamAsync(
DescribeStreamRequest describeStreamRequest);
/**
*
* Returns information about a stream, including the current status of the
* stream, its Amazon Resource Name (ARN), the composition of its shards,
* and its corresponding DynamoDB table.
*
*
*
* You can call DescribeStream at a maximum rate of 10 times per
* second.
*
*
*
* Each shard in the stream has a SequenceNumberRange
* associated with it. If the SequenceNumberRange has a
* StartingSequenceNumber but no
* EndingSequenceNumber, then the shard is still open (able to
* receive more stream records). If both StartingSequenceNumber
* and EndingSequenceNumber are present, the that shared is
* closed and can no longer receive more data.
*
*
* @param describeStreamRequest
* Represents the input of a DescribeStream operation.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeStream
* operation returned by the service.
* @sample AmazonDynamoDBStreamsAsyncHandler.DescribeStream
*/
java.util.concurrent.Future describeStreamAsync(
DescribeStreamRequest describeStreamRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the stream records from a given shard.
*
*
* Specify a shard iterator using the ShardIterator parameter.
* The shard iterator specifies the position in the shard from which you
* want to start reading stream records sequentially. If there are no stream
* records available in the portion of the shard that the iterator points
* to, GetRecords returns an empty list. Note that it might
* take multiple calls to get to a portion of the shard that contains stream
* records.
*
*
*
* GetRecords can retrieve a maximum of 1 MB of data or
* 2000 stream records, whichever comes first.
*
*
*
* @param getRecordsRequest
* Represents the input of a GetRecords operation.
* @return A Java Future containing the result of the GetRecords operation
* returned by the service.
* @sample AmazonDynamoDBStreamsAsync.GetRecords
*/
java.util.concurrent.Future getRecordsAsync(
GetRecordsRequest getRecordsRequest);
/**
*
* Retrieves the stream records from a given shard.
*
*
* Specify a shard iterator using the ShardIterator parameter.
* The shard iterator specifies the position in the shard from which you
* want to start reading stream records sequentially. If there are no stream
* records available in the portion of the shard that the iterator points
* to, GetRecords returns an empty list. Note that it might
* take multiple calls to get to a portion of the shard that contains stream
* records.
*
*
*
* GetRecords can retrieve a maximum of 1 MB of data or
* 2000 stream records, whichever comes first.
*
*
*
* @param getRecordsRequest
* Represents the input of a GetRecords operation.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetRecords operation
* returned by the service.
* @sample AmazonDynamoDBStreamsAsyncHandler.GetRecords
*/
java.util.concurrent.Future getRecordsAsync(
GetRecordsRequest getRecordsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a shard iterator. A shard iterator provides information about how
* to retrieve the stream records from within a shard. Use the shard
* iterator in a subsequent GetRecords request to read the
* stream records from the shard.
*
*
*
* A shard iterator expires 15 minutes after it is returned to the
* requester.
*
*
*
* @param getShardIteratorRequest
* Represents the input of a GetShardIterator operation.
* @return A Java Future containing the result of the GetShardIterator
* operation returned by the service.
* @sample AmazonDynamoDBStreamsAsync.GetShardIterator
*/
java.util.concurrent.Future getShardIteratorAsync(
GetShardIteratorRequest getShardIteratorRequest);
/**
*
* Returns a shard iterator. A shard iterator provides information about how
* to retrieve the stream records from within a shard. Use the shard
* iterator in a subsequent GetRecords request to read the
* stream records from the shard.
*
*
*
* A shard iterator expires 15 minutes after it is returned to the
* requester.
*
*
*
* @param getShardIteratorRequest
* Represents the input of a GetShardIterator operation.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetShardIterator
* operation returned by the service.
* @sample AmazonDynamoDBStreamsAsyncHandler.GetShardIterator
*/
java.util.concurrent.Future getShardIteratorAsync(
GetShardIteratorRequest getShardIteratorRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns an array of stream ARNs associated with the current account and
* endpoint. If the TableName parameter is present, then
* ListStreams will return only the streams ARNs for that table.
*
*
*
* You can call ListStreams at a maximum rate of 5 times per second.
*
*
*
* @param listStreamsRequest
* Represents the input of a ListStreams operation.
* @return A Java Future containing the result of the ListStreams operation
* returned by the service.
* @sample AmazonDynamoDBStreamsAsync.ListStreams
*/
java.util.concurrent.Future listStreamsAsync(
ListStreamsRequest listStreamsRequest);
/**
*
* Returns an array of stream ARNs associated with the current account and
* endpoint. If the TableName parameter is present, then
* ListStreams will return only the streams ARNs for that table.
*
*
*
* You can call ListStreams at a maximum rate of 5 times per second.
*
*
*
* @param listStreamsRequest
* Represents the input of a ListStreams operation.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListStreams operation
* returned by the service.
* @sample AmazonDynamoDBStreamsAsyncHandler.ListStreams
*/
java.util.concurrent.Future listStreamsAsync(
ListStreamsRequest listStreamsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}