MessageStreamDefinition

java.lang.Object
- com.amazonaws.greengrass.streammanager.model.MessageStreamDefinition

```
public class MessageStreamDefinition
extends Object
```
Object defining a message stream used in the CreateMessageStream and UpdateMessageStream API.

Constructor Summary

Constructors
Constructor and Description
`MessageStreamDefinition()` No args constructor for use in serialization
`MessageStreamDefinition(String name, Long maxSize, Long streamSegmentSize, Long timeToLiveMillis, StrategyOnFull strategyOnFull, Persistence persistence, Boolean flushOnWrite, ExportDefinition exportDefinition)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`ExportDefinition`	`getExportDefinition()` Defines how and where the stream is uploaded.
`Boolean`	`getFlushOnWrite()` This only applies when Persistence is set to File mode.
`Long`	`getMaxSize()` The maximum size in bytes for the entire stream.
`String`	`getName()` The unique name of the stream.
`Persistence`	`getPersistence()` Stream persistence.
`StrategyOnFull`	`getStrategyOnFull()` StrategyOnFull is used in the MessageStreamDefinition when creating a stream.
`Long`	`getStreamSegmentSize()` The size of each segment of the stream.
`Long`	`getTimeToLiveMillis()` Time to live for each message in milliseconds.
`int`	`hashCode()`
`void`	`setExportDefinition(ExportDefinition exportDefinition)` Defines how and where the stream is uploaded.
`void`	`setFlushOnWrite(Boolean flushOnWrite)` This only applies when Persistence is set to File mode.
`void`	`setMaxSize(Long maxSize)` The maximum size in bytes for the entire stream.
`void`	`setName(String name)` The unique name of the stream.
`void`	`setPersistence(Persistence persistence)` Stream persistence.
`void`	`setStrategyOnFull(StrategyOnFull strategyOnFull)` StrategyOnFull is used in the MessageStreamDefinition when creating a stream.
`void`	`setStreamSegmentSize(Long streamSegmentSize)` The size of each segment of the stream.
`void`	`setTimeToLiveMillis(Long timeToLiveMillis)` Time to live for each message in milliseconds.
`String`	`toString()`
`MessageStreamDefinition`	`withExportDefinition(ExportDefinition exportDefinition)`
`MessageStreamDefinition`	`withFlushOnWrite(Boolean flushOnWrite)`
`MessageStreamDefinition`	`withMaxSize(Long maxSize)`
`MessageStreamDefinition`	`withName(String name)`
`MessageStreamDefinition`	`withPersistence(Persistence persistence)`
`MessageStreamDefinition`	`withStrategyOnFull(StrategyOnFull strategyOnFull)`
`MessageStreamDefinition`	`withStreamSegmentSize(Long streamSegmentSize)`
`MessageStreamDefinition`	`withTimeToLiveMillis(Long timeToLiveMillis)`

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

- Constructor Detail
  - MessageStreamDefinition
```
public MessageStreamDefinition()
```
    No args constructor for use in serialization
  - MessageStreamDefinition
```
public MessageStreamDefinition(String name,
                               Long maxSize,
                               Long streamSegmentSize,
                               Long timeToLiveMillis,
                               StrategyOnFull strategyOnFull,
                               Persistence persistence,
                               Boolean flushOnWrite,
                               ExportDefinition exportDefinition)
```
    Parameters:
    
    flushOnWrite -
    
    exportDefinition -
    
    timeToLiveMillis -
    
    strategyOnFull -
    
    streamSegmentSize -
    
    name -
    
    persistence -
    
    maxSize -
- Method Detail
  - getName
```
public String getName()
```
    The unique name of the stream. Must be an alphanumeric string including spaces, commas, periods, hyphens, and underscores with length between 1 and 255. (Required)
  - setName
```
public void setName(String name)
```
    The unique name of the stream. Must be an alphanumeric string including spaces, commas, periods, hyphens, and underscores with length between 1 and 255. (Required)
  - withName
```
public MessageStreamDefinition withName(String name)
```
  - getMaxSize
```
public Long getMaxSize()
```
    The maximum size in bytes for the entire stream. Set to 256MB by default with a minimum of 1KB and a maximum of 8192PB.
  - setMaxSize
```
public void setMaxSize(Long maxSize)
```
    The maximum size in bytes for the entire stream. Set to 256MB by default with a minimum of 1KB and a maximum of 8192PB.
  - withMaxSize
```
public MessageStreamDefinition withMaxSize(Long maxSize)
```
  - getStreamSegmentSize
```
public Long getStreamSegmentSize()
```
    The size of each segment of the stream. Set to 16MB by default with a minimum of 1KB and a maximum of 2GB. Data is only deleted segment by segment, so the segment size is the smallest amount of data which can be deleted.
  - setStreamSegmentSize
```
public void setStreamSegmentSize(Long streamSegmentSize)
```
    The size of each segment of the stream. Set to 16MB by default with a minimum of 1KB and a maximum of 2GB. Data is only deleted segment by segment, so the segment size is the smallest amount of data which can be deleted.
  - withStreamSegmentSize
```
public MessageStreamDefinition withStreamSegmentSize(Long streamSegmentSize)
```
  - getTimeToLiveMillis
```
public Long getTimeToLiveMillis()
```
    Time to live for each message in milliseconds. Data may be deleted at any time after the TTL expires; deletion is not guaranteed to occur immediately when the TTL expires. The minimum value is 60000 milliseconds and the maximum is 9223372036854 milliseconds.
  - setTimeToLiveMillis
```
public void setTimeToLiveMillis(Long timeToLiveMillis)
```
    Time to live for each message in milliseconds. Data may be deleted at any time after the TTL expires; deletion is not guaranteed to occur immediately when the TTL expires. The minimum value is 60000 milliseconds and the maximum is 9223372036854 milliseconds.
  - withTimeToLiveMillis
```
public MessageStreamDefinition withTimeToLiveMillis(Long timeToLiveMillis)
```
  - getStrategyOnFull
```
public StrategyOnFull getStrategyOnFull()
```
    StrategyOnFull is used in the MessageStreamDefinition when creating a stream. It defines the behavior when the stream has reached the maximum size. RejectNewData: any append message request after the stream is full will be rejected with an exception. OverwriteOldestData: the oldest stream segments will be deleted until there is room for the new message. (Required)
  - setStrategyOnFull
```
public void setStrategyOnFull(StrategyOnFull strategyOnFull)
```
    StrategyOnFull is used in the MessageStreamDefinition when creating a stream. It defines the behavior when the stream has reached the maximum size. RejectNewData: any append message request after the stream is full will be rejected with an exception. OverwriteOldestData: the oldest stream segments will be deleted until there is room for the new message. (Required)
  - withStrategyOnFull
```
public MessageStreamDefinition withStrategyOnFull(StrategyOnFull strategyOnFull)
```
  - getPersistence
```
public Persistence getPersistence()
```
    Stream persistence. If set to File, the file system will be used to persist messages long-term and is resilient to restarts. Memory should be used when performance matters more than durability as it only stores the stream in memory and never writes to the disk.
  - setPersistence
```
public void setPersistence(Persistence persistence)
```
    Stream persistence. If set to File, the file system will be used to persist messages long-term and is resilient to restarts. Memory should be used when performance matters more than durability as it only stores the stream in memory and never writes to the disk.
  - withPersistence
```
public MessageStreamDefinition withPersistence(Persistence persistence)
```
  - getFlushOnWrite
```
public Boolean getFlushOnWrite()
```
    This only applies when Persistence is set to File mode. Waits for the filesystem to complete the write for every message. This is safer, but slower. Default is false.
  - setFlushOnWrite
```
public void setFlushOnWrite(Boolean flushOnWrite)
```
    This only applies when Persistence is set to File mode. Waits for the filesystem to complete the write for every message. This is safer, but slower. Default is false.
  - withFlushOnWrite
```
public MessageStreamDefinition withFlushOnWrite(Boolean flushOnWrite)
```
  - getExportDefinition
```
public ExportDefinition getExportDefinition()
```
    Defines how and where the stream is uploaded.
  - setExportDefinition
```
public void setExportDefinition(ExportDefinition exportDefinition)
```
    Defines how and where the stream is uploaded.
  - withExportDefinition
```
public MessageStreamDefinition withExportDefinition(ExportDefinition exportDefinition)
```
  - 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 MessageStreamDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MessageStreamDefinition

MessageStreamDefinition

Method Detail

getName

setName

withName

getMaxSize

setMaxSize

withMaxSize

getStreamSegmentSize

setStreamSegmentSize

withStreamSegmentSize

getTimeToLiveMillis

setTimeToLiveMillis

withTimeToLiveMillis

getStrategyOnFull

setStrategyOnFull

withStrategyOnFull

getPersistence

setPersistence

withPersistence

getFlushOnWrite

setFlushOnWrite

withFlushOnWrite

getExportDefinition

setExportDefinition

withExportDefinition

toString

hashCode

equals