Class JobQueueDetail
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<JobQueueDetail.Builder,
JobQueueDetail>
An object that represents the details for an Batch job queue.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic JobQueueDetail.Builder
builder()
final List
<ComputeEnvironmentOrder> The compute environments that are attached to the job queue and the order that job placement is preferred.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 boolean
For responses, this returns true if the service returned a value for the ComputeEnvironmentOrder property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the JobStateTimeLimitActions property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The Amazon Resource Name (ARN) of the job queue.final String
The job queue name.final List
<JobStateTimeLimitAction> The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times.final Integer
priority()
The priority of the job queue.final String
The Amazon Resource Name (ARN) of the scheduling policy.static Class
<? extends JobQueueDetail.Builder> final JQState
state()
Describes the ability of the queue to accept new jobs.final String
Describes the ability of the queue to accept new jobs.final JQStatus
status()
The status of the job queue (for example,CREATING
orVALID
).final String
The status of the job queue (for example,CREATING
orVALID
).final String
A short, human-readable string to provide additional details for the current status of the job queue.tags()
The tags that are applied to the job queue.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobQueueName
-
jobQueueArn
The Amazon Resource Name (ARN) of the job queue.
- Returns:
- The Amazon Resource Name (ARN) of the job queue.
-
state
Describes the ability of the queue to accept new jobs. If the job queue state is
ENABLED
, it can accept jobs. If the job queue state isDISABLED
, new jobs can't be added to the queue, but jobs already in the queue can finish.If the service returns an enum value that is not available in the current SDK version,
state
will returnJQState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- Describes the ability of the queue to accept new jobs. If the job queue state is
ENABLED
, it can accept jobs. If the job queue state isDISABLED
, new jobs can't be added to the queue, but jobs already in the queue can finish. - See Also:
-
stateAsString
Describes the ability of the queue to accept new jobs. If the job queue state is
ENABLED
, it can accept jobs. If the job queue state isDISABLED
, new jobs can't be added to the queue, but jobs already in the queue can finish.If the service returns an enum value that is not available in the current SDK version,
state
will returnJQState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- Describes the ability of the queue to accept new jobs. If the job queue state is
ENABLED
, it can accept jobs. If the job queue state isDISABLED
, new jobs can't be added to the queue, but jobs already in the queue can finish. - See Also:
-
schedulingPolicyArn
The Amazon Resource Name (ARN) of the scheduling policy. The format is
aws:Partition:batch:Region:Account:scheduling-policy/Name
. For example,aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy
.- Returns:
- The Amazon Resource Name (ARN) of the scheduling policy. The format is
aws:Partition:batch:Region:Account:scheduling-policy/Name
. For example,aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy
.
-
status
The status of the job queue (for example,
CREATING
orVALID
).If the service returns an enum value that is not available in the current SDK version,
status
will returnJQStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the job queue (for example,
CREATING
orVALID
). - See Also:
-
statusAsString
The status of the job queue (for example,
CREATING
orVALID
).If the service returns an enum value that is not available in the current SDK version,
status
will returnJQStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the job queue (for example,
CREATING
orVALID
). - See Also:
-
statusReason
A short, human-readable string to provide additional details for the current status of the job queue.
- Returns:
- A short, human-readable string to provide additional details for the current status of the job queue.
-
priority
The priority of the job queue. Job queue priority determines the order that job queues are evaluated when multiple queues dispatch jobs within a shared compute environment. A higher value for
priority
indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of10
is evaluated before a queue with a priority value of1
. All of the compute environments must be either Amazon EC2 (EC2
orSPOT
) or Fargate (FARGATE
orFARGATE_SPOT
). Amazon EC2 and Fargate compute environments can't be mixed.Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see Job Dependencies in the Batch User Guide.
- Returns:
- The priority of the job queue. Job queue priority determines the order that job queues are evaluated when
multiple queues dispatch jobs within a shared compute environment. A higher value for
priority
indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of10
is evaluated before a queue with a priority value of1
. All of the compute environments must be either Amazon EC2 (EC2
orSPOT
) or Fargate (FARGATE
orFARGATE_SPOT
). Amazon EC2 and Fargate compute environments can't be mixed.Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see Job Dependencies in the Batch User Guide.
-
hasComputeEnvironmentOrder
public final boolean hasComputeEnvironmentOrder()For responses, this returns true if the service returned a value for the ComputeEnvironmentOrder 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. -
computeEnvironmentOrder
The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.
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
hasComputeEnvironmentOrder()
method.- Returns:
- The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.
-
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 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. -
tags
The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.
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 are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.
-
hasJobStateTimeLimitActions
public final boolean hasJobStateTimeLimitActions()For responses, this returns true if the service returned a value for the JobStateTimeLimitActions 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. -
jobStateTimeLimitActions
The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after
maxTimeSeconds
has passed.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
hasJobStateTimeLimitActions()
method.- Returns:
- The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified
state longer than specified times. Batch will perform each action after
maxTimeSeconds
has passed.
-
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<JobQueueDetail.Builder,
JobQueueDetail> - 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.
-