Class Queue
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Queue.Builder,
Queue>
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
An identifier for this resource that is unique within all of AWS.static Queue.Builder
builder()
final Integer
The maximum number of jobs your queue can process concurrently.final Instant
The timestamp in epoch seconds for when you created the queue.final String
An optional description that you create for each queue.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ServiceOverrides property.final Instant
The timestamp in epoch seconds for when you most recently updated the queue.final String
name()
A name that you create for each queue.final PricingPlan
Specifies whether the pricing plan for the queue is on-demand or reserved.final String
Specifies whether the pricing plan for the queue is on-demand or reserved.final Integer
The estimated number of jobs with a PROGRESSING status.final ReservationPlan
Details about the pricing plan for your reserved queue.static Class
<? extends Queue.Builder> final List
<ServiceOverride> A list of any service overrides applied by MediaConvert to the settings that you have configured.final QueueStatus
status()
Queues can be ACTIVE or PAUSED.final String
Queues can be ACTIVE or PAUSED.final Integer
The estimated number of jobs with a SUBMITTED status.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Type
type()
Specifies whether this on-demand queue is system or custom.final String
Specifies whether this on-demand queue is system or custom.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The maximum number of jobs your queue can process concurrently.- Returns:
- The maximum number of jobs your queue can process concurrently.
-
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
An optional description that you create for each queue.- Returns:
- An optional description that you create for each queue.
-
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
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
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 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:
-
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 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:
-
progressingJobsCount
The estimated number of jobs with a PROGRESSING status.- Returns:
- The estimated number of jobs with a PROGRESSING status.
-
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 theisEmpty()
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
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
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 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:
-
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 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:
-
submittedJobsCount
The estimated number of jobs with a SUBMITTED status.- Returns:
- The estimated number of jobs with a SUBMITTED status.
-
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 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:
-
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 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:
-
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 interfaceToCopyableBuilder<Queue.Builder,
Queue> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-