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:

  • Method Details

    • 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.

    • concurrentJobs

      public final Integer concurrentJobs()
      The maximum number of jobs your queue can process concurrently.
      Returns:
      The maximum number of jobs your queue can process concurrently.

    • 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, 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. 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:

    • 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, 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. 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:

    • 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.

    • hasServiceOverrides

      public final boolean hasServiceOverrides()
      For responses, this returns true if the service returned a value for the ServiceOverrides property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • serviceOverrides

      public final List<ServiceOverride> serviceOverrides()
      A list of any service overrides applied by MediaConvert to the settings that you have configured. If you see any overrides, we recommend that you contact AWS Support.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasServiceOverrides() method.

      Returns:
      A list of any service overrides applied by MediaConvert to the settings that you have configured. If you see any overrides, we recommend that you contact AWS Support.

    • 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, 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:

    • 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, 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:

    • 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, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      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:

    • 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, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      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:

    • 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 final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.