Channel (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Object specifying a channel.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Channel()

Constructors
Constructor and Description
`Channel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Channel`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Channel`	`clearTagsEntries()` Removes all the entries added into Tags.
`Channel`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` Channel ARN.
`Boolean`	`getAuthorized()` Whether the channel is private (enabled for playback authorization).
`String`	`getIngestEndpoint()` Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
`Boolean`	`getInsecureIngest()` Whether the channel allows insecure RTMP ingest.
`String`	`getLatencyMode()` Channel latency mode.
`String`	`getName()` Channel name.
`String`	`getPlaybackRestrictionPolicyArn()` Playback-restriction-policy ARN.
`String`	`getPlaybackUrl()` Channel playback URL.
`String`	`getPreset()` Optional transcode preset for the channel.
`String`	`getRecordingConfigurationArn()` Recording-configuration ARN.
`Srt`	`getSrt()` Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
`Map<String,String>`	`getTags()` Tags attached to the resource.
`String`	`getType()` Channel type, which determines the allowable resolution and bitrate.
`int`	`hashCode()`
`Boolean`	`isAuthorized()` Whether the channel is private (enabled for playback authorization).
`Boolean`	`isInsecureIngest()` Whether the channel allows insecure RTMP ingest.
`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`	`setIngestEndpoint(String ingestEndpoint)` Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
`void`	`setInsecureIngest(Boolean insecureIngest)` Whether the channel allows insecure RTMP ingest.
`void`	`setLatencyMode(String latencyMode)` Channel latency mode.
`void`	`setName(String name)` Channel name.
`void`	`setPlaybackRestrictionPolicyArn(String playbackRestrictionPolicyArn)` Playback-restriction-policy ARN.
`void`	`setPlaybackUrl(String playbackUrl)` Channel playback URL.
`void`	`setPreset(String preset)` Optional transcode preset for the channel.
`void`	`setRecordingConfigurationArn(String recordingConfigurationArn)` Recording-configuration ARN.
`void`	`setSrt(Srt srt)` Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
`void`	`setTags(Map<String,String> tags)` Tags attached to the resource.
`void`	`setType(String type)` Channel type, which determines the allowable resolution and bitrate.
`String`	`toString()` Returns a string representation of this object.
`Channel`	`withArn(String arn)` Channel ARN.
`Channel`	`withAuthorized(Boolean authorized)` Whether the channel is private (enabled for playback authorization).
`Channel`	`withIngestEndpoint(String ingestEndpoint)` Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
`Channel`	`withInsecureIngest(Boolean insecureIngest)` Whether the channel allows insecure RTMP ingest.
`Channel`	`withLatencyMode(ChannelLatencyMode latencyMode)` Channel latency mode.
`Channel`	`withLatencyMode(String latencyMode)` Channel latency mode.
`Channel`	`withName(String name)` Channel name.
`Channel`	`withPlaybackRestrictionPolicyArn(String playbackRestrictionPolicyArn)` Playback-restriction-policy ARN.
`Channel`	`withPlaybackUrl(String playbackUrl)` Channel playback URL.
`Channel`	`withPreset(String preset)` Optional transcode preset for the channel.
`Channel`	`withPreset(TranscodePreset preset)` Optional transcode preset for the channel.
`Channel`	`withRecordingConfigurationArn(String recordingConfigurationArn)` Recording-configuration ARN.
`Channel`	`withSrt(Srt srt)` Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
`Channel`	`withTags(Map<String,String> tags)` Tags attached to the resource.
`Channel`	`withType(ChannelType type)` Channel type, which determines the allowable resolution and bitrate.
`Channel`	`withType(String type)` Channel type, which determines the allowable resolution and bitrate.

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

- Constructor Detail
  - Channel
```
public Channel()
```
- 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 Channel 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 Channel 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.
    
    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.
    
    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.
    
    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.
    
    See Also:
    
    ChannelLatencyMode
  - withLatencyMode
```
public Channel 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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelLatencyMode
  - withLatencyMode
```
public Channel 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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelLatencyMode
  - setType
```
public void setType(String type)
```
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
    
    Parameters:
    
    type - Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD . For details, see Channel Types.
    
    See Also:
    
    ChannelType
  - getType
```
public String getType()
```
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
    
    Returns:
    
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
    
    See Also:
    
    ChannelType
  - withType
```
public Channel withType(String type)
```
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
    
    Parameters:
    
    type - Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD . For details, see Channel Types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - withType
```
public Channel withType(ChannelType type)
```
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
    
    Parameters:
    
    type - Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD . For details, see Channel Types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - setRecordingConfigurationArn
```
public void setRecordingConfigurationArn(String recordingConfigurationArn)
```
    Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
    
    Parameters:
    
    recordingConfigurationArn - Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
  - getRecordingConfigurationArn
```
public String getRecordingConfigurationArn()
```
    Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
    
    Returns:
    
    Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
  - withRecordingConfigurationArn
```
public Channel withRecordingConfigurationArn(String recordingConfigurationArn)
```
    Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
    
    Parameters:
    
    recordingConfigurationArn - Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIngestEndpoint
```
public void setIngestEndpoint(String ingestEndpoint)
```
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    
    Parameters:
    
    ingestEndpoint - Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
  - getIngestEndpoint
```
public String getIngestEndpoint()
```
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    
    Returns:
    
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
  - withIngestEndpoint
```
public Channel withIngestEndpoint(String ingestEndpoint)
```
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    
    Parameters:
    
    ingestEndpoint - Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlaybackUrl
```
public void setPlaybackUrl(String playbackUrl)
```
    Channel playback URL.
    
    Parameters:
    
    playbackUrl - Channel playback URL.
  - getPlaybackUrl
```
public String getPlaybackUrl()
```
    Channel playback URL.
    
    Returns:
    
    Channel playback URL.
  - withPlaybackUrl
```
public Channel withPlaybackUrl(String playbackUrl)
```
    Channel playback URL.
    
    Parameters:
    
    playbackUrl - Channel playback URL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 Channel 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.
  - getTags
```
public Map<String,String> getTags()
```
    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    
    Returns:
    
    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    
    Parameters:
    
    tags - Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value) . See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
  - withTags
```
public Channel withTags(Map<String,String> tags)
```
    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    
    Parameters:
    
    tags - Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value) . See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Channel addTagsEntry(String key,
                            String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Channel clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInsecureIngest
```
public void setInsecureIngest(Boolean insecureIngest)
```
    Whether the channel allows insecure RTMP ingest. Default: false.
    
    Parameters:
    
    insecureIngest - Whether the channel allows insecure RTMP ingest. Default: false.
  - getInsecureIngest
```
public Boolean getInsecureIngest()
```
    Whether the channel allows insecure RTMP ingest. Default: false.
    
    Returns:
    
    Whether the channel allows insecure RTMP ingest. Default: false.
  - withInsecureIngest
```
public Channel withInsecureIngest(Boolean insecureIngest)
```
    Whether the channel allows insecure RTMP ingest. Default: false.
    
    Parameters:
    
    insecureIngest - Whether the channel allows insecure RTMP ingest. Default: false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isInsecureIngest
```
public Boolean isInsecureIngest()
```
    Whether the channel allows insecure RTMP ingest. Default: false.
    
    Returns:
    
    Whether the channel allows insecure RTMP ingest. Default: false.
  - setPreset
```
public void setPreset(String preset)
```
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    
    Parameters:
    
    preset - Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    
    See Also:
    
    TranscodePreset
  - getPreset
```
public String getPreset()
```
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    
    Returns:
    
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    
    See Also:
    
    TranscodePreset
  - withPreset
```
public Channel withPreset(String preset)
```
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    
    Parameters:
    
    preset - Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TranscodePreset
  - withPreset
```
public Channel withPreset(TranscodePreset preset)
```
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    
    Parameters:
    
    preset - Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TranscodePreset
  - setSrt
```
public void setSrt(Srt srt)
```
    Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
    
    Parameters:
    
    srt - Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
  - getSrt
```
public Srt getSrt()
```
    Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
    
    Returns:
    
    Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
  - withSrt
```
public Channel withSrt(Srt srt)
```
    Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
    
    Parameters:
    
    srt - Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlaybackRestrictionPolicyArn
```
public void setPlaybackRestrictionPolicyArn(String playbackRestrictionPolicyArn)
```
    Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
    
    Parameters:
    
    playbackRestrictionPolicyArn - Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
  - getPlaybackRestrictionPolicyArn
```
public String getPlaybackRestrictionPolicyArn()
```
    Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
    
    Returns:
    
    Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
  - withPlaybackRestrictionPolicyArn
```
public Channel withPlaybackRestrictionPolicyArn(String playbackRestrictionPolicyArn)
```
    Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
    
    Parameters:
    
    playbackRestrictionPolicyArn - Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
    
    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 Channel 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 Channel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Channel

Method Detail

setArn

getArn

withArn

setName

getName

withName

setLatencyMode

getLatencyMode

withLatencyMode

withLatencyMode

setType

getType

withType

withType

setRecordingConfigurationArn

getRecordingConfigurationArn

withRecordingConfigurationArn

setIngestEndpoint

getIngestEndpoint

withIngestEndpoint

setPlaybackUrl

getPlaybackUrl

withPlaybackUrl

setAuthorized

getAuthorized

withAuthorized

isAuthorized

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setInsecureIngest

getInsecureIngest

withInsecureIngest

isInsecureIngest

setPreset

getPreset

withPreset

withPreset

setSrt

getSrt

withSrt

setPlaybackRestrictionPolicyArn

getPlaybackRestrictionPolicyArn

withPlaybackRestrictionPolicyArn

toString

equals

hashCode

clone

marshall