KinesisConfig

java.lang.Object
- com.amazonaws.greengrass.streammanager.model.export.KinesisConfig

```
public class KinesisConfig
extends Object
```
Configuration object for Kinesis data streams export destination.

Constructor Summary

Constructors
Constructor and Description
`KinesisConfig()` No args constructor for use in serialization
`KinesisConfig(String identifier, String kinesisStreamName, Long batchSize, Long batchIntervalMillis, Long priority, Long startSequenceNumber, Boolean disabled)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Long`	`getBatchIntervalMillis()` The time in milliseconds between the earliest un-uploaded message and the current time.
`Long`	`getBatchSize()` The maximum size of a batch to send to Kinesis.
`Boolean`	`getDisabled()` Enable or disable this export.
`String`	`getIdentifier()` A unique identifier to identify this individual upload stream.
`String`	`getKinesisStreamName()` The name of the Kinesis data stream that this exporter should upload to.
`Long`	`getPriority()` Priority for this upload stream.
`Long`	`getStartSequenceNumber()` The sequence number of the message to use as the starting message in the export.
`int`	`hashCode()`
`void`	`setBatchIntervalMillis(Long batchIntervalMillis)` The time in milliseconds between the earliest un-uploaded message and the current time.
`void`	`setBatchSize(Long batchSize)` The maximum size of a batch to send to Kinesis.
`void`	`setDisabled(Boolean disabled)` Enable or disable this export.
`void`	`setIdentifier(String identifier)` A unique identifier to identify this individual upload stream.
`void`	`setKinesisStreamName(String kinesisStreamName)` The name of the Kinesis data stream that this exporter should upload to.
`void`	`setPriority(Long priority)` Priority for this upload stream.
`void`	`setStartSequenceNumber(Long startSequenceNumber)` The sequence number of the message to use as the starting message in the export.
`String`	`toString()`
`KinesisConfig`	`withBatchIntervalMillis(Long batchIntervalMillis)`
`KinesisConfig`	`withBatchSize(Long batchSize)`
`KinesisConfig`	`withDisabled(Boolean disabled)`
`KinesisConfig`	`withIdentifier(String identifier)`
`KinesisConfig`	`withKinesisStreamName(String kinesisStreamName)`
`KinesisConfig`	`withPriority(Long priority)`
`KinesisConfig`	`withStartSequenceNumber(Long startSequenceNumber)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KinesisConfig
```
public KinesisConfig()
```
    No args constructor for use in serialization
  - KinesisConfig
```
public KinesisConfig(String identifier,
                     String kinesisStreamName,
                     Long batchSize,
                     Long batchIntervalMillis,
                     Long priority,
                     Long startSequenceNumber,
                     Boolean disabled)
```
    Parameters:
    
    identifier -
    
    startSequenceNumber -
    
    kinesisStreamName -
    
    disabled -
    
    batchSize -
    
    priority -
    
    batchIntervalMillis -
- Method Detail
  - getIdentifier
```
public String getIdentifier()
```
    A unique identifier to identify this individual upload stream. Must be an alphanumeric string including spaces, commas, periods, hyphens, and underscores with length between 1 and 255. (Required)
  - setIdentifier
```
public void setIdentifier(String identifier)
```
    A unique identifier to identify this individual upload stream. Must be an alphanumeric string including spaces, commas, periods, hyphens, and underscores with length between 1 and 255. (Required)
  - withIdentifier
```
public KinesisConfig withIdentifier(String identifier)
```
  - getKinesisStreamName
```
public String getKinesisStreamName()
```
    The name of the Kinesis data stream that this exporter should upload to. (Required)
  - setKinesisStreamName
```
public void setKinesisStreamName(String kinesisStreamName)
```
    The name of the Kinesis data stream that this exporter should upload to. (Required)
  - withKinesisStreamName
```
public KinesisConfig withKinesisStreamName(String kinesisStreamName)
```
  - getBatchSize
```
public Long getBatchSize()
```
    The maximum size of a batch to send to Kinesis. Messages will be queued until the batch size is reached, after which they will then be uploaded. If unspecified the default will be 500. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The batch size must be between 1 and 500.
  - setBatchSize
```
public void setBatchSize(Long batchSize)
```
    The maximum size of a batch to send to Kinesis. Messages will be queued until the batch size is reached, after which they will then be uploaded. If unspecified the default will be 500. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The batch size must be between 1 and 500.
  - withBatchSize
```
public KinesisConfig withBatchSize(Long batchSize)
```
  - getBatchIntervalMillis
```
public Long getBatchIntervalMillis()
```
    The time in milliseconds between the earliest un-uploaded message and the current time. If this time is exceeded, messages will be uploaded in the next batch. If unspecified messages will be eligible for upload immediately. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The minimum value is 60000 milliseconds and the maximum is 9223372036854 milliseconds.
  - setBatchIntervalMillis
```
public void setBatchIntervalMillis(Long batchIntervalMillis)
```
    The time in milliseconds between the earliest un-uploaded message and the current time. If this time is exceeded, messages will be uploaded in the next batch. If unspecified messages will be eligible for upload immediately. If both batchSize and batchIntervalMillis are specified, then messages will be eligible for upload when either condition is met. The minimum value is 60000 milliseconds and the maximum is 9223372036854 milliseconds.
  - withBatchIntervalMillis
```
public KinesisConfig withBatchIntervalMillis(Long batchIntervalMillis)
```
  - getPriority
```
public Long getPriority()
```
    Priority for this upload stream. Lower values are higher priority. If not specified it will have the lowest priority.
  - setPriority
```
public void setPriority(Long priority)
```
    Priority for this upload stream. Lower values are higher priority. If not specified it will have the lowest priority.
  - withPriority
```
public KinesisConfig withPriority(Long priority)
```
  - getStartSequenceNumber
```
public Long getStartSequenceNumber()
```
    The sequence number of the message to use as the starting message in the export. Default is 0. The sequence number provided should be less than the newest sequence number in the stream, i.e., sequence number of the last messaged appended. To find the newest sequence number, describe the stream and then check the storage status of the returned MessageStreamInfo object.
  - setStartSequenceNumber
```
public void setStartSequenceNumber(Long startSequenceNumber)
```
    The sequence number of the message to use as the starting message in the export. Default is 0. The sequence number provided should be less than the newest sequence number in the stream, i.e., sequence number of the last messaged appended. To find the newest sequence number, describe the stream and then check the storage status of the returned MessageStreamInfo object.
  - withStartSequenceNumber
```
public KinesisConfig withStartSequenceNumber(Long startSequenceNumber)
```
  - getDisabled
```
public Boolean getDisabled()
```
    Enable or disable this export. Default is false.
  - setDisabled
```
public void setDisabled(Boolean disabled)
```
    Enable or disable this export. Default is false.
  - withDisabled
```
public KinesisConfig withDisabled(Boolean disabled)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object

Class KinesisConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KinesisConfig

KinesisConfig

Method Detail

getIdentifier

setIdentifier

withIdentifier

getKinesisStreamName

setKinesisStreamName

withKinesisStreamName

getBatchSize

setBatchSize

withBatchSize

getBatchIntervalMillis

setBatchIntervalMillis

withBatchIntervalMillis

getPriority

setPriority

withPriority

getStartSequenceNumber

setStartSequenceNumber

withStartSequenceNumber

getDisabled

setDisabled

withDisabled

toString

hashCode

equals