com.amazonaws.services.dynamodbv2

Class AbstractAmazonDynamoDBStreams

java.lang.Object

com.amazonaws.services.dynamodbv2.AbstractAmazonDynamoDBStreams

All Implemented Interfaces:

AmazonDynamoDBStreams

Direct Known Subclasses:

AbstractAmazonDynamoDBStreamsAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonDynamoDBStreams
extends Object
implements AmazonDynamoDBStreams

Abstract implementation of AmazonDynamoDBStreams. 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.dynamodbv2.AmazonDynamoDBStreams

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
DescribeStreamResult	describeStream(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.
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.
GetRecordsResult	getRecords(GetRecordsRequest request) Retrieves the stream records from a given shard.
GetShardIteratorResult	getShardIterator(GetShardIteratorRequest request) Returns a shard iterator.
ListStreamsResult	listStreams(ListStreamsRequest request) Returns an array of stream ARNs associated with the current account and endpoint.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://streams.dynamodb.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to AmazonDynamoDBStreams.setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AmazonDynamoDBStreams

Overrides the default endpoint for this client ("https://streams.dynamodb.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "streams.dynamodb.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://streams.dynamodb.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Specified by:

setEndpoint in interface AmazonDynamoDBStreams

Parameters:

endpoint - The endpoint (ex: "streams.dynamodb.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://streams.dynamodb.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

public void setRegion(Region region)

Description copied from interface: AmazonDynamoDBStreams

An alternative to AmazonDynamoDBStreams.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Specified by:

setRegion in interface AmazonDynamoDBStreams

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

describeStream

public DescribeStreamResult describeStream(DescribeStreamRequest request)

Description copied from interface: 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, then that shard is closed and can no longer receive more data.

Specified by:

describeStream in interface AmazonDynamoDBStreams

Parameters:

request - Represents the input of a DescribeStream operation.

Returns:

Result of the DescribeStream operation returned by the service.

See Also:

AWS API Documentation

getRecords

public GetRecordsResult getRecords(GetRecordsRequest request)

Description copied from interface: AmazonDynamoDBStreams

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.

Specified by:

getRecords in interface AmazonDynamoDBStreams

Parameters:

request - Represents the input of a GetRecords operation.

Returns:

Result of the GetRecords operation returned by the service.

See Also:

AWS API Documentation

getShardIterator

public GetShardIteratorResult getShardIterator(GetShardIteratorRequest request)

Description copied from interface: AmazonDynamoDBStreams

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.

Specified by:

getShardIterator in interface AmazonDynamoDBStreams

Parameters:

request - Represents the input of a GetShardIterator operation.

Returns:

Result of the GetShardIterator operation returned by the service.

See Also:

AWS API Documentation

listStreams

public ListStreamsResult listStreams(ListStreamsRequest request)

Description copied from interface: AmazonDynamoDBStreams

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.

Specified by:

listStreams in interface AmazonDynamoDBStreams

Parameters:

request - Represents the input of a ListStreams operation.

Returns:

Result of the ListStreams operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonDynamoDBStreams

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 AmazonDynamoDBStreams

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonDynamoDBStreams

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 AmazonDynamoDBStreams

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.