@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonDynamoDBStreamsAsyncClient extends AmazonDynamoDBStreamsClient implements AmazonDynamoDBStreamsAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see Capturing Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer Guide.
The following are short descriptions of each low-level DynamoDB Streams action:
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.
configFactoryclient, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonDynamoDBStreamsAsyncClient()
Constructs a new asynchronous client to invoke service methods on Amazon DynamoDB Streams.
|
AmazonDynamoDBStreamsAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on Amazon DynamoDB Streams using the specified AWS
account credentials.
|
AmazonDynamoDBStreamsAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon DynamoDB Streams using the specified AWS
account credentials, executor service, and client configuration options.
|
AmazonDynamoDBStreamsAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon DynamoDB Streams using the specified AWS
account credentials and executor service.
|
AmazonDynamoDBStreamsAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on Amazon DynamoDB Streams using the specified AWS
account credentials provider.
|
AmazonDynamoDBStreamsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on Amazon DynamoDB Streams using the provided AWS
account credentials provider and client configuration options.
|
AmazonDynamoDBStreamsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon DynamoDB Streams using the specified AWS
account credentials provider, executor service, and client configuration options.
|
AmazonDynamoDBStreamsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon DynamoDB Streams using the specified AWS
account credentials provider and executor service.
|
AmazonDynamoDBStreamsAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on Amazon DynamoDB Streams.
|
| Modifier and Type | Method and Description |
|---|---|
Future<DescribeStreamResult> |
describeStreamAsync(DescribeStreamRequest request)
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.
|
Future<DescribeStreamResult> |
describeStreamAsync(DescribeStreamRequest request,
AsyncHandler<DescribeStreamRequest,DescribeStreamResult> asyncHandler)
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.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<GetRecordsResult> |
getRecordsAsync(GetRecordsRequest request)
Retrieves the stream records from a given shard.
|
Future<GetRecordsResult> |
getRecordsAsync(GetRecordsRequest request,
AsyncHandler<GetRecordsRequest,GetRecordsResult> asyncHandler)
Retrieves the stream records from a given shard.
|
Future<GetShardIteratorResult> |
getShardIteratorAsync(GetShardIteratorRequest request)
Returns a shard iterator.
|
Future<GetShardIteratorResult> |
getShardIteratorAsync(GetShardIteratorRequest request,
AsyncHandler<GetShardIteratorRequest,GetShardIteratorResult> asyncHandler)
Returns a shard iterator.
|
Future<ListStreamsResult> |
listStreamsAsync(ListStreamsRequest request)
Returns an array of stream ARNs associated with the current account and endpoint.
|
Future<ListStreamsResult> |
listStreamsAsync(ListStreamsRequest request,
AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)
Returns an array of stream ARNs associated with the current account and endpoint.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
describeStream, getCachedResponseMetadata, getRecords, getShardIterator, listStreamsaddRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdescribeStream, getCachedResponseMetadata, getRecords, getShardIterator, listStreams, setEndpoint, setRegionpublic AmazonDynamoDBStreamsAsyncClient()
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
public AmazonDynamoDBStreamsAsyncClient(ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to Amazon DynamoDB Streams (ex:
proxy settings, retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AmazonDynamoDBStreamsAsyncClient(AWSCredentials awsCredentials)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)public AmazonDynamoDBStreamsAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be executed.public AmazonDynamoDBStreamsAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public AmazonDynamoDBStreamsAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)public AmazonDynamoDBStreamsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AmazonDynamoDBStreamsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be executed.public AmazonDynamoDBStreamsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public ExecutorService getExecutorService()
public Future<DescribeStreamResult> describeStreamAsync(DescribeStreamRequest request)
AmazonDynamoDBStreamsAsyncReturns 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, then that shard is closed
and can no longer receive more data.
describeStreamAsync in interface AmazonDynamoDBStreamsAsyncrequest - Represents the input of a DescribeStream operation.public Future<DescribeStreamResult> describeStreamAsync(DescribeStreamRequest request, AsyncHandler<DescribeStreamRequest,DescribeStreamResult> asyncHandler)
AmazonDynamoDBStreamsAsyncReturns 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, then that shard is closed
and can no longer receive more data.
describeStreamAsync in interface AmazonDynamoDBStreamsAsyncrequest - Represents the input of a DescribeStream operation.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.public Future<GetRecordsResult> getRecordsAsync(GetRecordsRequest request)
AmazonDynamoDBStreamsAsyncRetrieves 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 1000 stream records, whichever comes first.
getRecordsAsync in interface AmazonDynamoDBStreamsAsyncrequest - Represents the input of a GetRecords operation.public Future<GetRecordsResult> getRecordsAsync(GetRecordsRequest request, AsyncHandler<GetRecordsRequest,GetRecordsResult> asyncHandler)
AmazonDynamoDBStreamsAsyncRetrieves 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 1000 stream records, whichever comes first.
getRecordsAsync in interface AmazonDynamoDBStreamsAsyncrequest - Represents the input of a GetRecords operation.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.public Future<GetShardIteratorResult> getShardIteratorAsync(GetShardIteratorRequest request)
AmazonDynamoDBStreamsAsync
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.
getShardIteratorAsync in interface AmazonDynamoDBStreamsAsyncrequest - Represents the input of a GetShardIterator operation.public Future<GetShardIteratorResult> getShardIteratorAsync(GetShardIteratorRequest request, AsyncHandler<GetShardIteratorRequest,GetShardIteratorResult> asyncHandler)
AmazonDynamoDBStreamsAsync
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.
getShardIteratorAsync in interface AmazonDynamoDBStreamsAsyncrequest - Represents the input of a GetShardIterator operation.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.public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request)
AmazonDynamoDBStreamsAsync
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.
listStreamsAsync in interface AmazonDynamoDBStreamsAsyncrequest - Represents the input of a ListStreams operation.public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request, AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)
AmazonDynamoDBStreamsAsync
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.
listStreamsAsync in interface AmazonDynamoDBStreamsAsyncrequest - Represents the input of a ListStreams operation.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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonDynamoDBStreamsshutdown in class AmazonWebServiceClientCopyright © 2017. All rights reserved.