Queue (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mediaconvert.model.Queue

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Queue
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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 Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Queue()

Constructors
Constructor and Description
`Queue()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Queue`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` An identifier for this resource that is unique within all of AWS.
`Date`	`getCreatedAt()` The timestamp in epoch seconds for when you created the queue.
`String`	`getDescription()` An optional description that you create for each queue.
`Date`	`getLastUpdated()` The timestamp in epoch seconds for when you most recently updated the queue.
`String`	`getName()` A name that you create for each queue.
`String`	`getPricingPlan()` Specifies whether the pricing plan for the queue is on-demand or reserved.
`Integer`	`getProgressingJobsCount()` The estimated number of jobs with a PROGRESSING status.
`ReservationPlan`	`getReservationPlan()` Details about the pricing plan for your reserved queue.
`String`	`getStatus()` Queues can be ACTIVE or PAUSED.
`Integer`	`getSubmittedJobsCount()` The estimated number of jobs with a SUBMITTED status.
`String`	`getType()` Specifies whether this on-demand queue is system or custom.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` An identifier for this resource that is unique within all of AWS.
`void`	`setCreatedAt(Date createdAt)` The timestamp in epoch seconds for when you created the queue.
`void`	`setDescription(String description)` An optional description that you create for each queue.
`void`	`setLastUpdated(Date lastUpdated)` The timestamp in epoch seconds for when you most recently updated the queue.
`void`	`setName(String name)` A name that you create for each queue.
`void`	`setPricingPlan(String pricingPlan)` Specifies whether the pricing plan for the queue is on-demand or reserved.
`void`	`setProgressingJobsCount(Integer progressingJobsCount)` The estimated number of jobs with a PROGRESSING status.
`void`	`setReservationPlan(ReservationPlan reservationPlan)` Details about the pricing plan for your reserved queue.
`void`	`setStatus(String status)` Queues can be ACTIVE or PAUSED.
`void`	`setSubmittedJobsCount(Integer submittedJobsCount)` The estimated number of jobs with a SUBMITTED status.
`void`	`setType(String type)` Specifies whether this on-demand queue is system or custom.
`String`	`toString()` Returns a string representation of this object.
`Queue`	`withArn(String arn)` An identifier for this resource that is unique within all of AWS.
`Queue`	`withCreatedAt(Date createdAt)` The timestamp in epoch seconds for when you created the queue.
`Queue`	`withDescription(String description)` An optional description that you create for each queue.
`Queue`	`withLastUpdated(Date lastUpdated)` The timestamp in epoch seconds for when you most recently updated the queue.
`Queue`	`withName(String name)` A name that you create for each queue.
`Queue`	`withPricingPlan(PricingPlan pricingPlan)` Specifies whether the pricing plan for the queue is on-demand or reserved.
`Queue`	`withPricingPlan(String pricingPlan)` Specifies whether the pricing plan for the queue is on-demand or reserved.
`Queue`	`withProgressingJobsCount(Integer progressingJobsCount)` The estimated number of jobs with a PROGRESSING status.
`Queue`	`withReservationPlan(ReservationPlan reservationPlan)` Details about the pricing plan for your reserved queue.
`Queue`	`withStatus(QueueStatus status)` Queues can be ACTIVE or PAUSED.
`Queue`	`withStatus(String status)` Queues can be ACTIVE or PAUSED.
`Queue`	`withSubmittedJobsCount(Integer submittedJobsCount)` The estimated number of jobs with a SUBMITTED status.
`Queue`	`withType(String type)` Specifies whether this on-demand queue is system or custom.
`Queue`	`withType(Type type)` Specifies whether this on-demand queue is system or custom.

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

- Constructor Detail
  - Queue
```
public Queue()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    An identifier for this resource that is unique within all of AWS.
    
    Parameters:
    
    arn - An identifier for this resource that is unique within all of AWS.
  - getArn
```
public String getArn()
```
    An identifier for this resource that is unique within all of AWS.
    
    Returns:
    
    An identifier for this resource that is unique within all of AWS.
  - withArn
```
public Queue withArn(String arn)
```
    An identifier for this resource that is unique within all of AWS.
    
    Parameters:
    
    arn - An identifier for this resource that is unique within all of AWS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The timestamp in epoch seconds for when you created the queue.
    
    Parameters:
    
    createdAt - The timestamp in epoch seconds for when you created the queue.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The timestamp in epoch seconds for when you created the queue.
    
    Returns:
    
    The timestamp in epoch seconds for when you created the queue.
  - withCreatedAt
```
public Queue withCreatedAt(Date createdAt)
```
    The timestamp in epoch seconds for when you created the queue.
    
    Parameters:
    
    createdAt - The timestamp in epoch seconds for when you created the queue.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    An optional description that you create for each queue.
    
    Parameters:
    
    description - An optional description that you create for each queue.
  - getDescription
```
public String getDescription()
```
    An optional description that you create for each queue.
    
    Returns:
    
    An optional description that you create for each queue.
  - withDescription
```
public Queue withDescription(String description)
```
    An optional description that you create for each queue.
    
    Parameters:
    
    description - An optional description that you create for each queue.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdated
```
public void setLastUpdated(Date lastUpdated)
```
    The timestamp in epoch seconds for when you most recently updated the queue.
    
    Parameters:
    
    lastUpdated - The timestamp in epoch seconds for when you most recently updated the queue.
  - getLastUpdated
```
public Date getLastUpdated()
```
    The timestamp in epoch seconds for when you most recently updated the queue.
    
    Returns:
    
    The timestamp in epoch seconds for when you most recently updated the queue.
  - withLastUpdated
```
public Queue withLastUpdated(Date lastUpdated)
```
    The timestamp in epoch seconds for when you most recently updated the queue.
    
    Parameters:
    
    lastUpdated - The timestamp in epoch seconds for when you most recently updated the queue.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    A name that you create for each queue. Each name must be unique within your account.
    
    Parameters:
    
    name - A name that you create for each queue. Each name must be unique within your account.
  - getName
```
public String getName()
```
    A name that you create for each queue. Each name must be unique within your account.
    
    Returns:
    
    A name that you create for each queue. Each name must be unique within your account.
  - withName
```
public Queue withName(String name)
```
    A name that you create for each queue. Each name must be unique within your account.
    
    Parameters:
    
    name - A name that you create for each queue. Each name must be unique within your account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPricingPlan
```
public void setPricingPlan(String pricingPlan)
```
    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.
    
    Parameters:
    
    pricingPlan - 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.
    
    See Also:
    
    PricingPlan
  - getPricingPlan
```
public String getPricingPlan()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    PricingPlan
  - withPricingPlan
```
public Queue withPricingPlan(String pricingPlan)
```
    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.
    
    Parameters:
    
    pricingPlan - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PricingPlan
  - withPricingPlan
```
public Queue withPricingPlan(PricingPlan pricingPlan)
```
    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.
    
    Parameters:
    
    pricingPlan - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PricingPlan
  - setProgressingJobsCount
```
public void setProgressingJobsCount(Integer progressingJobsCount)
```
    The estimated number of jobs with a PROGRESSING status.
    
    Parameters:
    
    progressingJobsCount - The estimated number of jobs with a PROGRESSING status.
  - getProgressingJobsCount
```
public Integer getProgressingJobsCount()
```
    The estimated number of jobs with a PROGRESSING status.
    
    Returns:
    
    The estimated number of jobs with a PROGRESSING status.
  - withProgressingJobsCount
```
public Queue withProgressingJobsCount(Integer progressingJobsCount)
```
    The estimated number of jobs with a PROGRESSING status.
    
    Parameters:
    
    progressingJobsCount - The estimated number of jobs with a PROGRESSING status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReservationPlan
```
public void setReservationPlan(ReservationPlan reservationPlan)
```
    Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
    
    Parameters:
    
    reservationPlan - Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
  - getReservationPlan
```
public ReservationPlan getReservationPlan()
```
    Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
    
    Returns:
    
    Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
  - withReservationPlan
```
public Queue withReservationPlan(ReservationPlan reservationPlan)
```
    Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
    
    Parameters:
    
    reservationPlan - Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    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.
    
    Parameters:
    
    status - 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.
    
    See Also:
    
    QueueStatus
  - getStatus
```
public String getStatus()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    QueueStatus
  - withStatus
```
public Queue withStatus(String status)
```
    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.
    
    Parameters:
    
    status - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QueueStatus
  - withStatus
```
public Queue withStatus(QueueStatus status)
```
    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.
    
    Parameters:
    
    status - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QueueStatus
  - setSubmittedJobsCount
```
public void setSubmittedJobsCount(Integer submittedJobsCount)
```
    The estimated number of jobs with a SUBMITTED status.
    
    Parameters:
    
    submittedJobsCount - The estimated number of jobs with a SUBMITTED status.
  - getSubmittedJobsCount
```
public Integer getSubmittedJobsCount()
```
    The estimated number of jobs with a SUBMITTED status.
    
    Returns:
    
    The estimated number of jobs with a SUBMITTED status.
  - withSubmittedJobsCount
```
public Queue withSubmittedJobsCount(Integer submittedJobsCount)
```
    The estimated number of jobs with a SUBMITTED status.
    
    Parameters:
    
    submittedJobsCount - The estimated number of jobs with a SUBMITTED status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    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.
    
    Parameters:
    
    type - 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.
    
    See Also:
    
    Type
  - getType
```
public String getType()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    Type
  - withType
```
public Queue withType(String type)
```
    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.
    
    Parameters:
    
    type - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Type
  - withType
```
public Queue withType(Type type)
```
    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.
    
    Parameters:
    
    type - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Type
  - 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 Queue 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 Queue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Queue

Method Detail

setArn

getArn

withArn

setCreatedAt

getCreatedAt

withCreatedAt

setDescription

getDescription

withDescription

setLastUpdated

getLastUpdated

withLastUpdated

setName

getName

withName

setPricingPlan

getPricingPlan

withPricingPlan

withPricingPlan

setProgressingJobsCount

getProgressingJobsCount

withProgressingJobsCount

setReservationPlan

getReservationPlan

withReservationPlan

setStatus

getStatus

withStatus

withStatus

setSubmittedJobsCount

getSubmittedJobsCount

withSubmittedJobsCount

setType

getType

withType

withType

toString

equals

hashCode

clone

marshall