software.amazon.awssdk.services.mediaconvert.model

Class CreateQueueRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mediaconvert.model.MediaConvertRequest

software.amazon.awssdk.services.mediaconvert.model.CreateQueueRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateQueueRequest.Builder,CreateQueueRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateQueueRequest
extends MediaConvertRequest
implements ToCopyableBuilder<CreateQueueRequest.Builder,CreateQueueRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateQueueRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateQueueRequest.Builder	builder()
String	description() Optional.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() The name of the queue that you are creating.
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.
ReservationPlanSettings	reservationPlanSettings() Details about the pricing plan for your reserved queue.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateQueueRequest.Builder>	serializableBuilderClass()
QueueStatus	status() Initial state of the queue.
String	statusAsString() Initial state of the queue.
Map<String,String>	tags() The tags that you want to add to the resource.
CreateQueueRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

description

public final String description()

Optional. A description of the queue that you are creating.

Returns:

Optional. A description of the queue that you are creating.

name

public final String name()

The name of the queue that you are creating.

Returns:

The name of the queue that you are creating.

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. When you use the API to create a queue, the default is on-demand.

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. When you use the API to create a queue, the default is on-demand.

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. When you use the API to create a queue, the default is on-demand.

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. When you use the API to create a queue, the default is on-demand.

See Also:

PricingPlan

reservationPlanSettings

public final ReservationPlanSettings reservationPlanSettings()

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()

Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.

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:

Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.

See Also:

QueueStatus

statusAsString

public final String statusAsString()

Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.

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:

Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.

See Also:

QueueStatus

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final Map<String,String> tags()

The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.

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 hasTags() method.

Returns:

The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.

toBuilder

public CreateQueueRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateQueueRequest.Builder,CreateQueueRequest>

Specified by:

toBuilder in class MediaConvertRequest

builder

public static CreateQueueRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateQueueRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo