StreamSummary (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StreamSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

Summary information about a stream.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StreamSummary()

Constructors
Constructor and Description
`StreamSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StreamSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getChannelArn()` Channel ARN for the stream.
`String`	`getHealth()` The stream’s health.
`Date`	`getStartTime()` Time of the stream’s start.
`String`	`getState()` The stream’s state.
`String`	`getStreamId()` Unique identifier for a live or previously live stream in the specified channel.
`Long`	`getViewerCount()` A count of concurrent views of the stream.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setChannelArn(String channelArn)` Channel ARN for the stream.
`void`	`setHealth(String health)` The stream’s health.
`void`	`setStartTime(Date startTime)` Time of the stream’s start.
`void`	`setState(String state)` The stream’s state.
`void`	`setStreamId(String streamId)` Unique identifier for a live or previously live stream in the specified channel.
`void`	`setViewerCount(Long viewerCount)` A count of concurrent views of the stream.
`String`	`toString()` Returns a string representation of this object.
`StreamSummary`	`withChannelArn(String channelArn)` Channel ARN for the stream.
`StreamSummary`	`withHealth(StreamHealth health)` The stream’s health.
`StreamSummary`	`withHealth(String health)` The stream’s health.
`StreamSummary`	`withStartTime(Date startTime)` Time of the stream’s start.
`StreamSummary`	`withState(StreamState state)` The stream’s state.
`StreamSummary`	`withState(String state)` The stream’s state.
`StreamSummary`	`withStreamId(String streamId)` Unique identifier for a live or previously live stream in the specified channel.
`StreamSummary`	`withViewerCount(Long viewerCount)` A count of concurrent views of the stream.

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

- Constructor Detail
  - StreamSummary
```
public StreamSummary()
```
- 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 StreamSummary 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.
  - 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 StreamSummary 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.
  - setState
```
public void setState(String state)
```
    The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
    
    Parameters:
    
    state - The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
    
    See Also:
    
    StreamState
  - getState
```
public String getState()
```
    The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
    
    Returns:
    
    The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
    
    See Also:
    
    StreamState
  - withState
```
public StreamSummary withState(String state)
```
    The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
    
    Parameters:
    
    state - The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StreamState
  - withState
```
public StreamSummary withState(StreamState state)
```
    The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
    
    Parameters:
    
    state - The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
    
    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 StreamSummary 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 StreamSummary 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)
```
    A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
    
    Parameters:
    
    viewerCount - A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
  - getViewerCount
```
public Long getViewerCount()
```
    A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
    
    Returns:
    
    A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
  - withViewerCount
```
public StreamSummary withViewerCount(Long viewerCount)
```
    A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
    
    Parameters:
    
    viewerCount - A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. 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.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
    
    Parameters:
    
    startTime - Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
  - getStartTime
```
public Date getStartTime()
```
    Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
    
    Returns:
    
    Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
  - withStartTime
```
public StreamSummary withStartTime(Date startTime)
```
    Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
    
    Parameters:
    
    startTime - Time of the stream’s start. 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.
  - 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 StreamSummary 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.793

Class StreamSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StreamSummary

Method Detail

setChannelArn

getChannelArn

withChannelArn

setStreamId

getStreamId

withStreamId

setState

getState

withState

withState

setHealth

getHealth

withHealth

withHealth

setViewerCount

getViewerCount

withViewerCount

setStartTime

getStartTime

withStartTime

toString

equals

hashCode

clone

marshall