AWS SDK for C++  1.9.131
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaTailor::Model::Channel Class Reference

#include <Channel.h>

Public Member Functions

 Channel ()
 
 Channel (Aws::Utils::Json::JsonView jsonValue)
 
Channeloperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
ChannelWithArn (const Aws::String &value)
 
ChannelWithArn (Aws::String &&value)
 
ChannelWithArn (const char *value)
 
const Aws::StringGetChannelName () const
 
bool ChannelNameHasBeenSet () const
 
void SetChannelName (const Aws::String &value)
 
void SetChannelName (Aws::String &&value)
 
void SetChannelName (const char *value)
 
ChannelWithChannelName (const Aws::String &value)
 
ChannelWithChannelName (Aws::String &&value)
 
ChannelWithChannelName (const char *value)
 
const Aws::StringGetChannelState () const
 
bool ChannelStateHasBeenSet () const
 
void SetChannelState (const Aws::String &value)
 
void SetChannelState (Aws::String &&value)
 
void SetChannelState (const char *value)
 
ChannelWithChannelState (const Aws::String &value)
 
ChannelWithChannelState (Aws::String &&value)
 
ChannelWithChannelState (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
ChannelWithCreationTime (const Aws::Utils::DateTime &value)
 
ChannelWithCreationTime (Aws::Utils::DateTime &&value)
 
const SlateSourceGetFillerSlate () const
 
bool FillerSlateHasBeenSet () const
 
void SetFillerSlate (const SlateSource &value)
 
void SetFillerSlate (SlateSource &&value)
 
ChannelWithFillerSlate (const SlateSource &value)
 
ChannelWithFillerSlate (SlateSource &&value)
 
const Aws::Utils::DateTimeGetLastModifiedTime () const
 
bool LastModifiedTimeHasBeenSet () const
 
void SetLastModifiedTime (const Aws::Utils::DateTime &value)
 
void SetLastModifiedTime (Aws::Utils::DateTime &&value)
 
ChannelWithLastModifiedTime (const Aws::Utils::DateTime &value)
 
ChannelWithLastModifiedTime (Aws::Utils::DateTime &&value)
 
const Aws::Vector< ResponseOutputItem > & GetOutputs () const
 
bool OutputsHasBeenSet () const
 
void SetOutputs (const Aws::Vector< ResponseOutputItem > &value)
 
void SetOutputs (Aws::Vector< ResponseOutputItem > &&value)
 
ChannelWithOutputs (const Aws::Vector< ResponseOutputItem > &value)
 
ChannelWithOutputs (Aws::Vector< ResponseOutputItem > &&value)
 
ChannelAddOutputs (const ResponseOutputItem &value)
 
ChannelAddOutputs (ResponseOutputItem &&value)
 
const Aws::StringGetPlaybackMode () const
 
bool PlaybackModeHasBeenSet () const
 
void SetPlaybackMode (const Aws::String &value)
 
void SetPlaybackMode (Aws::String &&value)
 
void SetPlaybackMode (const char *value)
 
ChannelWithPlaybackMode (const Aws::String &value)
 
ChannelWithPlaybackMode (Aws::String &&value)
 
ChannelWithPlaybackMode (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
ChannelWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
ChannelWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
ChannelAddTags (const Aws::String &key, const Aws::String &value)
 
ChannelAddTags (Aws::String &&key, const Aws::String &value)
 
ChannelAddTags (const Aws::String &key, Aws::String &&value)
 
ChannelAddTags (Aws::String &&key, Aws::String &&value)
 
ChannelAddTags (const char *key, Aws::String &&value)
 
ChannelAddTags (Aws::String &&key, const char *value)
 
ChannelAddTags (const char *key, const char *value)
 

Detailed Description

The configuration parameters for a channel.

See Also:

AWS API Reference

Definition at line 36 of file Channel.h.

Constructor & Destructor Documentation

◆ Channel() [1/2]

Aws::MediaTailor::Model::Channel::Channel ( )

◆ Channel() [2/2]

Aws::MediaTailor::Model::Channel::Channel ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddOutputs() [1/2]

Channel& Aws::MediaTailor::Model::Channel::AddOutputs ( const ResponseOutputItem value)
inline

The channel's output properties.

Definition at line 306 of file Channel.h.

◆ AddOutputs() [2/2]

Channel& Aws::MediaTailor::Model::Channel::AddOutputs ( ResponseOutputItem &&  value)
inline

The channel's output properties.

Definition at line 311 of file Channel.h.

◆ AddTags() [1/7]

Channel& Aws::MediaTailor::Model::Channel::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The tags to assign to the channel.

Definition at line 427 of file Channel.h.

◆ AddTags() [2/7]

Channel& Aws::MediaTailor::Model::Channel::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The tags to assign to the channel.

Definition at line 417 of file Channel.h.

◆ AddTags() [3/7]

Channel& Aws::MediaTailor::Model::Channel::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

The tags to assign to the channel.

Definition at line 437 of file Channel.h.

◆ AddTags() [4/7]

Channel& Aws::MediaTailor::Model::Channel::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The tags to assign to the channel.

Definition at line 422 of file Channel.h.

◆ AddTags() [5/7]

Channel& Aws::MediaTailor::Model::Channel::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

The tags to assign to the channel.

Definition at line 412 of file Channel.h.

◆ AddTags() [6/7]

Channel& Aws::MediaTailor::Model::Channel::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

The tags to assign to the channel.

Definition at line 432 of file Channel.h.

◆ AddTags() [7/7]

Channel& Aws::MediaTailor::Model::Channel::AddTags ( const char *  key,
const char *  value 
)
inline

The tags to assign to the channel.

Definition at line 442 of file Channel.h.

◆ ArnHasBeenSet()

bool Aws::MediaTailor::Model::Channel::ArnHasBeenSet ( ) const
inline

The ARN of the channel.

Definition at line 53 of file Channel.h.

◆ ChannelNameHasBeenSet()

bool Aws::MediaTailor::Model::Channel::ChannelNameHasBeenSet ( ) const
inline

The name of the channel.

Definition at line 94 of file Channel.h.

◆ ChannelStateHasBeenSet()

bool Aws::MediaTailor::Model::Channel::ChannelStateHasBeenSet ( ) const
inline

Returns the state whether the channel is running or not.

Definition at line 135 of file Channel.h.

◆ CreationTimeHasBeenSet()

bool Aws::MediaTailor::Model::Channel::CreationTimeHasBeenSet ( ) const
inline

The timestamp of when the channel was created.

Definition at line 176 of file Channel.h.

◆ FillerSlateHasBeenSet()

bool Aws::MediaTailor::Model::Channel::FillerSlateHasBeenSet ( ) const
inline

Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.

Definition at line 211 of file Channel.h.

◆ GetArn()

const Aws::String& Aws::MediaTailor::Model::Channel::GetArn ( ) const
inline

The ARN of the channel.

Definition at line 48 of file Channel.h.

◆ GetChannelName()

const Aws::String& Aws::MediaTailor::Model::Channel::GetChannelName ( ) const
inline

The name of the channel.

Definition at line 89 of file Channel.h.

◆ GetChannelState()

const Aws::String& Aws::MediaTailor::Model::Channel::GetChannelState ( ) const
inline

Returns the state whether the channel is running or not.

Definition at line 130 of file Channel.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::MediaTailor::Model::Channel::GetCreationTime ( ) const
inline

The timestamp of when the channel was created.

Definition at line 171 of file Channel.h.

◆ GetFillerSlate()

const SlateSource& Aws::MediaTailor::Model::Channel::GetFillerSlate ( ) const
inline

Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.

Definition at line 204 of file Channel.h.

◆ GetLastModifiedTime()

const Aws::Utils::DateTime& Aws::MediaTailor::Model::Channel::GetLastModifiedTime ( ) const
inline

The timestamp of when the channel was last modified.

Definition at line 245 of file Channel.h.

◆ GetOutputs()

const Aws::Vector<ResponseOutputItem>& Aws::MediaTailor::Model::Channel::GetOutputs ( ) const
inline

The channel's output properties.

Definition at line 276 of file Channel.h.

◆ GetPlaybackMode()

const Aws::String& Aws::MediaTailor::Model::Channel::GetPlaybackMode ( ) const
inline

The type of playback mode for this channel.

LINEAR - Programs play back-to-back only once.

LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

Definition at line 320 of file Channel.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::MediaTailor::Model::Channel::GetTags ( ) const
inline

The tags to assign to the channel.

Definition at line 382 of file Channel.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MediaTailor::Model::Channel::Jsonize ( ) const

◆ LastModifiedTimeHasBeenSet()

bool Aws::MediaTailor::Model::Channel::LastModifiedTimeHasBeenSet ( ) const
inline

The timestamp of when the channel was last modified.

Definition at line 250 of file Channel.h.

◆ operator=()

Channel& Aws::MediaTailor::Model::Channel::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OutputsHasBeenSet()

bool Aws::MediaTailor::Model::Channel::OutputsHasBeenSet ( ) const
inline

The channel's output properties.

Definition at line 281 of file Channel.h.

◆ PlaybackModeHasBeenSet()

bool Aws::MediaTailor::Model::Channel::PlaybackModeHasBeenSet ( ) const
inline

The type of playback mode for this channel.

LINEAR - Programs play back-to-back only once.

LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

Definition at line 328 of file Channel.h.

◆ SetArn() [1/3]

void Aws::MediaTailor::Model::Channel::SetArn ( Aws::String &&  value)
inline

The ARN of the channel.

Definition at line 63 of file Channel.h.

◆ SetArn() [2/3]

void Aws::MediaTailor::Model::Channel::SetArn ( const Aws::String value)
inline

The ARN of the channel.

Definition at line 58 of file Channel.h.

◆ SetArn() [3/3]

void Aws::MediaTailor::Model::Channel::SetArn ( const char *  value)
inline

The ARN of the channel.

Definition at line 68 of file Channel.h.

◆ SetChannelName() [1/3]

void Aws::MediaTailor::Model::Channel::SetChannelName ( Aws::String &&  value)
inline

The name of the channel.

Definition at line 104 of file Channel.h.

◆ SetChannelName() [2/3]

void Aws::MediaTailor::Model::Channel::SetChannelName ( const Aws::String value)
inline

The name of the channel.

Definition at line 99 of file Channel.h.

◆ SetChannelName() [3/3]

void Aws::MediaTailor::Model::Channel::SetChannelName ( const char *  value)
inline

The name of the channel.

Definition at line 109 of file Channel.h.

◆ SetChannelState() [1/3]

void Aws::MediaTailor::Model::Channel::SetChannelState ( Aws::String &&  value)
inline

Returns the state whether the channel is running or not.

Definition at line 145 of file Channel.h.

◆ SetChannelState() [2/3]

void Aws::MediaTailor::Model::Channel::SetChannelState ( const Aws::String value)
inline

Returns the state whether the channel is running or not.

Definition at line 140 of file Channel.h.

◆ SetChannelState() [3/3]

void Aws::MediaTailor::Model::Channel::SetChannelState ( const char *  value)
inline

Returns the state whether the channel is running or not.

Definition at line 150 of file Channel.h.

◆ SetCreationTime() [1/2]

void Aws::MediaTailor::Model::Channel::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

The timestamp of when the channel was created.

Definition at line 186 of file Channel.h.

◆ SetCreationTime() [2/2]

void Aws::MediaTailor::Model::Channel::SetCreationTime ( const Aws::Utils::DateTime value)
inline

The timestamp of when the channel was created.

Definition at line 181 of file Channel.h.

◆ SetFillerSlate() [1/2]

void Aws::MediaTailor::Model::Channel::SetFillerSlate ( const SlateSource value)
inline

Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.

Definition at line 218 of file Channel.h.

◆ SetFillerSlate() [2/2]

void Aws::MediaTailor::Model::Channel::SetFillerSlate ( SlateSource &&  value)
inline

Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.

Definition at line 225 of file Channel.h.

◆ SetLastModifiedTime() [1/2]

void Aws::MediaTailor::Model::Channel::SetLastModifiedTime ( Aws::Utils::DateTime &&  value)
inline

The timestamp of when the channel was last modified.

Definition at line 260 of file Channel.h.

◆ SetLastModifiedTime() [2/2]

void Aws::MediaTailor::Model::Channel::SetLastModifiedTime ( const Aws::Utils::DateTime value)
inline

The timestamp of when the channel was last modified.

Definition at line 255 of file Channel.h.

◆ SetOutputs() [1/2]

void Aws::MediaTailor::Model::Channel::SetOutputs ( Aws::Vector< ResponseOutputItem > &&  value)
inline

The channel's output properties.

Definition at line 291 of file Channel.h.

◆ SetOutputs() [2/2]

void Aws::MediaTailor::Model::Channel::SetOutputs ( const Aws::Vector< ResponseOutputItem > &  value)
inline

The channel's output properties.

Definition at line 286 of file Channel.h.

◆ SetPlaybackMode() [1/3]

void Aws::MediaTailor::Model::Channel::SetPlaybackMode ( Aws::String &&  value)
inline

The type of playback mode for this channel.

LINEAR - Programs play back-to-back only once.

LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

Definition at line 344 of file Channel.h.

◆ SetPlaybackMode() [2/3]

void Aws::MediaTailor::Model::Channel::SetPlaybackMode ( const Aws::String value)
inline

The type of playback mode for this channel.

LINEAR - Programs play back-to-back only once.

LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

Definition at line 336 of file Channel.h.

◆ SetPlaybackMode() [3/3]

void Aws::MediaTailor::Model::Channel::SetPlaybackMode ( const char *  value)
inline

The type of playback mode for this channel.

LINEAR - Programs play back-to-back only once.

LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

Definition at line 352 of file Channel.h.

◆ SetTags() [1/2]

void Aws::MediaTailor::Model::Channel::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The tags to assign to the channel.

Definition at line 397 of file Channel.h.

◆ SetTags() [2/2]

void Aws::MediaTailor::Model::Channel::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The tags to assign to the channel.

Definition at line 392 of file Channel.h.

◆ TagsHasBeenSet()

bool Aws::MediaTailor::Model::Channel::TagsHasBeenSet ( ) const
inline

The tags to assign to the channel.

Definition at line 387 of file Channel.h.

◆ WithArn() [1/3]

Channel& Aws::MediaTailor::Model::Channel::WithArn ( Aws::String &&  value)
inline

The ARN of the channel.

Definition at line 78 of file Channel.h.

◆ WithArn() [2/3]

Channel& Aws::MediaTailor::Model::Channel::WithArn ( const Aws::String value)
inline

The ARN of the channel.

Definition at line 73 of file Channel.h.

◆ WithArn() [3/3]

Channel& Aws::MediaTailor::Model::Channel::WithArn ( const char *  value)
inline

The ARN of the channel.

Definition at line 83 of file Channel.h.

◆ WithChannelName() [1/3]

Channel& Aws::MediaTailor::Model::Channel::WithChannelName ( Aws::String &&  value)
inline

The name of the channel.

Definition at line 119 of file Channel.h.

◆ WithChannelName() [2/3]

Channel& Aws::MediaTailor::Model::Channel::WithChannelName ( const Aws::String value)
inline

The name of the channel.

Definition at line 114 of file Channel.h.

◆ WithChannelName() [3/3]

Channel& Aws::MediaTailor::Model::Channel::WithChannelName ( const char *  value)
inline

The name of the channel.

Definition at line 124 of file Channel.h.

◆ WithChannelState() [1/3]

Channel& Aws::MediaTailor::Model::Channel::WithChannelState ( Aws::String &&  value)
inline

Returns the state whether the channel is running or not.

Definition at line 160 of file Channel.h.

◆ WithChannelState() [2/3]

Channel& Aws::MediaTailor::Model::Channel::WithChannelState ( const Aws::String value)
inline

Returns the state whether the channel is running or not.

Definition at line 155 of file Channel.h.

◆ WithChannelState() [3/3]

Channel& Aws::MediaTailor::Model::Channel::WithChannelState ( const char *  value)
inline

Returns the state whether the channel is running or not.

Definition at line 165 of file Channel.h.

◆ WithCreationTime() [1/2]

Channel& Aws::MediaTailor::Model::Channel::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

The timestamp of when the channel was created.

Definition at line 196 of file Channel.h.

◆ WithCreationTime() [2/2]

Channel& Aws::MediaTailor::Model::Channel::WithCreationTime ( const Aws::Utils::DateTime value)
inline

The timestamp of when the channel was created.

Definition at line 191 of file Channel.h.

◆ WithFillerSlate() [1/2]

Channel& Aws::MediaTailor::Model::Channel::WithFillerSlate ( const SlateSource value)
inline

Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.

Definition at line 232 of file Channel.h.

◆ WithFillerSlate() [2/2]

Channel& Aws::MediaTailor::Model::Channel::WithFillerSlate ( SlateSource &&  value)
inline

Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.

Definition at line 239 of file Channel.h.

◆ WithLastModifiedTime() [1/2]

Channel& Aws::MediaTailor::Model::Channel::WithLastModifiedTime ( Aws::Utils::DateTime &&  value)
inline

The timestamp of when the channel was last modified.

Definition at line 270 of file Channel.h.

◆ WithLastModifiedTime() [2/2]

Channel& Aws::MediaTailor::Model::Channel::WithLastModifiedTime ( const Aws::Utils::DateTime value)
inline

The timestamp of when the channel was last modified.

Definition at line 265 of file Channel.h.

◆ WithOutputs() [1/2]

Channel& Aws::MediaTailor::Model::Channel::WithOutputs ( Aws::Vector< ResponseOutputItem > &&  value)
inline

The channel's output properties.

Definition at line 301 of file Channel.h.

◆ WithOutputs() [2/2]

Channel& Aws::MediaTailor::Model::Channel::WithOutputs ( const Aws::Vector< ResponseOutputItem > &  value)
inline

The channel's output properties.

Definition at line 296 of file Channel.h.

◆ WithPlaybackMode() [1/3]

Channel& Aws::MediaTailor::Model::Channel::WithPlaybackMode ( Aws::String &&  value)
inline

The type of playback mode for this channel.

LINEAR - Programs play back-to-back only once.

LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

Definition at line 368 of file Channel.h.

◆ WithPlaybackMode() [2/3]

Channel& Aws::MediaTailor::Model::Channel::WithPlaybackMode ( const Aws::String value)
inline

The type of playback mode for this channel.

LINEAR - Programs play back-to-back only once.

LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

Definition at line 360 of file Channel.h.

◆ WithPlaybackMode() [3/3]

Channel& Aws::MediaTailor::Model::Channel::WithPlaybackMode ( const char *  value)
inline

The type of playback mode for this channel.

LINEAR - Programs play back-to-back only once.

LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

Definition at line 376 of file Channel.h.

◆ WithTags() [1/2]

Channel& Aws::MediaTailor::Model::Channel::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The tags to assign to the channel.

Definition at line 407 of file Channel.h.

◆ WithTags() [2/2]

Channel& Aws::MediaTailor::Model::Channel::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The tags to assign to the channel.

Definition at line 402 of file Channel.h.


The documentation for this class was generated from the following file: