AWS SDK for C++  1.9.71
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaConvert::Model::Queue Class Reference

#include <Queue.h>

Public Member Functions

 Queue ()
 
 Queue (Aws::Utils::Json::JsonView jsonValue)
 
Queueoperator= (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)
 
QueueWithArn (const Aws::String &value)
 
QueueWithArn (Aws::String &&value)
 
QueueWithArn (const char *value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
QueueWithCreatedAt (const Aws::Utils::DateTime &value)
 
QueueWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
QueueWithDescription (const Aws::String &value)
 
QueueWithDescription (Aws::String &&value)
 
QueueWithDescription (const char *value)
 
const Aws::Utils::DateTimeGetLastUpdated () const
 
bool LastUpdatedHasBeenSet () const
 
void SetLastUpdated (const Aws::Utils::DateTime &value)
 
void SetLastUpdated (Aws::Utils::DateTime &&value)
 
QueueWithLastUpdated (const Aws::Utils::DateTime &value)
 
QueueWithLastUpdated (Aws::Utils::DateTime &&value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
QueueWithName (const Aws::String &value)
 
QueueWithName (Aws::String &&value)
 
QueueWithName (const char *value)
 
const PricingPlanGetPricingPlan () const
 
bool PricingPlanHasBeenSet () const
 
void SetPricingPlan (const PricingPlan &value)
 
void SetPricingPlan (PricingPlan &&value)
 
QueueWithPricingPlan (const PricingPlan &value)
 
QueueWithPricingPlan (PricingPlan &&value)
 
int GetProgressingJobsCount () const
 
bool ProgressingJobsCountHasBeenSet () const
 
void SetProgressingJobsCount (int value)
 
QueueWithProgressingJobsCount (int value)
 
const ReservationPlanGetReservationPlan () const
 
bool ReservationPlanHasBeenSet () const
 
void SetReservationPlan (const ReservationPlan &value)
 
void SetReservationPlan (ReservationPlan &&value)
 
QueueWithReservationPlan (const ReservationPlan &value)
 
QueueWithReservationPlan (ReservationPlan &&value)
 
const QueueStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const QueueStatus &value)
 
void SetStatus (QueueStatus &&value)
 
QueueWithStatus (const QueueStatus &value)
 
QueueWithStatus (QueueStatus &&value)
 
int GetSubmittedJobsCount () const
 
bool SubmittedJobsCountHasBeenSet () const
 
void SetSubmittedJobsCount (int value)
 
QueueWithSubmittedJobsCount (int value)
 
const TypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const Type &value)
 
void SetType (Type &&value)
 
QueueWithType (const Type &value)
 
QueueWithType (Type &&value)
 

Detailed Description

You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.

See Also:

AWS API Reference

Definition at line 41 of file Queue.h.

Constructor & Destructor Documentation

◆ Queue() [1/2]

Aws::MediaConvert::Model::Queue::Queue ( )

◆ Queue() [2/2]

Aws::MediaConvert::Model::Queue::Queue ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ArnHasBeenSet()

bool Aws::MediaConvert::Model::Queue::ArnHasBeenSet ( ) const
inline

An identifier for this resource that is unique within all of AWS.

Definition at line 58 of file Queue.h.

◆ CreatedAtHasBeenSet()

bool Aws::MediaConvert::Model::Queue::CreatedAtHasBeenSet ( ) const
inline

The timestamp in epoch seconds for when you created the queue.

Definition at line 99 of file Queue.h.

◆ DescriptionHasBeenSet()

bool Aws::MediaConvert::Model::Queue::DescriptionHasBeenSet ( ) const
inline

An optional description that you create for each queue.

Definition at line 130 of file Queue.h.

◆ GetArn()

const Aws::String& Aws::MediaConvert::Model::Queue::GetArn ( ) const
inline

An identifier for this resource that is unique within all of AWS.

Definition at line 53 of file Queue.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::MediaConvert::Model::Queue::GetCreatedAt ( ) const
inline

The timestamp in epoch seconds for when you created the queue.

Definition at line 94 of file Queue.h.

◆ GetDescription()

const Aws::String& Aws::MediaConvert::Model::Queue::GetDescription ( ) const
inline

An optional description that you create for each queue.

Definition at line 125 of file Queue.h.

◆ GetLastUpdated()

const Aws::Utils::DateTime& Aws::MediaConvert::Model::Queue::GetLastUpdated ( ) const
inline

The timestamp in epoch seconds for when you most recently updated the queue.

Definition at line 166 of file Queue.h.

◆ GetName()

const Aws::String& Aws::MediaConvert::Model::Queue::GetName ( ) const
inline

A name that you create for each queue. Each name must be unique within your account.

Definition at line 198 of file Queue.h.

◆ GetPricingPlan()

const PricingPlan& Aws::MediaConvert::Model::Queue::GetPricingPlan ( ) const
inline

Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.

Definition at line 249 of file Queue.h.

◆ GetProgressingJobsCount()

int Aws::MediaConvert::Model::Queue::GetProgressingJobsCount ( ) const
inline

The estimated number of jobs with a PROGRESSING status.

Definition at line 295 of file Queue.h.

◆ GetReservationPlan()

const ReservationPlan& Aws::MediaConvert::Model::Queue::GetReservationPlan ( ) const
inline

Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.

Definition at line 317 of file Queue.h.

◆ GetStatus()

const QueueStatus& Aws::MediaConvert::Model::Queue::GetStatus ( ) const
inline

Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

Definition at line 355 of file Queue.h.

◆ GetSubmittedJobsCount()

int Aws::MediaConvert::Model::Queue::GetSubmittedJobsCount ( ) const
inline

The estimated number of jobs with a SUBMITTED status.

Definition at line 396 of file Queue.h.

◆ GetType()

const Type& Aws::MediaConvert::Model::Queue::GetType ( ) const
inline

Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.

Definition at line 419 of file Queue.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MediaConvert::Model::Queue::Jsonize ( ) const

◆ LastUpdatedHasBeenSet()

bool Aws::MediaConvert::Model::Queue::LastUpdatedHasBeenSet ( ) const
inline

The timestamp in epoch seconds for when you most recently updated the queue.

Definition at line 171 of file Queue.h.

◆ NameHasBeenSet()

bool Aws::MediaConvert::Model::Queue::NameHasBeenSet ( ) const
inline

A name that you create for each queue. Each name must be unique within your account.

Definition at line 204 of file Queue.h.

◆ operator=()

Queue& Aws::MediaConvert::Model::Queue::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PricingPlanHasBeenSet()

bool Aws::MediaConvert::Model::Queue::PricingPlanHasBeenSet ( ) const
inline

Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.

Definition at line 257 of file Queue.h.

◆ ProgressingJobsCountHasBeenSet()

bool Aws::MediaConvert::Model::Queue::ProgressingJobsCountHasBeenSet ( ) const
inline

The estimated number of jobs with a PROGRESSING status.

Definition at line 300 of file Queue.h.

◆ ReservationPlanHasBeenSet()

bool Aws::MediaConvert::Model::Queue::ReservationPlanHasBeenSet ( ) const
inline

Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.

Definition at line 323 of file Queue.h.

◆ SetArn() [1/3]

void Aws::MediaConvert::Model::Queue::SetArn ( Aws::String &&  value)
inline

An identifier for this resource that is unique within all of AWS.

Definition at line 68 of file Queue.h.

◆ SetArn() [2/3]

void Aws::MediaConvert::Model::Queue::SetArn ( const Aws::String value)
inline

An identifier for this resource that is unique within all of AWS.

Definition at line 63 of file Queue.h.

◆ SetArn() [3/3]

void Aws::MediaConvert::Model::Queue::SetArn ( const char *  value)
inline

An identifier for this resource that is unique within all of AWS.

Definition at line 73 of file Queue.h.

◆ SetCreatedAt() [1/2]

void Aws::MediaConvert::Model::Queue::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The timestamp in epoch seconds for when you created the queue.

Definition at line 109 of file Queue.h.

◆ SetCreatedAt() [2/2]

void Aws::MediaConvert::Model::Queue::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The timestamp in epoch seconds for when you created the queue.

Definition at line 104 of file Queue.h.

◆ SetDescription() [1/3]

void Aws::MediaConvert::Model::Queue::SetDescription ( Aws::String &&  value)
inline

An optional description that you create for each queue.

Definition at line 140 of file Queue.h.

◆ SetDescription() [2/3]

void Aws::MediaConvert::Model::Queue::SetDescription ( const Aws::String value)
inline

An optional description that you create for each queue.

Definition at line 135 of file Queue.h.

◆ SetDescription() [3/3]

void Aws::MediaConvert::Model::Queue::SetDescription ( const char *  value)
inline

An optional description that you create for each queue.

Definition at line 145 of file Queue.h.

◆ SetLastUpdated() [1/2]

void Aws::MediaConvert::Model::Queue::SetLastUpdated ( Aws::Utils::DateTime &&  value)
inline

The timestamp in epoch seconds for when you most recently updated the queue.

Definition at line 181 of file Queue.h.

◆ SetLastUpdated() [2/2]

void Aws::MediaConvert::Model::Queue::SetLastUpdated ( const Aws::Utils::DateTime value)
inline

The timestamp in epoch seconds for when you most recently updated the queue.

Definition at line 176 of file Queue.h.

◆ SetName() [1/3]

void Aws::MediaConvert::Model::Queue::SetName ( Aws::String &&  value)
inline

A name that you create for each queue. Each name must be unique within your account.

Definition at line 216 of file Queue.h.

◆ SetName() [2/3]

void Aws::MediaConvert::Model::Queue::SetName ( const Aws::String value)
inline

A name that you create for each queue. Each name must be unique within your account.

Definition at line 210 of file Queue.h.

◆ SetName() [3/3]

void Aws::MediaConvert::Model::Queue::SetName ( const char *  value)
inline

A name that you create for each queue. Each name must be unique within your account.

Definition at line 222 of file Queue.h.

◆ SetPricingPlan() [1/2]

void Aws::MediaConvert::Model::Queue::SetPricingPlan ( const PricingPlan value)
inline

Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.

Definition at line 265 of file Queue.h.

◆ SetPricingPlan() [2/2]

void Aws::MediaConvert::Model::Queue::SetPricingPlan ( PricingPlan &&  value)
inline

Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.

Definition at line 273 of file Queue.h.

◆ SetProgressingJobsCount()

void Aws::MediaConvert::Model::Queue::SetProgressingJobsCount ( int  value)
inline

The estimated number of jobs with a PROGRESSING status.

Definition at line 305 of file Queue.h.

◆ SetReservationPlan() [1/2]

void Aws::MediaConvert::Model::Queue::SetReservationPlan ( const ReservationPlan value)
inline

Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.

Definition at line 329 of file Queue.h.

◆ SetReservationPlan() [2/2]

void Aws::MediaConvert::Model::Queue::SetReservationPlan ( ReservationPlan &&  value)
inline

Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.

Definition at line 335 of file Queue.h.

◆ SetStatus() [1/2]

void Aws::MediaConvert::Model::Queue::SetStatus ( const QueueStatus value)
inline

Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

Definition at line 369 of file Queue.h.

◆ SetStatus() [2/2]

void Aws::MediaConvert::Model::Queue::SetStatus ( QueueStatus &&  value)
inline

Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

Definition at line 376 of file Queue.h.

◆ SetSubmittedJobsCount()

void Aws::MediaConvert::Model::Queue::SetSubmittedJobsCount ( int  value)
inline

The estimated number of jobs with a SUBMITTED status.

Definition at line 406 of file Queue.h.

◆ SetType() [1/2]

void Aws::MediaConvert::Model::Queue::SetType ( const Type value)
inline

Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.

Definition at line 433 of file Queue.h.

◆ SetType() [2/2]

void Aws::MediaConvert::Model::Queue::SetType ( Type &&  value)
inline

Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.

Definition at line 440 of file Queue.h.

◆ StatusHasBeenSet()

bool Aws::MediaConvert::Model::Queue::StatusHasBeenSet ( ) const
inline

Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

Definition at line 362 of file Queue.h.

◆ SubmittedJobsCountHasBeenSet()

bool Aws::MediaConvert::Model::Queue::SubmittedJobsCountHasBeenSet ( ) const
inline

The estimated number of jobs with a SUBMITTED status.

Definition at line 401 of file Queue.h.

◆ TypeHasBeenSet()

bool Aws::MediaConvert::Model::Queue::TypeHasBeenSet ( ) const
inline

Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.

Definition at line 426 of file Queue.h.

◆ WithArn() [1/3]

Queue& Aws::MediaConvert::Model::Queue::WithArn ( Aws::String &&  value)
inline

An identifier for this resource that is unique within all of AWS.

Definition at line 83 of file Queue.h.

◆ WithArn() [2/3]

Queue& Aws::MediaConvert::Model::Queue::WithArn ( const Aws::String value)
inline

An identifier for this resource that is unique within all of AWS.

Definition at line 78 of file Queue.h.

◆ WithArn() [3/3]

Queue& Aws::MediaConvert::Model::Queue::WithArn ( const char *  value)
inline

An identifier for this resource that is unique within all of AWS.

Definition at line 88 of file Queue.h.

◆ WithCreatedAt() [1/2]

Queue& Aws::MediaConvert::Model::Queue::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The timestamp in epoch seconds for when you created the queue.

Definition at line 119 of file Queue.h.

◆ WithCreatedAt() [2/2]

Queue& Aws::MediaConvert::Model::Queue::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The timestamp in epoch seconds for when you created the queue.

Definition at line 114 of file Queue.h.

◆ WithDescription() [1/3]

Queue& Aws::MediaConvert::Model::Queue::WithDescription ( Aws::String &&  value)
inline

An optional description that you create for each queue.

Definition at line 155 of file Queue.h.

◆ WithDescription() [2/3]

Queue& Aws::MediaConvert::Model::Queue::WithDescription ( const Aws::String value)
inline

An optional description that you create for each queue.

Definition at line 150 of file Queue.h.

◆ WithDescription() [3/3]

Queue& Aws::MediaConvert::Model::Queue::WithDescription ( const char *  value)
inline

An optional description that you create for each queue.

Definition at line 160 of file Queue.h.

◆ WithLastUpdated() [1/2]

Queue& Aws::MediaConvert::Model::Queue::WithLastUpdated ( Aws::Utils::DateTime &&  value)
inline

The timestamp in epoch seconds for when you most recently updated the queue.

Definition at line 191 of file Queue.h.

◆ WithLastUpdated() [2/2]

Queue& Aws::MediaConvert::Model::Queue::WithLastUpdated ( const Aws::Utils::DateTime value)
inline

The timestamp in epoch seconds for when you most recently updated the queue.

Definition at line 186 of file Queue.h.

◆ WithName() [1/3]

Queue& Aws::MediaConvert::Model::Queue::WithName ( Aws::String &&  value)
inline

A name that you create for each queue. Each name must be unique within your account.

Definition at line 234 of file Queue.h.

◆ WithName() [2/3]

Queue& Aws::MediaConvert::Model::Queue::WithName ( const Aws::String value)
inline

A name that you create for each queue. Each name must be unique within your account.

Definition at line 228 of file Queue.h.

◆ WithName() [3/3]

Queue& Aws::MediaConvert::Model::Queue::WithName ( const char *  value)
inline

A name that you create for each queue. Each name must be unique within your account.

Definition at line 240 of file Queue.h.

◆ WithPricingPlan() [1/2]

Queue& Aws::MediaConvert::Model::Queue::WithPricingPlan ( const PricingPlan value)
inline

Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.

Definition at line 281 of file Queue.h.

◆ WithPricingPlan() [2/2]

Queue& Aws::MediaConvert::Model::Queue::WithPricingPlan ( PricingPlan &&  value)
inline

Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.

Definition at line 289 of file Queue.h.

◆ WithProgressingJobsCount()

Queue& Aws::MediaConvert::Model::Queue::WithProgressingJobsCount ( int  value)
inline

The estimated number of jobs with a PROGRESSING status.

Definition at line 310 of file Queue.h.

◆ WithReservationPlan() [1/2]

Queue& Aws::MediaConvert::Model::Queue::WithReservationPlan ( const ReservationPlan value)
inline

Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.

Definition at line 341 of file Queue.h.

◆ WithReservationPlan() [2/2]

Queue& Aws::MediaConvert::Model::Queue::WithReservationPlan ( ReservationPlan &&  value)
inline

Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.

Definition at line 347 of file Queue.h.

◆ WithStatus() [1/2]

Queue& Aws::MediaConvert::Model::Queue::WithStatus ( const QueueStatus value)
inline

Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

Definition at line 383 of file Queue.h.

◆ WithStatus() [2/2]

Queue& Aws::MediaConvert::Model::Queue::WithStatus ( QueueStatus &&  value)
inline

Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

Definition at line 390 of file Queue.h.

◆ WithSubmittedJobsCount()

Queue& Aws::MediaConvert::Model::Queue::WithSubmittedJobsCount ( int  value)
inline

The estimated number of jobs with a SUBMITTED status.

Definition at line 411 of file Queue.h.

◆ WithType() [1/2]

Queue& Aws::MediaConvert::Model::Queue::WithType ( const Type value)
inline

Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.

Definition at line 447 of file Queue.h.

◆ WithType() [2/2]

Queue& Aws::MediaConvert::Model::Queue::WithType ( Type &&  value)
inline

Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.

Definition at line 454 of file Queue.h.


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