software.amazon.kinesis.common

Class StreamIdentifier

java.lang.Object

software.amazon.kinesis.common.StreamIdentifier

public class StreamIdentifier
extends Object

Constructor Summary

Constructors

Constructor and Description
StreamIdentifier()

Method Summary

Modifier and Type	Method and Description
static StreamIdentifier	multiStreamInstance(software.amazon.awssdk.arns.Arn streamArn, long creationEpoch) Create a multi stream instance for StreamIdentifier from stream Arn.
static StreamIdentifier	multiStreamInstance(String streamIdentifierSer) Create a multi stream instance for StreamIdentifier from serialized stream identifier of format STREAM_IDENTIFIER_PATTERN
String	serialize() Serialize the current StreamIdentifier instance.
static StreamIdentifier	singleStreamInstance(software.amazon.awssdk.arns.Arn streamArn) Create a single stream instance for StreamIdentifier from AWS Kinesis stream Arn.
static StreamIdentifier	singleStreamInstance(String streamName) Create a single stream instance for StreamIdentifier from stream name.
String	toString()
static void	validateArn(software.amazon.awssdk.arns.Arn streamArn) Verify the streamArn follows the appropriate formatting.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StreamIdentifier

public StreamIdentifier()

Method Detail

serialize

public String serialize()

Serialize the current StreamIdentifier instance.

Returns:

a String of account:stream:creationEpoch in multi-stream mode or streamName in single-stream mode.

toString

public String toString()

Overrides:

toString in class Object

multiStreamInstance

public static StreamIdentifier multiStreamInstance(String streamIdentifierSer)

Create a multi stream instance for StreamIdentifier from serialized stream identifier of format STREAM_IDENTIFIER_PATTERN

Parameters:

streamIdentifierSer - a String of account:stream:creationEpoch

Returns:

StreamIdentifier with accountIdOptional and streamCreationEpochOptional present

multiStreamInstance

public static StreamIdentifier multiStreamInstance(software.amazon.awssdk.arns.Arn streamArn,
                                                   long creationEpoch)

Create a multi stream instance for StreamIdentifier from stream Arn.

Parameters:

streamArn - an Arn of format STREAM_ARN_PATTERN

creationEpoch - Creation epoch of the stream. This value will reflect in the lease key and is assumed to be correct. (KCL could verify, but that creates issues for both bootstrapping and, with large KCL applications, API throttling against DescribeStreamSummary.) If this epoch is reused for two identically-named streams in the same account -- such as deleting and recreating a stream -- then KCL will be unable to differentiate leases between the old and new stream since the lease keys collide on this creation epoch.

Returns:

StreamIdentifier with accountIdOptional, streamCreationEpochOptional, and streamArnOptional present

singleStreamInstance

public static StreamIdentifier singleStreamInstance(String streamName)

Create a single stream instance for StreamIdentifier from stream name.

Parameters:

streamName - stream name of a Kinesis stream

singleStreamInstance

public static StreamIdentifier singleStreamInstance(software.amazon.awssdk.arns.Arn streamArn)

Create a single stream instance for StreamIdentifier from AWS Kinesis stream Arn.

Parameters:

streamArn - AWS ARN of a Kinesis stream

Returns:

StreamIdentifier with accountIdOptional and streamArnOptional present

validateArn

public static void validateArn(software.amazon.awssdk.arns.Arn streamArn)

Verify the streamArn follows the appropriate formatting. Throw an exception if it does not.

Parameters:

streamArn -