ChannelSummary (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Summary information about a channel.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ChannelSummary()

Constructors
Constructor and Description
`ChannelSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ChannelSummary`	`addTagsEntry(String key, String value)` Add a single Tags entry
`ChannelSummary`	`clearTagsEntries()` Removes all the entries added into Tags.
`ChannelSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` Channel ARN.
`Boolean`	`getAuthorized()` Whether the channel is private (enabled for playback authorization).
`String`	`getLatencyMode()` Channel latency mode.
`String`	`getName()` Channel name.
`String`	`getRecordingConfigurationArn()` Recording-configuration ARN.
`Map<String,String>`	`getTags()` Array of 1-50 maps, each of the form `string:string (key:value)`.
`int`	`hashCode()`
`Boolean`	`isAuthorized()` Whether the channel is private (enabled for playback authorization).
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` Channel ARN.
`void`	`setAuthorized(Boolean authorized)` Whether the channel is private (enabled for playback authorization).
`void`	`setLatencyMode(String latencyMode)` Channel latency mode.
`void`	`setName(String name)` Channel name.
`void`	`setRecordingConfigurationArn(String recordingConfigurationArn)` Recording-configuration ARN.
`void`	`setTags(Map<String,String> tags)` Array of 1-50 maps, each of the form `string:string (key:value)`.
`String`	`toString()` Returns a string representation of this object.
`ChannelSummary`	`withArn(String arn)` Channel ARN.
`ChannelSummary`	`withAuthorized(Boolean authorized)` Whether the channel is private (enabled for playback authorization).
`ChannelSummary`	`withLatencyMode(ChannelLatencyMode latencyMode)` Channel latency mode.
`ChannelSummary`	`withLatencyMode(String latencyMode)` Channel latency mode.
`ChannelSummary`	`withName(String name)` Channel name.
`ChannelSummary`	`withRecordingConfigurationArn(String recordingConfigurationArn)` Recording-configuration ARN.
`ChannelSummary`	`withTags(Map<String,String> tags)` Array of 1-50 maps, each of the form `string:string (key:value)`.

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

- Constructor Detail
  - ChannelSummary
```
public ChannelSummary()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    Channel ARN.
    
    Parameters:
    
    arn - Channel ARN.
  - getArn
```
public String getArn()
```
    Channel ARN.
    
    Returns:
    
    Channel ARN.
  - withArn
```
public ChannelSummary withArn(String arn)
```
    Channel ARN.
    
    Parameters:
    
    arn - Channel ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    Channel name.
    
    Parameters:
    
    name - Channel name.
  - getName
```
public String getName()
```
    Channel name.
    
    Returns:
    
    Channel name.
  - withName
```
public ChannelSummary withName(String name)
```
    Channel name.
    
    Parameters:
    
    name - Channel name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLatencyMode
```
public void setLatencyMode(String latencyMode)
```
    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    Parameters:
    
    latencyMode - Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    See Also:
    
    ChannelLatencyMode
  - getLatencyMode
```
public String getLatencyMode()
```
    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    Returns:
    
    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    See Also:
    
    ChannelLatencyMode
  - withLatencyMode
```
public ChannelSummary withLatencyMode(String latencyMode)
```
    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    Parameters:
    
    latencyMode - Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelLatencyMode
  - withLatencyMode
```
public ChannelSummary withLatencyMode(ChannelLatencyMode latencyMode)
```
    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    Parameters:
    
    latencyMode - Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelLatencyMode
  - setAuthorized
```
public void setAuthorized(Boolean authorized)
```
    Whether the channel is private (enabled for playback authorization). Default: false.
    
    Parameters:
    
    authorized - Whether the channel is private (enabled for playback authorization). Default: false.
  - getAuthorized
```
public Boolean getAuthorized()
```
    Whether the channel is private (enabled for playback authorization). Default: false.
    
    Returns:
    
    Whether the channel is private (enabled for playback authorization). Default: false.
  - withAuthorized
```
public ChannelSummary withAuthorized(Boolean authorized)
```
    Whether the channel is private (enabled for playback authorization). Default: false.
    
    Parameters:
    
    authorized - Whether the channel is private (enabled for playback authorization). Default: false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAuthorized
```
public Boolean isAuthorized()
```
    Whether the channel is private (enabled for playback authorization). Default: false.
    
    Returns:
    
    Whether the channel is private (enabled for playback authorization). Default: false.
  - setRecordingConfigurationArn
```
public void setRecordingConfigurationArn(String recordingConfigurationArn)
```
    Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
    
    Parameters:
    
    recordingConfigurationArn - Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
  - getRecordingConfigurationArn
```
public String getRecordingConfigurationArn()
```
    Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
    
    Returns:
    
    Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
  - withRecordingConfigurationArn
```
public ChannelSummary withRecordingConfigurationArn(String recordingConfigurationArn)
```
    Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
    
    Parameters:
    
    recordingConfigurationArn - Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    Array of 1-50 maps, each of the form string:string (key:value).
    
    Returns:
    
    Array of 1-50 maps, each of the form string:string (key:value).
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Array of 1-50 maps, each of the form string:string (key:value).
    
    Parameters:
    
    tags - Array of 1-50 maps, each of the form string:string (key:value).
  - withTags
```
public ChannelSummary withTags(Map<String,String> tags)
```
    Array of 1-50 maps, each of the form string:string (key:value).
    
    Parameters:
    
    tags - Array of 1-50 maps, each of the form string:string (key:value).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public ChannelSummary addTagsEntry(String key,
                                   String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public ChannelSummary clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    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 ChannelSummary 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.

Did this page help you?

Class ChannelSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChannelSummary

Method Detail

setArn

getArn

withArn

setName

getName

withName

setLatencyMode

getLatencyMode

withLatencyMode

withLatencyMode

setAuthorized

getAuthorized

withAuthorized

isAuthorized

setRecordingConfigurationArn

getRecordingConfigurationArn

withRecordingConfigurationArn

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall