com.agorapulse.micronaut.aws.kinesis

Interface KinesisService

public interface KinesisService

KinesisService provides middle-level API access to the Kinesis streams.

Method Summary

Modifier and Type	Method and Description
default com.amazonaws.services.kinesis.model.CreateStreamResult	createStream() Creates stream of getDefaultStreamName() name and one shard.
default com.amazonaws.services.kinesis.model.CreateStreamResult	createStream(int shardCount) Creates stream of getDefaultStreamName() name and given shard count.
default com.amazonaws.services.kinesis.model.CreateStreamResult	createStream(java.lang.String streamName) Creates stream of getDefaultStreamName() name and one shard.
com.amazonaws.services.kinesis.model.CreateStreamResult	createStream(java.lang.String streamName, int shardCount) Creates stream of given name and shard count.
java.lang.String	decodeRecordData(com.amazonaws.services.kinesis.model.Record record) Decodes the body of the record into its string representation.
default com.amazonaws.services.kinesis.model.DeleteStreamResult	deleteStream() Deletes stream of getDefaultStreamName() name.
com.amazonaws.services.kinesis.model.DeleteStreamResult	deleteStream(java.lang.String streamName) Deletes stream of given name.
default com.amazonaws.services.kinesis.model.DescribeStreamResult	describeStream() Describe stream of getDefaultStreamName() name.
com.amazonaws.services.kinesis.model.DescribeStreamResult	describeStream(java.lang.String streamName) Describes the stream of given name.
java.lang.String	getDefaultStreamName()
default com.amazonaws.services.kinesis.model.Shard	getShard(java.lang.String shardId) Returns shard of default stream by its id.
com.amazonaws.services.kinesis.model.Shard	getShard(java.lang.String streamName, java.lang.String shardId) Returns shard of given stream by its id.
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	getShardOldestRecord(com.amazonaws.services.kinesis.model.Shard shard)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	getShardOldestRecord(java.lang.String streamName, com.amazonaws.services.kinesis.model.Shard shard)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	getShardRecordAtSequenceNumber(com.amazonaws.services.kinesis.model.Shard shard, java.lang.String sequenceNumber)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	getShardRecordAtSequenceNumber(java.lang.String streamName, com.amazonaws.services.kinesis.model.Shard shard, java.lang.String sequenceNumber)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	getShardRecords(com.amazonaws.services.kinesis.model.Shard shard, com.amazonaws.services.kinesis.model.ShardIteratorType shardIteratorType, java.lang.String startingSequenceNumber)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	getShardRecords(com.amazonaws.services.kinesis.model.Shard shard, com.amazonaws.services.kinesis.model.ShardIteratorType shardIteratorType, java.lang.String startingSequenceNumber, int batchLimit)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	getShardRecords(java.lang.String streamName, com.amazonaws.services.kinesis.model.Shard shard, com.amazonaws.services.kinesis.model.ShardIteratorType shardIteratorType, java.lang.String startingSequenceNumber)
org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	getShardRecords(java.lang.String streamName, com.amazonaws.services.kinesis.model.Shard shard, com.amazonaws.services.kinesis.model.ShardIteratorType shardIteratorType, java.lang.String startingSequenceNumber, int batchLimit)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	listShardRecordsAfterSequenceNumber(com.amazonaws.services.kinesis.model.Shard shard, java.lang.String startingSequenceNumber)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	listShardRecordsAfterSequenceNumber(com.amazonaws.services.kinesis.model.Shard shard, java.lang.String startingSequenceNumber, int batchLimit)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	listShardRecordsAfterSequenceNumber(java.lang.String streamName, com.amazonaws.services.kinesis.model.Shard shard, java.lang.String startingSequenceNumber)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	listShardRecordsAfterSequenceNumber(java.lang.String streamName, com.amazonaws.services.kinesis.model.Shard shard, java.lang.String startingSequenceNumber, int batchLimit)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	listShardRecordsFromHorizon(com.amazonaws.services.kinesis.model.Shard shard)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	listShardRecordsFromHorizon(com.amazonaws.services.kinesis.model.Shard shard, int batchLimit)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	listShardRecordsFromHorizon(java.lang.String streamName, com.amazonaws.services.kinesis.model.Shard shard)
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record>	listShardRecordsFromHorizon(java.lang.String streamName, com.amazonaws.services.kinesis.model.Shard shard, int batchLimit)
default java.util.List<com.amazonaws.services.kinesis.model.Shard>	listShards()
default java.util.List<com.amazonaws.services.kinesis.model.Shard>	listShards(java.lang.String streamName)
java.util.List<java.lang.String>	listStreamNames()
default com.amazonaws.services.kinesis.model.MergeShardsResult	mergeShards(java.lang.String shardId1, java.lang.String shardId2)
com.amazonaws.services.kinesis.model.MergeShardsResult	mergeShards(java.lang.String streamName, java.lang.String shardId1, java.lang.String shardId2)
default com.amazonaws.services.kinesis.model.PutRecordResult	putEvent(Event event)
default com.amazonaws.services.kinesis.model.PutRecordResult	putEvent(Event event, java.lang.String sequenceNumberForOrdering)
default com.amazonaws.services.kinesis.model.PutRecordResult	putEvent(java.lang.String streamName, Event event)
com.amazonaws.services.kinesis.model.PutRecordResult	putEvent(java.lang.String streamName, Event event, java.lang.String sequenceNumberForOrdering)
default com.amazonaws.services.kinesis.model.PutRecordsResult	putEvents(java.util.List<Event> events)
com.amazonaws.services.kinesis.model.PutRecordsResult	putEvents(java.lang.String streamName, java.util.List<Event> events)
default com.amazonaws.services.kinesis.model.PutRecordResult	putRecord(java.lang.String partitionKey, byte[] data, java.lang.String sequenceNumberForOrdering)
default com.amazonaws.services.kinesis.model.PutRecordResult	putRecord(java.lang.String streamName, java.lang.String partitionKey, byte[] data)
com.amazonaws.services.kinesis.model.PutRecordResult	putRecord(java.lang.String streamName, java.lang.String partitionKey, byte[] data, java.lang.String sequenceNumberForOrdering)
default com.amazonaws.services.kinesis.model.PutRecordResult	putRecord(java.lang.String partitionKey, java.lang.String data, java.lang.String sequenceNumberForOrdering)
default com.amazonaws.services.kinesis.model.PutRecordResult	putRecord(java.lang.String streamName, java.lang.String partitionKey, java.lang.String data, java.lang.String sequenceNumberForOrdering)
default com.amazonaws.services.kinesis.model.PutRecordsResult	putRecords(java.util.List<com.amazonaws.services.kinesis.model.PutRecordsRequestEntry> records)
com.amazonaws.services.kinesis.model.PutRecordsResult	putRecords(java.lang.String streamName, java.util.List<com.amazonaws.services.kinesis.model.PutRecordsRequestEntry> records)
default com.amazonaws.services.kinesis.model.SplitShardResult	splitShard(java.lang.String shardId)
default com.amazonaws.services.kinesis.model.SplitShardResult	splitShard(java.lang.String streamName, com.amazonaws.services.kinesis.model.Shard shard)
com.amazonaws.services.kinesis.model.SplitShardResult	splitShard(java.lang.String streamName, com.amazonaws.services.kinesis.model.Shard shard, java.lang.String newStartingHashKey)
default com.amazonaws.services.kinesis.model.SplitShardResult	splitShard(java.lang.String streamName, java.lang.String shardId)
default void	waitForActive()
default void	waitForActive(java.lang.String streamName)
default void	waitForStatus(com.amazonaws.services.kinesis.model.StreamStatus status)
void	waitForStatus(java.lang.String streamName, com.amazonaws.services.kinesis.model.StreamStatus status)

Method Detail

getDefaultStreamName

java.lang.String getDefaultStreamName()

Returns:

the name of the default stream

createStream

com.amazonaws.services.kinesis.model.CreateStreamResult createStream(java.lang.String streamName,
                                                                     int shardCount)

Creates stream of given name and shard count.

Parameters:

streamName - the name of the stream

shardCount - number of the shards to be created

Returns:

create stream result

createStream

default com.amazonaws.services.kinesis.model.CreateStreamResult createStream(java.lang.String streamName)

Creates stream of getDefaultStreamName() name and one shard.

Parameters:

streamName - the name of the stream

Returns:

create stream result

createStream

default com.amazonaws.services.kinesis.model.CreateStreamResult createStream(int shardCount)

Creates stream of getDefaultStreamName() name and given shard count.

Parameters:

shardCount - number of the shards to be created

Returns:

create stream result

createStream

default com.amazonaws.services.kinesis.model.CreateStreamResult createStream()

Creates stream of getDefaultStreamName() name and one shard.

Returns:

create stream result

decodeRecordData

java.lang.String decodeRecordData(com.amazonaws.services.kinesis.model.Record record)

Decodes the body of the record into its string representation.

Parameters:

record - record to be processed

Returns:

string representation of the body of the record

deleteStream

com.amazonaws.services.kinesis.model.DeleteStreamResult deleteStream(java.lang.String streamName)

Deletes stream of given name.

Parameters:

streamName - the name of the stream

Returns:

delete stream result

deleteStream

default com.amazonaws.services.kinesis.model.DeleteStreamResult deleteStream()

Deletes stream of getDefaultStreamName() name.

Returns:

delete stream result

describeStream

com.amazonaws.services.kinesis.model.DescribeStreamResult describeStream(java.lang.String streamName)

Describes the stream of given name.

Parameters:

streamName - the name of the stream

Returns:

describe stream result

describeStream

default com.amazonaws.services.kinesis.model.DescribeStreamResult describeStream()

Describe stream of getDefaultStreamName() name.

Returns:

describe stream result

getShard

com.amazonaws.services.kinesis.model.Shard getShard(java.lang.String streamName,
                                                    java.lang.String shardId)

Returns shard of given stream by its id.

Parameters:

streamName - the name of the stream

shardId - the id of the shard

Returns:

shard of given stream by its id

getShard

default com.amazonaws.services.kinesis.model.Shard getShard(java.lang.String shardId)

Returns shard of default stream by its id.

Parameters:

shardId - the id of the shard

Returns:

shard of default stream by its id

getShardOldestRecord

@SingleResult
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> getShardOldestRecord(java.lang.String streamName,
                                                                                                                      com.amazonaws.services.kinesis.model.Shard shard)

Parameters:

streamName - the name of the stream

shard - the shard to be used

Returns:

getShardOldestRecord

@SingleResult
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> getShardOldestRecord(com.amazonaws.services.kinesis.model.Shard shard)

Parameters:

shard - the shard to be used

Returns:

getShardRecordAtSequenceNumber

@SingleResult
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> getShardRecordAtSequenceNumber(java.lang.String streamName,
                                                                                                                                com.amazonaws.services.kinesis.model.Shard shard,
                                                                                                                                java.lang.String sequenceNumber)

Parameters:

streamName - the name of the stream

shard - the shard to be used

sequenceNumber -

Returns:

getShardRecordAtSequenceNumber

@SingleResult
default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> getShardRecordAtSequenceNumber(com.amazonaws.services.kinesis.model.Shard shard,
                                                                                                                                java.lang.String sequenceNumber)

Parameters:

shard - the shard to be used

sequenceNumber -

Returns:

listStreamNames

java.util.List<java.lang.String> listStreamNames()

Returns:

getShardRecords

org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> getShardRecords(java.lang.String streamName,
                                                                                           com.amazonaws.services.kinesis.model.Shard shard,
                                                                                           com.amazonaws.services.kinesis.model.ShardIteratorType shardIteratorType,
                                                                                           java.lang.String startingSequenceNumber,
                                                                                           int batchLimit)

Parameters:

streamName - the name of the stream

shard - the shard to be used

shardIteratorType -

startingSequenceNumber -

batchLimit -

Returns:

getShardRecords

default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> getShardRecords(java.lang.String streamName,
                                                                                                   com.amazonaws.services.kinesis.model.Shard shard,
                                                                                                   com.amazonaws.services.kinesis.model.ShardIteratorType shardIteratorType,
                                                                                                   java.lang.String startingSequenceNumber)

Parameters:

streamName - the name of the stream

shard - the shard to be used

shardIteratorType -

startingSequenceNumber -

Returns:

getShardRecords

default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> getShardRecords(com.amazonaws.services.kinesis.model.Shard shard,
                                                                                                   com.amazonaws.services.kinesis.model.ShardIteratorType shardIteratorType,
                                                                                                   java.lang.String startingSequenceNumber,
                                                                                                   int batchLimit)

Parameters:

shard - the shard to be used

shardIteratorType -

startingSequenceNumber -

batchLimit -

Returns:

getShardRecords

default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> getShardRecords(com.amazonaws.services.kinesis.model.Shard shard,
                                                                                                   com.amazonaws.services.kinesis.model.ShardIteratorType shardIteratorType,
                                                                                                   java.lang.String startingSequenceNumber)

Parameters:

shard - the shard to be used

shardIteratorType -

startingSequenceNumber -

Returns:

listShardRecordsAfterSequenceNumber

default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> listShardRecordsAfterSequenceNumber(java.lang.String streamName,
                                                                                                                       com.amazonaws.services.kinesis.model.Shard shard,
                                                                                                                       java.lang.String startingSequenceNumber,
                                                                                                                       int batchLimit)

Parameters:

streamName - the name of the stream

shard - the shard to be used

startingSequenceNumber -

batchLimit -

Returns:

listShardRecordsAfterSequenceNumber

default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> listShardRecordsAfterSequenceNumber(java.lang.String streamName,
                                                                                                                       com.amazonaws.services.kinesis.model.Shard shard,
                                                                                                                       java.lang.String startingSequenceNumber)

Parameters:

streamName - the name of the stream

shard - the shard to be used

startingSequenceNumber -

Returns:

listShardRecordsAfterSequenceNumber

default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> listShardRecordsAfterSequenceNumber(com.amazonaws.services.kinesis.model.Shard shard,
                                                                                                                       java.lang.String startingSequenceNumber,
                                                                                                                       int batchLimit)

Parameters:

shard - the shard to be used

startingSequenceNumber -

batchLimit -

Returns:

listShardRecordsAfterSequenceNumber

default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> listShardRecordsAfterSequenceNumber(com.amazonaws.services.kinesis.model.Shard shard,
                                                                                                                       java.lang.String startingSequenceNumber)

Parameters:

shard - the shard to be used

startingSequenceNumber -

Returns:

listShardRecordsFromHorizon

default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> listShardRecordsFromHorizon(java.lang.String streamName,
                                                                                                               com.amazonaws.services.kinesis.model.Shard shard,
                                                                                                               int batchLimit)

Parameters:

streamName - the name of the stream

shard - the shard to be used

batchLimit -

Returns:

listShardRecordsFromHorizon

default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> listShardRecordsFromHorizon(java.lang.String streamName,
                                                                                                               com.amazonaws.services.kinesis.model.Shard shard)

Parameters:

streamName - the name of the stream

shard - the shard to be used

Returns:

listShardRecordsFromHorizon

default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> listShardRecordsFromHorizon(com.amazonaws.services.kinesis.model.Shard shard,
                                                                                                               int batchLimit)

Parameters:

shard - the shard to be used

batchLimit -

Returns:

listShardRecordsFromHorizon

default org.reactivestreams.Publisher<com.amazonaws.services.kinesis.model.Record> listShardRecordsFromHorizon(com.amazonaws.services.kinesis.model.Shard shard)

Parameters:

shard - the shard to be used

Returns:

listShards

default java.util.List<com.amazonaws.services.kinesis.model.Shard> listShards(java.lang.String streamName)

Parameters:

streamName - the name of the stream

Returns:

listShards

default java.util.List<com.amazonaws.services.kinesis.model.Shard> listShards()

Returns:

putEvent

com.amazonaws.services.kinesis.model.PutRecordResult putEvent(java.lang.String streamName,
                                                              Event event,
                                                              java.lang.String sequenceNumberForOrdering)

Parameters:

streamName - the name of the stream

event -

sequenceNumberForOrdering -

Returns:

putEvent

default com.amazonaws.services.kinesis.model.PutRecordResult putEvent(java.lang.String streamName,
                                                                      Event event)

Parameters:

streamName - the name of the stream

event -

Returns:

putEvent

default com.amazonaws.services.kinesis.model.PutRecordResult putEvent(Event event,
                                                                      java.lang.String sequenceNumberForOrdering)

Parameters:

event -

sequenceNumberForOrdering -

Returns:

putEvent

default com.amazonaws.services.kinesis.model.PutRecordResult putEvent(Event event)

Parameters:

event -

Returns:

putEvents

com.amazonaws.services.kinesis.model.PutRecordsResult putEvents(java.lang.String streamName,
                                                                java.util.List<Event> events)

Parameters:

streamName - the name of the stream

events -

Returns:

putEvents

default com.amazonaws.services.kinesis.model.PutRecordsResult putEvents(java.util.List<Event> events)

Parameters:

events -

Returns:

putRecord

default com.amazonaws.services.kinesis.model.PutRecordResult putRecord(java.lang.String streamName,
                                                                       java.lang.String partitionKey,
                                                                       java.lang.String data,
                                                                       java.lang.String sequenceNumberForOrdering)

Parameters:

streamName - the name of the stream

partitionKey -

data -

sequenceNumberForOrdering -

Returns:

putRecord

default com.amazonaws.services.kinesis.model.PutRecordResult putRecord(java.lang.String partitionKey,
                                                                       java.lang.String data,
                                                                       java.lang.String sequenceNumberForOrdering)

Parameters:

partitionKey -

data -

sequenceNumberForOrdering -

Returns:

putRecord

com.amazonaws.services.kinesis.model.PutRecordResult putRecord(java.lang.String streamName,
                                                               java.lang.String partitionKey,
                                                               byte[] data,
                                                               java.lang.String sequenceNumberForOrdering)

Parameters:

streamName - the name of the stream

partitionKey -

data -

sequenceNumberForOrdering -

Returns:

putRecord

default com.amazonaws.services.kinesis.model.PutRecordResult putRecord(java.lang.String streamName,
                                                                       java.lang.String partitionKey,
                                                                       byte[] data)

Parameters:

streamName - the name of the stream

partitionKey -

data -

Returns:

putRecord

default com.amazonaws.services.kinesis.model.PutRecordResult putRecord(java.lang.String partitionKey,
                                                                       byte[] data,
                                                                       java.lang.String sequenceNumberForOrdering)

Parameters:

partitionKey -

data -

sequenceNumberForOrdering -

Returns:

putRecords

com.amazonaws.services.kinesis.model.PutRecordsResult putRecords(java.lang.String streamName,
                                                                 java.util.List<com.amazonaws.services.kinesis.model.PutRecordsRequestEntry> records)

Parameters:

streamName - the name of the stream

records -

Returns:

putRecords

default com.amazonaws.services.kinesis.model.PutRecordsResult putRecords(java.util.List<com.amazonaws.services.kinesis.model.PutRecordsRequestEntry> records)

Parameters:

records -

Returns:

mergeShards

com.amazonaws.services.kinesis.model.MergeShardsResult mergeShards(java.lang.String streamName,
                                                                   java.lang.String shardId1,
                                                                   java.lang.String shardId2)

Parameters:

streamName - the name of the stream

shardId1 -

shardId2 -

mergeShards

default com.amazonaws.services.kinesis.model.MergeShardsResult mergeShards(java.lang.String shardId1,
                                                                           java.lang.String shardId2)

Parameters:

shardId1 -

shardId2 -

splitShard

com.amazonaws.services.kinesis.model.SplitShardResult splitShard(java.lang.String streamName,
                                                                 com.amazonaws.services.kinesis.model.Shard shard,
                                                                 java.lang.String newStartingHashKey)

Parameters:

streamName - the name of the stream

shard - the shard to be used

newStartingHashKey -

splitShard

default com.amazonaws.services.kinesis.model.SplitShardResult splitShard(java.lang.String streamName,
                                                                         com.amazonaws.services.kinesis.model.Shard shard)

Parameters:

streamName - the name of the stream

shard - the shard to be used

splitShard

default com.amazonaws.services.kinesis.model.SplitShardResult splitShard(java.lang.String streamName,
                                                                         java.lang.String shardId)

Parameters:

streamName - the name of the stream

shardId - the id of the shard

splitShard

default com.amazonaws.services.kinesis.model.SplitShardResult splitShard(java.lang.String shardId)

Parameters:

shardId - the id of the shard

waitForActive

default void waitForActive()

waitForStatus

default void waitForStatus(com.amazonaws.services.kinesis.model.StreamStatus status)

waitForActive

default void waitForActive(java.lang.String streamName)

waitForStatus

void waitForStatus(java.lang.String streamName,
                   com.amazonaws.services.kinesis.model.StreamStatus status)