@Generated(value="software.amazon.awssdk:codegen") public interface DynamoDbStreamsAsyncClient extends SdkClient
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static DynamoDbStreamsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
DynamoDbStreamsAsyncClient . |
static DynamoDbStreamsAsyncClient |
create()
Create a
DynamoDbStreamsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<DescribeStreamResponse> |
describeStream(Consumer<DescribeStreamRequest.Builder> 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.
|
default CompletableFuture<DescribeStreamResponse> |
describeStream(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.
|
default DescribeStreamPublisher |
describeStreamPaginator(Consumer<DescribeStreamRequest.Builder> 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.
|
default DescribeStreamPublisher |
describeStreamPaginator(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.
|
default CompletableFuture<GetRecordsResponse> |
getRecords(Consumer<GetRecordsRequest.Builder> getRecordsRequest)
Retrieves the stream records from a given shard.
|
default CompletableFuture<GetRecordsResponse> |
getRecords(GetRecordsRequest getRecordsRequest)
Retrieves the stream records from a given shard.
|
default CompletableFuture<GetShardIteratorResponse> |
getShardIterator(Consumer<GetShardIteratorRequest.Builder> getShardIteratorRequest)
Returns a shard iterator.
|
default CompletableFuture<GetShardIteratorResponse> |
getShardIterator(GetShardIteratorRequest getShardIteratorRequest)
Returns a shard iterator.
|
default CompletableFuture<ListStreamsResponse> |
listStreams()
Returns an array of stream ARNs associated with the current account and endpoint.
|
default CompletableFuture<ListStreamsResponse> |
listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Returns an array of stream ARNs associated with the current account and endpoint.
|
default CompletableFuture<ListStreamsResponse> |
listStreams(ListStreamsRequest listStreamsRequest)
Returns an array of stream ARNs associated with the current account and endpoint.
|
default ListStreamsPublisher |
listStreamsPaginator()
Returns an array of stream ARNs associated with the current account and endpoint.
|
default ListStreamsPublisher |
listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Returns an array of stream ARNs associated with the current account and endpoint.
|
default ListStreamsPublisher |
listStreamsPaginator(ListStreamsRequest listStreamsRequest)
Returns an array of stream ARNs associated with the current account and endpoint.
|
serviceName
close
static final String SERVICE_NAME
static DynamoDbStreamsAsyncClient create()
DynamoDbStreamsAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static DynamoDbStreamsAsyncClientBuilder builder()
DynamoDbStreamsAsyncClient
.default CompletableFuture<DescribeStreamResponse> describeStream(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, then that shard is closed
and can no longer receive more data.
describeStreamRequest
- Represents the input of a DescribeStream
operation.default CompletableFuture<DescribeStreamResponse> describeStream(Consumer<DescribeStreamRequest.Builder> 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, then that shard is closed
and can no longer receive more data.
This is a convenience which creates an instance of the DescribeStreamRequest.Builder
avoiding the need to
create one manually via DescribeStreamRequest.builder()
describeStreamRequest
- A Consumer
that will call methods on DescribeStreamInput.Builder
to create a request.
Represents the input of a DescribeStream
operation.default DescribeStreamPublisher describeStreamPaginator(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, then that shard is closed
and can no longer receive more data.
This is a variant of
describeStream(software.amazon.awssdk.services.dynamodb.model.DescribeStreamRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.dynamodb.streams.paginators.DescribeStreamPublisher publisher = client.describeStreamPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.dynamodb.streams.paginators.DescribeStreamPublisher publisher = client.describeStreamPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.DescribeStreamResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.dynamodb.model.DescribeStreamResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeStream(software.amazon.awssdk.services.dynamodb.model.DescribeStreamRequest)
operation.
describeStreamRequest
- Represents the input of a DescribeStream
operation.default DescribeStreamPublisher describeStreamPaginator(Consumer<DescribeStreamRequest.Builder> 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, then that shard is closed
and can no longer receive more data.
This is a variant of
describeStream(software.amazon.awssdk.services.dynamodb.model.DescribeStreamRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.dynamodb.streams.paginators.DescribeStreamPublisher publisher = client.describeStreamPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.dynamodb.streams.paginators.DescribeStreamPublisher publisher = client.describeStreamPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.DescribeStreamResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.dynamodb.model.DescribeStreamResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeStream(software.amazon.awssdk.services.dynamodb.model.DescribeStreamRequest)
operation.
This is a convenience which creates an instance of the DescribeStreamRequest.Builder
avoiding the need to
create one manually via DescribeStreamRequest.builder()
describeStreamRequest
- A Consumer
that will call methods on DescribeStreamInput.Builder
to create a request.
Represents the input of a DescribeStream
operation.default CompletableFuture<GetRecordsResponse> getRecords(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 1000 stream records, whichever comes first.
getRecordsRequest
- Represents the input of a GetRecords
operation.GetShardIterator
action.In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:
You request a shard iterator with a sequence number older than the trim point (24 hours).
You obtain a shard iterator, but before you use the iterator in a GetRecords
request, a
stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access
a record that no longer exists.
default CompletableFuture<GetRecordsResponse> getRecords(Consumer<GetRecordsRequest.Builder> 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 1000 stream records, whichever comes first.
This is a convenience which creates an instance of the GetRecordsRequest.Builder
avoiding the need to
create one manually via GetRecordsRequest.builder()
getRecordsRequest
- A Consumer
that will call methods on GetRecordsInput.Builder
to create a request.
Represents the input of a GetRecords
operation.GetShardIterator
action.In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:
You request a shard iterator with a sequence number older than the trim point (24 hours).
You obtain a shard iterator, but before you use the iterator in a GetRecords
request, a
stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access
a record that no longer exists.
default CompletableFuture<GetShardIteratorResponse> getShardIterator(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.
getShardIteratorRequest
- Represents the input of a GetShardIterator
operation.In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:
You request a shard iterator with a sequence number older than the trim point (24 hours).
You obtain a shard iterator, but before you use the iterator in a GetRecords
request, a
stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access
a record that no longer exists.
default CompletableFuture<GetShardIteratorResponse> getShardIterator(Consumer<GetShardIteratorRequest.Builder> 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.
This is a convenience which creates an instance of the GetShardIteratorRequest.Builder
avoiding the need
to create one manually via GetShardIteratorRequest.builder()
getShardIteratorRequest
- A Consumer
that will call methods on GetShardIteratorInput.Builder
to create a request.
Represents the input of a GetShardIterator
operation.In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:
You request a shard iterator with a sequence number older than the trim point (24 hours).
You obtain a shard iterator, but before you use the iterator in a GetRecords
request, a
stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access
a record that no longer exists.
default CompletableFuture<ListStreamsResponse> listStreams(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.
listStreamsRequest
- Represents the input of a ListStreams
operation.default CompletableFuture<ListStreamsResponse> listStreams(Consumer<ListStreamsRequest.Builder> 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.
This is a convenience which creates an instance of the ListStreamsRequest.Builder
avoiding the need to
create one manually via ListStreamsRequest.builder()
listStreamsRequest
- A Consumer
that will call methods on ListStreamsInput.Builder
to create a request.
Represents the input of a ListStreams
operation.default CompletableFuture<ListStreamsResponse> listStreams()
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.
default ListStreamsPublisher listStreamsPaginator()
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.
This is a variant of listStreams(software.amazon.awssdk.services.dynamodb.model.ListStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ListStreamsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.dynamodb.model.ListStreamsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.dynamodb.model.ListStreamsRequest)
operation.
default ListStreamsPublisher listStreamsPaginator(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.
This is a variant of listStreams(software.amazon.awssdk.services.dynamodb.model.ListStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ListStreamsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.dynamodb.model.ListStreamsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.dynamodb.model.ListStreamsRequest)
operation.
listStreamsRequest
- Represents the input of a ListStreams
operation.default ListStreamsPublisher listStreamsPaginator(Consumer<ListStreamsRequest.Builder> 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.
This is a variant of listStreams(software.amazon.awssdk.services.dynamodb.model.ListStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.dynamodb.streams.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.dynamodb.model.ListStreamsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.dynamodb.model.ListStreamsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.dynamodb.model.ListStreamsRequest)
operation.
This is a convenience which creates an instance of the ListStreamsRequest.Builder
avoiding the need to
create one manually via ListStreamsRequest.builder()
listStreamsRequest
- A Consumer
that will call methods on ListStreamsInput.Builder
to create a request.
Represents the input of a ListStreams
operation.Copyright © 2019. All rights reserved.