JobQueueDetail (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.batch.model.JobQueueDetail

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobQueueDetail
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object representing the details of an AWS Batch job queue.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobQueueDetail()

Constructors
Constructor and Description
`JobQueueDetail()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobQueueDetail`	`clone()`
`boolean`	`equals(Object obj)`
`List<ComputeEnvironmentOrder>`	`getComputeEnvironmentOrder()` The compute environments that are attached to the job queue and the order in which job placement is preferred.
`String`	`getJobQueueArn()` The Amazon Resource Name (ARN) of the job queue.
`String`	`getJobQueueName()` The name of the job queue.
`Integer`	`getPriority()` The priority of the job queue.
`String`	`getState()` Describes the ability of the queue to accept new jobs.
`String`	`getStatus()` The status of the job queue (for example, `CREATING` or `VALID`).
`String`	`getStatusReason()` A short, human-readable string to provide additional details about the current status of the job queue.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setComputeEnvironmentOrder(Collection<ComputeEnvironmentOrder> computeEnvironmentOrder)` The compute environments that are attached to the job queue and the order in which job placement is preferred.
`void`	`setJobQueueArn(String jobQueueArn)` The Amazon Resource Name (ARN) of the job queue.
`void`	`setJobQueueName(String jobQueueName)` The name of the job queue.
`void`	`setPriority(Integer priority)` The priority of the job queue.
`void`	`setState(JQState state)` Describes the ability of the queue to accept new jobs.
`void`	`setState(String state)` Describes the ability of the queue to accept new jobs.
`void`	`setStatus(JQStatus status)` The status of the job queue (for example, `CREATING` or `VALID`).
`void`	`setStatus(String status)` The status of the job queue (for example, `CREATING` or `VALID`).
`void`	`setStatusReason(String statusReason)` A short, human-readable string to provide additional details about the current status of the job queue.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`JobQueueDetail`	`withComputeEnvironmentOrder(Collection<ComputeEnvironmentOrder> computeEnvironmentOrder)` The compute environments that are attached to the job queue and the order in which job placement is preferred.
`JobQueueDetail`	`withComputeEnvironmentOrder(ComputeEnvironmentOrder... computeEnvironmentOrder)` The compute environments that are attached to the job queue and the order in which job placement is preferred.
`JobQueueDetail`	`withJobQueueArn(String jobQueueArn)` The Amazon Resource Name (ARN) of the job queue.
`JobQueueDetail`	`withJobQueueName(String jobQueueName)` The name of the job queue.
`JobQueueDetail`	`withPriority(Integer priority)` The priority of the job queue.
`JobQueueDetail`	`withState(JQState state)` Describes the ability of the queue to accept new jobs.
`JobQueueDetail`	`withState(String state)` Describes the ability of the queue to accept new jobs.
`JobQueueDetail`	`withStatus(JQStatus status)` The status of the job queue (for example, `CREATING` or `VALID`).
`JobQueueDetail`	`withStatus(String status)` The status of the job queue (for example, `CREATING` or `VALID`).
`JobQueueDetail`	`withStatusReason(String statusReason)` A short, human-readable string to provide additional details about the current status of the job queue.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JobQueueDetail
```
public JobQueueDetail()
```
- Method Detail
  - setJobQueueName
```
public void setJobQueueName(String jobQueueName)
```
    The name of the job queue.
    
    Parameters:
    
    jobQueueName - The name of the job queue.
  - getJobQueueName
```
public String getJobQueueName()
```
    The name of the job queue.
    
    Returns:
    
    The name of the job queue.
  - withJobQueueName
```
public JobQueueDetail withJobQueueName(String jobQueueName)
```
    The name of the job queue.
    
    Parameters:
    
    jobQueueName - The name of the job queue.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobQueueArn
```
public void setJobQueueArn(String jobQueueArn)
```
    The Amazon Resource Name (ARN) of the job queue.
    
    Parameters:
    
    jobQueueArn - The Amazon Resource Name (ARN) of the job queue.
  - getJobQueueArn
```
public String getJobQueueArn()
```
    The Amazon Resource Name (ARN) of the job queue.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the job queue.
  - withJobQueueArn
```
public JobQueueDetail withJobQueueArn(String jobQueueArn)
```
    The Amazon Resource Name (ARN) of the job queue.
    
    Parameters:
    
    jobQueueArn - The Amazon Resource Name (ARN) of the job queue.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    Describes the ability of the queue to accept new jobs.
    
    Parameters:
    
    state - Describes the ability of the queue to accept new jobs.
    
    See Also:
    
    JQState
  - getState
```
public String getState()
```
    Describes the ability of the queue to accept new jobs.
    
    Returns:
    
    Describes the ability of the queue to accept new jobs.
    
    See Also:
    
    JQState
  - withState
```
public JobQueueDetail withState(String state)
```
    Describes the ability of the queue to accept new jobs.
    
    Parameters:
    
    state - Describes the ability of the queue to accept new jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JQState
  - setState
```
public void setState(JQState state)
```
    Describes the ability of the queue to accept new jobs.
    
    Parameters:
    
    state - Describes the ability of the queue to accept new jobs.
    
    See Also:
    
    JQState
  - withState
```
public JobQueueDetail withState(JQState state)
```
    Describes the ability of the queue to accept new jobs.
    
    Parameters:
    
    state - Describes the ability of the queue to accept new jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JQState
  - setStatus
```
public void setStatus(String status)
```
    The status of the job queue (for example, CREATING or VALID).
    
    Parameters:
    
    status - The status of the job queue (for example, CREATING or VALID).
    
    See Also:
    
    JQStatus
  - getStatus
```
public String getStatus()
```
    The status of the job queue (for example, CREATING or VALID).
    
    Returns:
    
    The status of the job queue (for example, CREATING or VALID).
    
    See Also:
    
    JQStatus
  - withStatus
```
public JobQueueDetail withStatus(String status)
```
    The status of the job queue (for example, CREATING or VALID).
    
    Parameters:
    
    status - The status of the job queue (for example, CREATING or VALID).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JQStatus
  - setStatus
```
public void setStatus(JQStatus status)
```
    The status of the job queue (for example, CREATING or VALID).
    
    Parameters:
    
    status - The status of the job queue (for example, CREATING or VALID).
    
    See Also:
    
    JQStatus
  - withStatus
```
public JobQueueDetail withStatus(JQStatus status)
```
    The status of the job queue (for example, CREATING or VALID).
    
    Parameters:
    
    status - The status of the job queue (for example, CREATING or VALID).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JQStatus
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    A short, human-readable string to provide additional details about the current status of the job queue.
    
    Parameters:
    
    statusReason - A short, human-readable string to provide additional details about the current status of the job queue.
  - getStatusReason
```
public String getStatusReason()
```
    A short, human-readable string to provide additional details about the current status of the job queue.
    
    Returns:
    
    A short, human-readable string to provide additional details about the current status of the job queue.
  - withStatusReason
```
public JobQueueDetail withStatusReason(String statusReason)
```
    A short, human-readable string to provide additional details about the current status of the job queue.
    
    Parameters:
    
    statusReason - A short, human-readable string to provide additional details about the current status of the job queue.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(Integer priority)
```
    The priority of the job queue.
    
    Parameters:
    
    priority - The priority of the job queue.
  - getPriority
```
public Integer getPriority()
```
    The priority of the job queue.
    
    Returns:
    
    The priority of the job queue.
  - withPriority
```
public JobQueueDetail withPriority(Integer priority)
```
    The priority of the job queue.
    
    Parameters:
    
    priority - The priority of the job queue.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getComputeEnvironmentOrder
```
public List<ComputeEnvironmentOrder> getComputeEnvironmentOrder()
```
    The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.
    
    Returns:
    
    The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.
  - setComputeEnvironmentOrder
```
public void setComputeEnvironmentOrder(Collection<ComputeEnvironmentOrder> computeEnvironmentOrder)
```
    The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.
    
    Parameters:
    
    computeEnvironmentOrder - The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.
  - withComputeEnvironmentOrder
```
public JobQueueDetail withComputeEnvironmentOrder(ComputeEnvironmentOrder... computeEnvironmentOrder)
```
    The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.
    
    NOTE: This method appends the values to the existing list (if any). Use setComputeEnvironmentOrder(java.util.Collection) or withComputeEnvironmentOrder(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    computeEnvironmentOrder - The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withComputeEnvironmentOrder
```
public JobQueueDetail withComputeEnvironmentOrder(Collection<ComputeEnvironmentOrder> computeEnvironmentOrder)
```
    The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.
    
    Parameters:
    
    computeEnvironmentOrder - The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public JobQueueDetail clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class JobQueueDetail

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobQueueDetail

Method Detail

setJobQueueName

getJobQueueName

withJobQueueName

setJobQueueArn

getJobQueueArn

withJobQueueArn

setState

getState

withState

setState

withState

setStatus

getStatus

withStatus

setStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

setPriority

getPriority

withPriority

getComputeEnvironmentOrder

setComputeEnvironmentOrder

withComputeEnvironmentOrder

withComputeEnvironmentOrder

toString

equals

hashCode

clone

marshall