Class JobQueueDetail

java.lang.Object
software.amazon.awssdk.services.batch.model.JobQueueDetail
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<JobQueueDetail.Builder,JobQueueDetail>
@Generated("software.amazon.awssdk:codegen") public final class JobQueueDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<JobQueueDetail.Builder,JobQueueDetail>

An object that represents the details for an Batch job queue.

See Also:

  • Method Details

    • jobQueueName

      public final String jobQueueName()

      The job queue name.

      Returns:
      The job queue name.

    • jobQueueArn

      public final String jobQueueArn()

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

      Returns:
      The Amazon Resource Name (ARN) of the job queue.

    • state

      public final JQState 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 is DISABLED, 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 return JQState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      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 is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.
      See Also:

    • stateAsString

      public final String 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 is DISABLED, 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 return JQState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      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 is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.
      See Also:

    • schedulingPolicyArn

      public final String 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

      public final JQStatus status()

      The status of the job queue (for example, CREATING or VALID).

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

      Returns:
      The status of the job queue (for example, CREATING or VALID).
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the job queue (for example, CREATING or VALID).

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

      Returns:
      The status of the job queue (for example, CREATING or VALID).
      See Also:

    • statusReason

      public final String 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

      public final 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 the 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. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

      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 the 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. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

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

    • computeEnvironmentOrder

      public final List<ComputeEnvironmentOrder> 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 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 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 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.

    • jobStateTimeLimitActions

      public final List<JobStateTimeLimitAction> 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

      public JobQueueDetail.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<JobQueueDetail.Builder,JobQueueDetail>
      Returns:
      a builder for type T

    • builder

      public static JobQueueDetail.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final 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.