software.amazon.awssdk.services.mediaconvert.model

Class UpdateQueueRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateQueueRequest.Builder,UpdateQueueRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateQueueRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateQueueRequest.Builder	builder()
String	description() The new description for the queue, if you are changing it.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	name() The name of the queue that you are modifying.
ReservationPlanSettings	reservationPlanSettings() The new details of your pricing plan for your reserved queue.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateQueueRequest.Builder>	serializableBuilderClass()
QueueStatus	status() Pause or activate a queue by changing its status between ACTIVE and PAUSED.
String	statusAsString() Pause or activate a queue by changing its status between ACTIVE and PAUSED.
UpdateQueueRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

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

description

public String description()

The new description for the queue, if you are changing it.

Returns:

The new description for the queue, if you are changing it.

name

public String name()

The name of the queue that you are modifying.

Returns:

The name of the queue that you are modifying.

reservationPlanSettings

public ReservationPlanSettings reservationPlanSettings()

The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them.

Returns:

The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them.

status

public QueueStatus status()

Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. 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:

Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. 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()

Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. 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:

Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

See Also:

QueueStatus

toBuilder

public UpdateQueueRequest.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<UpdateQueueRequest.Builder,UpdateQueueRequest>

Specified by:

toBuilder in class MediaConvertRequest

Returns:

a builder for type T

builder

public static UpdateQueueRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateQueueRequest.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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.