Class AbstractAmazonDynamoDBStreams
- java.lang.Object
-
- com.amazonaws.services.dynamodbv2.AbstractAmazonDynamoDBStreams
-
- All Implemented Interfaces:
AmazonDynamoDBStreams
- Direct Known Subclasses:
AbstractAmazonDynamoDBStreamsAsync
public class AbstractAmazonDynamoDBStreams extends Object implements AmazonDynamoDBStreams
Abstract implementation ofAmazonDynamoDBStreams. Convenient method forms pass through to the corresponding overload that takes a request object, which throws anUnsupportedOperationException.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractAmazonDynamoDBStreams()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeStreamResultdescribeStream(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.ResponseMetadatagetCachedResponseMetadata(AmazonWebServiceRequest request)Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.GetRecordsResultgetRecords(GetRecordsRequest request)Retrieves the stream records from a given shard.GetShardIteratorResultgetShardIterator(GetShardIteratorRequest request)Returns a shard iterator.ListStreamsResultlistStreams(ListStreamsRequest request)Returns an array of stream ARNs associated with the current account and endpoint.voidsetEndpoint(String endpoint)Overrides the default endpoint for this client ("https://streams.dynamodb.us-east-1.amazonaws.com").voidsetRegion(Region region)An alternative toAmazonDynamoDBStreams.setEndpoint(String), sets the regional endpoint for this client's service calls.voidshutdown()Shuts down this client object, releasing any resources that might be held open.
-
-
-
Method Detail
-
setEndpoint
public void setEndpoint(String endpoint)
Description copied from interface:AmazonDynamoDBStreamsOverrides 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
ClientConfigurationwill 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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
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:
setEndpointin interfaceAmazonDynamoDBStreams- 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:AmazonDynamoDBStreamsAn alternative toAmazonDynamoDBStreams.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
ClientConfigurationsupplied 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:
setRegionin interfaceAmazonDynamoDBStreams- Parameters:
region- The region this client will communicate with. SeeRegion.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:AmazonDynamoDBStreamsReturns 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
SequenceNumberRangeassociated with it. If theSequenceNumberRangehas aStartingSequenceNumberbut noEndingSequenceNumber, then the shard is still open (able to receive more stream records). If bothStartingSequenceNumberandEndingSequenceNumberare present, the that shared is closed and can no longer receive more data.- Specified by:
describeStreamin interfaceAmazonDynamoDBStreams- Parameters:
request- Represents the input of a DescribeStream operation.- Returns:
- Result of the DescribeStream operation returned by the service.
-
getRecords
public GetRecordsResult getRecords(GetRecordsRequest request)
Description copied from interface:AmazonDynamoDBStreamsRetrieves the stream records from a given shard.
Specify a shard iterator using the
ShardIteratorparameter. 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,GetRecordsreturns 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.- Specified by:
getRecordsin interfaceAmazonDynamoDBStreams- Parameters:
request- Represents the input of a GetRecords operation.- Returns:
- Result of the GetRecords operation returned by the service.
-
getShardIterator
public GetShardIteratorResult getShardIterator(GetShardIteratorRequest request)
Description copied from interface:AmazonDynamoDBStreamsReturns 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
GetRecordsrequest to read the stream records from the shard.A shard iterator expires 15 minutes after it is returned to the requester.
- Specified by:
getShardIteratorin interfaceAmazonDynamoDBStreams- Parameters:
request- Represents the input of a GetShardIterator operation.- Returns:
- Result of the GetShardIterator operation returned by the service.
-
listStreams
public ListStreamsResult listStreams(ListStreamsRequest request)
Description copied from interface:AmazonDynamoDBStreamsReturns an array of stream ARNs associated with the current account and endpoint. If the
TableNameparameter 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:
listStreamsin interfaceAmazonDynamoDBStreams- Parameters:
request- Represents the input of a ListStreams operation.- Returns:
- Result of the ListStreams operation returned by the service.
-
shutdown
public void shutdown()
Description copied from interface:AmazonDynamoDBStreamsShuts 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:
shutdownin interfaceAmazonDynamoDBStreams
-
getCachedResponseMetadata
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Description copied from interface:AmazonDynamoDBStreamsReturns 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:
getCachedResponseMetadatain interfaceAmazonDynamoDBStreams- Parameters:
request- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-