Stream (AWS Java SDK for Amazon Interactive Video 1.12.1 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Stream
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies a live video stream that has been ingested and distributed.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Stream()

Constructors
Constructor and Description
`Stream()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Stream`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getChannelArn()` Channel ARN for the stream.
`String`	`getHealth()` The stream’s health.
`String`	`getPlaybackUrl()` URL of the master playlist, required by the video player to play the HLS stream.
`Date`	`getStartTime()` ISO-8601 formatted timestamp of the stream’s start.
`String`	`getState()` The stream’s state.
`Long`	`getViewerCount()` Number of current viewers of the stream.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setChannelArn(String channelArn)` Channel ARN for the stream.
`void`	`setHealth(String health)` The stream’s health.
`void`	`setPlaybackUrl(String playbackUrl)` URL of the master playlist, required by the video player to play the HLS stream.
`void`	`setStartTime(Date startTime)` ISO-8601 formatted timestamp of the stream’s start.
`void`	`setState(String state)` The stream’s state.
`void`	`setViewerCount(Long viewerCount)` Number of current viewers of the stream.
`String`	`toString()` Returns a string representation of this object.
`Stream`	`withChannelArn(String channelArn)` Channel ARN for the stream.
`Stream`	`withHealth(StreamHealth health)` The stream’s health.
`Stream`	`withHealth(String health)` The stream’s health.
`Stream`	`withPlaybackUrl(String playbackUrl)` URL of the master playlist, required by the video player to play the HLS stream.
`Stream`	`withStartTime(Date startTime)` ISO-8601 formatted timestamp of the stream’s start.
`Stream`	`withState(StreamState state)` The stream’s state.
`Stream`	`withState(String state)` The stream’s state.
`Stream`	`withViewerCount(Long viewerCount)` Number of current viewers of the stream.

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

- Constructor Detail
  - Stream
```
public Stream()
```
- Method Detail
  - setChannelArn
```
public void setChannelArn(String channelArn)
```
    Channel ARN for the stream.
    
    Parameters:
    
    channelArn - Channel ARN for the stream.
  - getChannelArn
```
public String getChannelArn()
```
    Channel ARN for the stream.
    
    Returns:
    
    Channel ARN for the stream.
  - withChannelArn
```
public Stream withChannelArn(String channelArn)
```
    Channel ARN for the stream.
    
    Parameters:
    
    channelArn - Channel ARN for the stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlaybackUrl
```
public void setPlaybackUrl(String playbackUrl)
```
    URL of the master playlist, required by the video player to play the HLS stream.
    
    Parameters:
    
    playbackUrl - URL of the master playlist, required by the video player to play the HLS stream.
  - getPlaybackUrl
```
public String getPlaybackUrl()
```
    URL of the master playlist, required by the video player to play the HLS stream.
    
    Returns:
    
    URL of the master playlist, required by the video player to play the HLS stream.
  - withPlaybackUrl
```
public Stream withPlaybackUrl(String playbackUrl)
```
    URL of the master playlist, required by the video player to play the HLS stream.
    
    Parameters:
    
    playbackUrl - URL of the master playlist, required by the video player to play the HLS stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    ISO-8601 formatted timestamp of the stream’s start.
    
    Parameters:
    
    startTime - ISO-8601 formatted timestamp of the stream’s start.
  - getStartTime
```
public Date getStartTime()
```
    ISO-8601 formatted timestamp of the stream’s start.
    
    Returns:
    
    ISO-8601 formatted timestamp of the stream’s start.
  - withStartTime
```
public Stream withStartTime(Date startTime)
```
    ISO-8601 formatted timestamp of the stream’s start.
    
    Parameters:
    
    startTime - ISO-8601 formatted timestamp of the stream’s start.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The stream’s state.
    
    Parameters:
    
    state - The stream’s state.
    
    See Also:
    
    StreamState
  - getState
```
public String getState()
```
    The stream’s state.
    
    Returns:
    
    The stream’s state.
    
    See Also:
    
    StreamState
  - withState
```
public Stream withState(String state)
```
    The stream’s state.
    
    Parameters:
    
    state - The stream’s state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamState
  - withState
```
public Stream withState(StreamState state)
```
    The stream’s state.
    
    Parameters:
    
    state - The stream’s state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamState
  - setHealth
```
public void setHealth(String health)
```
    The stream’s health.
    
    Parameters:
    
    health - The stream’s health.
    
    See Also:
    
    StreamHealth
  - getHealth
```
public String getHealth()
```
    The stream’s health.
    
    Returns:
    
    The stream’s health.
    
    See Also:
    
    StreamHealth
  - withHealth
```
public Stream withHealth(String health)
```
    The stream’s health.
    
    Parameters:
    
    health - The stream’s health.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamHealth
  - withHealth
```
public Stream withHealth(StreamHealth health)
```
    The stream’s health.
    
    Parameters:
    
    health - The stream’s health.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamHealth
  - setViewerCount
```
public void setViewerCount(Long viewerCount)
```
    Number of current viewers of the stream. A value of -1 indicates that the request timed out; in this case, retry.
    
    Parameters:
    
    viewerCount - Number of current viewers of the stream. A value of -1 indicates that the request timed out; in this case, retry.
  - getViewerCount
```
public Long getViewerCount()
```
    Number of current viewers of the stream. A value of -1 indicates that the request timed out; in this case, retry.
    
    Returns:
    
    Number of current viewers of the stream. A value of -1 indicates that the request timed out; in this case, retry.
  - withViewerCount
```
public Stream withViewerCount(Long viewerCount)
```
    Number of current viewers of the stream. A value of -1 indicates that the request timed out; in this case, retry.
    
    Parameters:
    
    viewerCount - Number of current viewers of the stream. A value of -1 indicates that the request timed out; in this case, retry.
    
    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 Stream clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Stream

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Stream

Method Detail

setChannelArn

getChannelArn

withChannelArn

setPlaybackUrl

getPlaybackUrl

withPlaybackUrl

setStartTime

getStartTime

withStartTime

setState

getState

withState

withState

setHealth

getHealth

withHealth

withHealth

setViewerCount

getViewerCount

withViewerCount

toString

equals

hashCode

clone

marshall