Queue (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.mediaconvert.model.Queue

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Queue.Builder,Queue>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Queue
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Queue.Builder,Queue>
```
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/about-resource-allocation-and-job-prioritization.html.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Queue.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Queue.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` An identifier for this resource that is unique within all of AWS.
`static Queue.Builder`	`builder()`
`Instant`	`createdAt()` The time stamp in epoch seconds for queue creation.
`String`	`description()` An optional description that you create for each queue.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`lastUpdated()` The time stamp in epoch seconds when the queue was last updated.
`String`	`name()` A name that you create for each queue.
`PricingPlan`	`pricingPlan()` Specifies whether the pricing plan for the queue is On-demand or Reserved.
`String`	`pricingPlanAsString()` Specifies whether the pricing plan for the queue is On-demand or Reserved.
`Integer`	`progressingJobsCount()` The estimated number of jobs with a PROGRESSING status.
`ReservationPlan`	`reservationPlan()` Details about the pricing plan for your reserved queue.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Queue.Builder>`	`serializableBuilderClass()`
`QueueStatus`	`status()` Queues can be ACTIVE or PAUSED.
`String`	`statusAsString()` Queues can be ACTIVE or PAUSED.
`Integer`	`submittedJobsCount()` The estimated number of jobs with a SUBMITTED status.
`Queue.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Type`	`type()` Specifies whether this queue is system or custom.
`String`	`typeAsString()` Specifies whether this queue is system or custom.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public String arn()
```
    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.
  - createdAt
```
public Instant createdAt()
```
    The time stamp in epoch seconds for queue creation.
    
    Returns:
    
    The time stamp in epoch seconds for queue creation.
  - description
```
public String description()
```
    An optional description that you create for each queue.
    
    Returns:
    
    An optional description that you create for each queue.
  - lastUpdated
```
public Instant lastUpdated()
```
    The time stamp in epoch seconds when the queue was last updated.
    
    Returns:
    
    The time stamp in epoch seconds when the queue was last updated.
  - name
```
public String name()
```
    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.
  - pricingPlan
```
public PricingPlan pricingPlan()
```
    Specifies whether the pricing plan for the queue is On-demand or Reserved. The pricing plan for the queue determines whether you pay On-demand or Reserved pricing for the transcoding jobs that you run through the queue. For Reserved queue pricing, you must set up a contract. You can create a Reserved queue contract through the AWS Elemental MediaConvert console.
    If the service returns an enum value that is not available in the current SDK version, pricingPlan will return PricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pricingPlanAsString().
    
    Returns:
    
    Specifies whether the pricing plan for the queue is On-demand or Reserved. The pricing plan for the queue determines whether you pay On-demand or Reserved pricing for the transcoding jobs that you run through the queue. For Reserved queue pricing, you must set up a contract. You can create a Reserved queue contract through the AWS Elemental MediaConvert console.
    
    See Also:
    
    PricingPlan
  - pricingPlanAsString
```
public String pricingPlanAsString()
```
    Specifies whether the pricing plan for the queue is On-demand or Reserved. The pricing plan for the queue determines whether you pay On-demand or Reserved pricing for the transcoding jobs that you run through the queue. For Reserved queue pricing, you must set up a contract. You can create a Reserved queue contract through the AWS Elemental MediaConvert console.
    If the service returns an enum value that is not available in the current SDK version, pricingPlan will return PricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pricingPlanAsString().
    
    Returns:
    
    Specifies whether the pricing plan for the queue is On-demand or Reserved. The pricing plan for the queue determines whether you pay On-demand or Reserved pricing for the transcoding jobs that you run through the queue. For Reserved queue pricing, you must set up a contract. You can create a Reserved queue contract through the AWS Elemental MediaConvert console.
    
    See Also:
    
    PricingPlan
  - progressingJobsCount
```
public Integer progressingJobsCount()
```
    The estimated number of jobs with a PROGRESSING status.
    
    Returns:
    
    The estimated number of jobs with a PROGRESSING status.
  - reservationPlan
```
public ReservationPlan reservationPlan()
```
    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.
  - status
```
public 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.
    If the service returns an enum value that is not available in the current SDK version, status will return QueueStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    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
  - statusAsString
```
public String statusAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, status will return QueueStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    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
  - submittedJobsCount
```
public Integer submittedJobsCount()
```
    The estimated number of jobs with a SUBMITTED status.
    
    Returns:
    
    The estimated number of jobs with a SUBMITTED status.
  - type
```
public Type type()
```
    Specifies whether this 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.
    If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specifies whether this 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
  - typeAsString
```
public String typeAsString()
```
    Specifies whether this 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.
    If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Specifies whether this 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
  - toBuilder
```
public Queue.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Queue.Builder,Queue>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Queue.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Queue.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class Queue

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

createdAt

description

lastUpdated

name

pricingPlan

pricingPlanAsString

progressingJobsCount

reservationPlan

status

statusAsString

submittedJobsCount

type

typeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields