Class Queue
- java.lang.Object
-
- software.amazon.awssdk.services.mediaconvert.model.Queue
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Queue.Builder,Queue>
@Generated("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/working-with-queues.html.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceQueue.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()An identifier for this resource that is unique within all of AWS.static Queue.Builderbuilder()InstantcreatedAt()The timestamp in epoch seconds for when you created the queue.Stringdescription()An optional description that you create for each queue.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()InstantlastUpdated()The timestamp in epoch seconds for when you most recently updated the queue.Stringname()A name that you create for each queue.PricingPlanpricingPlan()Specifies whether the pricing plan for the queue is on-demand or reserved.StringpricingPlanAsString()Specifies whether the pricing plan for the queue is on-demand or reserved.IntegerprogressingJobsCount()The estimated number of jobs with a PROGRESSING status.ReservationPlanreservationPlan()Details about the pricing plan for your reserved queue.List<SdkField<?>>sdkFields()static Class<? extends Queue.Builder>serializableBuilderClass()QueueStatusstatus()Queues can be ACTIVE or PAUSED.StringstatusAsString()Queues can be ACTIVE or PAUSED.IntegersubmittedJobsCount()The estimated number of jobs with a SUBMITTED status.Queue.BuildertoBuilder()StringtoString()Returns a string representation of this object.Typetype()Specifies whether this on-demand queue is system or custom.StringtypeAsString()Specifies whether this on-demand queue is system or custom.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
arn
public final 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 final Instant createdAt()
The timestamp in epoch seconds for when you created the queue.- Returns:
- The timestamp in epoch seconds for when you created the queue.
-
description
public final String description()
An optional description that you create for each queue.- Returns:
- An optional description that you create for each queue.
-
lastUpdated
public final Instant lastUpdated()
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.
-
name
public final 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 final 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.If the service returns an enum value that is not available in the current SDK version,
pricingPlanwill returnPricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompricingPlanAsString().- 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
-
pricingPlanAsString
public final String pricingPlanAsString()
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.If the service returns an enum value that is not available in the current SDK version,
pricingPlanwill returnPricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompricingPlanAsString().- 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
-
progressingJobsCount
public final Integer progressingJobsCount()
The estimated number of jobs with a PROGRESSING status.- Returns:
- The estimated number of jobs with a PROGRESSING status.
-
reservationPlan
public final 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 final 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,
statuswill returnQueueStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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 final 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,
statuswill returnQueueStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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 final Integer submittedJobsCount()
The estimated number of jobs with a SUBMITTED status.- Returns:
- The estimated number of jobs with a SUBMITTED status.
-
type
public final 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.If the service returns an enum value that is not available in the current SDK version,
typewill returnType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- 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
-
typeAsString
public final String typeAsString()
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.If the service returns an enum value that is not available in the current SDK version,
typewill returnType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- 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
-
toBuilder
public Queue.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Queue.Builder,Queue>
-
builder
public static Queue.Builder builder()
-
serializableBuilderClass
public static Class<? extends Queue.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
-