StreamSession (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ivs.model.StreamSession

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StreamSession
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StreamSession()

Constructors
Constructor and Description
`StreamSession()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StreamSession`	`clone()`
`boolean`	`equals(Object obj)`
`Channel`	`getChannel()` The properties of the channel at the time of going live.
`Date`	`getEndTime()` Time when the channel went offline.
`IngestConfiguration`	`getIngestConfiguration()` The properties of the incoming RTMP stream for the stream.
`RecordingConfiguration`	`getRecordingConfiguration()` The properties of recording the live stream.
`Date`	`getStartTime()` Time when the channel went live.
`String`	`getStreamId()` Unique identifier for a live or previously live stream in the specified channel.
`List<StreamEvent>`	`getTruncatedEvents()` List of Amazon IVS events that the stream encountered.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setChannel(Channel channel)` The properties of the channel at the time of going live.
`void`	`setEndTime(Date endTime)` Time when the channel went offline.
`void`	`setIngestConfiguration(IngestConfiguration ingestConfiguration)` The properties of the incoming RTMP stream for the stream.
`void`	`setRecordingConfiguration(RecordingConfiguration recordingConfiguration)` The properties of recording the live stream.
`void`	`setStartTime(Date startTime)` Time when the channel went live.
`void`	`setStreamId(String streamId)` Unique identifier for a live or previously live stream in the specified channel.
`void`	`setTruncatedEvents(Collection<StreamEvent> truncatedEvents)` List of Amazon IVS events that the stream encountered.
`String`	`toString()` Returns a string representation of this object.
`StreamSession`	`withChannel(Channel channel)` The properties of the channel at the time of going live.
`StreamSession`	`withEndTime(Date endTime)` Time when the channel went offline.
`StreamSession`	`withIngestConfiguration(IngestConfiguration ingestConfiguration)` The properties of the incoming RTMP stream for the stream.
`StreamSession`	`withRecordingConfiguration(RecordingConfiguration recordingConfiguration)` The properties of recording the live stream.
`StreamSession`	`withStartTime(Date startTime)` Time when the channel went live.
`StreamSession`	`withStreamId(String streamId)` Unique identifier for a live or previously live stream in the specified channel.
`StreamSession`	`withTruncatedEvents(Collection<StreamEvent> truncatedEvents)` List of Amazon IVS events that the stream encountered.
`StreamSession`	`withTruncatedEvents(StreamEvent... truncatedEvents)` List of Amazon IVS events that the stream encountered.

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

- Constructor Detail
  - StreamSession
```
public StreamSession()
```
- Method Detail
  - setStreamId
```
public void setStreamId(String streamId)
```
    Unique identifier for a live or previously live stream in the specified channel.
    
    Parameters:
    
    streamId - Unique identifier for a live or previously live stream in the specified channel.
  - getStreamId
```
public String getStreamId()
```
    Unique identifier for a live or previously live stream in the specified channel.
    
    Returns:
    
    Unique identifier for a live or previously live stream in the specified channel.
  - withStreamId
```
public StreamSession withStreamId(String streamId)
```
    Unique identifier for a live or previously live stream in the specified channel.
    
    Parameters:
    
    streamId - Unique identifier for a live or previously live stream in the specified channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
    
    Parameters:
    
    startTime - Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
  - getStartTime
```
public Date getStartTime()
```
    Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
    
    Returns:
    
    Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
  - withStartTime
```
public StreamSession withStartTime(Date startTime)
```
    Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
    
    Parameters:
    
    startTime - Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
    
    Parameters:
    
    endTime - Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
  - getEndTime
```
public Date getEndTime()
```
    Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
    
    Returns:
    
    Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
  - withEndTime
```
public StreamSession withEndTime(Date endTime)
```
    Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
    
    Parameters:
    
    endTime - Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChannel
```
public void setChannel(Channel channel)
```
    The properties of the channel at the time of going live.
    
    Parameters:
    
    channel - The properties of the channel at the time of going live.
  - getChannel
```
public Channel getChannel()
```
    The properties of the channel at the time of going live.
    
    Returns:
    
    The properties of the channel at the time of going live.
  - withChannel
```
public StreamSession withChannel(Channel channel)
```
    The properties of the channel at the time of going live.
    
    Parameters:
    
    channel - The properties of the channel at the time of going live.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIngestConfiguration
```
public void setIngestConfiguration(IngestConfiguration ingestConfiguration)
```
    The properties of the incoming RTMP stream for the stream.
    
    Parameters:
    
    ingestConfiguration - The properties of the incoming RTMP stream for the stream.
  - getIngestConfiguration
```
public IngestConfiguration getIngestConfiguration()
```
    The properties of the incoming RTMP stream for the stream.
    
    Returns:
    
    The properties of the incoming RTMP stream for the stream.
  - withIngestConfiguration
```
public StreamSession withIngestConfiguration(IngestConfiguration ingestConfiguration)
```
    The properties of the incoming RTMP stream for the stream.
    
    Parameters:
    
    ingestConfiguration - The properties of the incoming RTMP stream for the stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecordingConfiguration
```
public void setRecordingConfiguration(RecordingConfiguration recordingConfiguration)
```
    The properties of recording the live stream.
    
    Parameters:
    
    recordingConfiguration - The properties of recording the live stream.
  - getRecordingConfiguration
```
public RecordingConfiguration getRecordingConfiguration()
```
    The properties of recording the live stream.
    
    Returns:
    
    The properties of recording the live stream.
  - withRecordingConfiguration
```
public StreamSession withRecordingConfiguration(RecordingConfiguration recordingConfiguration)
```
    The properties of recording the live stream.
    
    Parameters:
    
    recordingConfiguration - The properties of recording the live stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTruncatedEvents
```
public List<StreamEvent> getTruncatedEvents()
```
    List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
    
    Returns:
    
    List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
  - setTruncatedEvents
```
public void setTruncatedEvents(Collection<StreamEvent> truncatedEvents)
```
    List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
    
    Parameters:
    
    truncatedEvents - List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
  - withTruncatedEvents
```
public StreamSession withTruncatedEvents(StreamEvent... truncatedEvents)
```
    List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
    
    NOTE: This method appends the values to the existing list (if any). Use setTruncatedEvents(java.util.Collection) or withTruncatedEvents(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    truncatedEvents - List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTruncatedEvents
```
public StreamSession withTruncatedEvents(Collection<StreamEvent> truncatedEvents)
```
    List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
    
    Parameters:
    
    truncatedEvents - List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StreamSession clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class StreamSession

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StreamSession

Method Detail

setStreamId

getStreamId

withStreamId

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

setChannel

getChannel

withChannel

setIngestConfiguration

getIngestConfiguration

withIngestConfiguration

setRecordingConfiguration

getRecordingConfiguration

withRecordingConfiguration

getTruncatedEvents

setTruncatedEvents

withTruncatedEvents

withTruncatedEvents

toString

equals

hashCode

clone

marshall