com.amazonaws.mobileconnectors.kinesis.kinesisrecorder

Class KinesisRecorderConfig

java.lang.Object

com.amazonaws.mobileconnectors.kinesis.kinesisrecorder.KinesisRecorderConfig

public class KinesisRecorderConfig
extends java.lang.Object

Allows configuration of certain KinesisRecorder parameters, such as maxStoargeSize

Constructor Summary

Constructors

Constructor and Description
KinesisRecorderConfig() Construct an instance of KinesisRecorderConfig which has default values of maxStorageSize = 5MiB; and a default ClientConfiguration
KinesisRecorderConfig(ClientConfiguration clientConfiguration) Construct an instance of KinesisRecorderConfig which has default values of maxStorageSize = 5MiB; and the specified ClientConfiguration
KinesisRecorderConfig(KinesisRecorderConfig other) Creates a copy of the passed in KinesisRecorderConfig

Method Summary

Methods

Modifier and Type	Method and Description
ClientConfiguration	getClientConfiguration() Returns the client configuration the Kinesis Recorder will use when making requests to Amazon Kinesis
long	getMaxStorageSize()
KinesisRecorderConfig	withMaxStorageSize(long maxStorageSize) Sets the max storage in bytes that KinesisRecorder is allowed to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

KinesisRecorderConfig

public KinesisRecorderConfig()

Construct an instance of KinesisRecorderConfig which has default values of maxStorageSize = 5MiB; and a default ClientConfiguration

KinesisRecorderConfig

public KinesisRecorderConfig(ClientConfiguration clientConfiguration)

Construct an instance of KinesisRecorderConfig which has default values of maxStorageSize = 5MiB; and the specified ClientConfiguration

Parameters:

clientConfiguration - The client configuration used when making requests to Amazon Kinesis

KinesisRecorderConfig

public KinesisRecorderConfig(KinesisRecorderConfig other)

Creates a copy of the passed in KinesisRecorderConfig

Parameters:

other - the KinesisRecorderConfig to copy.

Method Detail

withMaxStorageSize

public KinesisRecorderConfig withMaxStorageSize(long maxStorageSize)

Sets the max storage in bytes that KinesisRecorder is allowed to use. Requests saved that exceed the max stoarge limit will be dropped.

Parameters:

maxStorageSize -

Returns:

This class for chaining

getMaxStorageSize

public long getMaxStorageSize()

Returns:

The current max storage in bytes that KinesisRecorder is allowed to use.

getClientConfiguration

public ClientConfiguration getClientConfiguration()

Returns the client configuration the Kinesis Recorder will use when making requests to Amazon Kinesis

Returns:

The client configuration