software.amazon.awssdk.services.batch.model

Class UpdateJobQueueRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.batch.model.BatchRequest

software.amazon.awssdk.services.batch.model.UpdateJobQueueRequest

All Implemented Interfaces:

ToCopyableBuilder<UpdateJobQueueRequest.Builder,UpdateJobQueueRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateJobQueueRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateJobQueueRequest.Builder	builder()
List<ComputeEnvironmentOrder>	computeEnvironmentOrder() Details the set of compute environments mapped to a job queue and their order relative to each other.
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	jobQueue() The name or the Amazon Resource Name (ARN) of the job queue.
Integer	priority() The priority of the job queue.
static Class<? extends UpdateJobQueueRequest.Builder>	serializableBuilderClass()
JQState	state() Describes the queue's ability to accept new jobs.
String	stateAsString() Describes the queue's ability to accept new jobs.
UpdateJobQueueRequest.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

jobQueue

public String jobQueue()

The name or the Amazon Resource Name (ARN) of the job queue.

Returns:

The name or the Amazon Resource Name (ARN) of the job queue.

state

public JQState state()

Describes the queue's ability to accept new jobs.

If the service returns an enum value that is not available in the current SDK version, state will return JQState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

Describes the queue's ability to accept new jobs.

See Also:

JQState

stateAsString

public String stateAsString()

Describes the queue's ability to accept new jobs.

If the service returns an enum value that is not available in the current SDK version, state will return JQState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

Describes the queue's ability to accept new jobs.

See Also:

JQState

priority

public Integer priority()

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1.

Returns:

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1.

computeEnvironmentOrder

public List<ComputeEnvironmentOrder> computeEnvironmentOrder()

Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should execute a given job.

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

Returns:

Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should execute a given job.

toBuilder

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

Specified by:

toBuilder in class BatchRequest

Returns:

a builder for type T

builder

public static UpdateJobQueueRequest.Builder builder()

serializableBuilderClass

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