/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.batch.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

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

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class JobQueueDetail implements Serializable, Cloneable, StructuredPojo { /** *

* The job queue name. *

*/ private String jobQueueName; /** *

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

*/ private String jobQueueArn; /** *

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

*/ private String state; /** *

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

*/ private String schedulingPolicyArn; /** *

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

*/ private String status; /** *

* A short, human-readable string to provide additional details for the current status of the job queue. *

*/ private String statusReason; /** *

* 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 EC2 (EC2 or SPOT) or Fargate (FARGATE or * FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed. *

*/ private Integer priority; /** *

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

*/ private java.util.List computeEnvironmentOrder; /** *

* The tags that are applied to the job queue. For more information, see Tagging your Batch resources in * Batch User Guide. *

*/ private java.util.Map tags; /** *

* The job queue name. *

* * @param jobQueueName * The job queue name. */ public void setJobQueueName(String jobQueueName) { this.jobQueueName = jobQueueName; } /** *

* The job queue name. *

* * @return The job queue name. */ public String getJobQueueName() { return this.jobQueueName; } /** *

* The job queue name. *

* * @param jobQueueName * The job queue name. * @return Returns a reference to this object so that method calls can be chained together. */ public JobQueueDetail withJobQueueName(String jobQueueName) { setJobQueueName(jobQueueName); return this; } /** *

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

* * @param jobQueueArn * The Amazon Resource Name (ARN) of the job queue. */ public void setJobQueueArn(String jobQueueArn) { this.jobQueueArn = jobQueueArn; } /** *

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

* * @return The Amazon Resource Name (ARN) of the job queue. */ public String getJobQueueArn() { return this.jobQueueArn; } /** *

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

* * @param jobQueueArn * The Amazon Resource Name (ARN) of the job queue. * @return Returns a reference to this object so that method calls can be chained together. */ public JobQueueDetail withJobQueueArn(String jobQueueArn) { setJobQueueArn(jobQueueArn); return this; } /** *

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

* * @param 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. * @see JQState */ public void setState(String state) { this.state = 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. *

* * @return 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 JQState */ public String getState() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. * @see JQState */ public JobQueueDetail withState(String state) { setState(state); return this; } /** *

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

* * @param 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. * @see JQState */ public void setState(JQState state) { withState(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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. * @see JQState */ public JobQueueDetail withState(JQState state) { this.state = state.toString(); return this; } /** *

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

* * @param 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. */ public void setSchedulingPolicyArn(String schedulingPolicyArn) { this.schedulingPolicyArn = 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. *

* * @return 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. */ public String getSchedulingPolicyArn() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public JobQueueDetail withSchedulingPolicyArn(String schedulingPolicyArn) { setSchedulingPolicyArn(schedulingPolicyArn); return this; } /** *

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

* * @param status * The status of the job queue (for example, CREATING or VALID). * @see JQStatus */ public void setStatus(String status) { this.status = status; } /** *

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

* * @return The status of the job queue (for example, CREATING or VALID). * @see JQStatus */ public String getStatus() { return this.status; } /** *

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

* * @param status * The status of the job queue (for example, CREATING or VALID). * @return Returns a reference to this object so that method calls can be chained together. * @see JQStatus */ public JobQueueDetail withStatus(String status) { setStatus(status); return this; } /** *

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

* * @param status * The status of the job queue (for example, CREATING or VALID). * @see JQStatus */ public void setStatus(JQStatus status) { withStatus(status); } /** *

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

* * @param status * The status of the job queue (for example, CREATING or VALID). * @return Returns a reference to this object so that method calls can be chained together. * @see JQStatus */ public JobQueueDetail withStatus(JQStatus status) { this.status = status.toString(); return this; } /** *

* A short, human-readable string to provide additional details for the current status of the job queue. *

* * @param statusReason * A short, human-readable string to provide additional details for the current status of the job queue. */ public void setStatusReason(String statusReason) { this.statusReason = statusReason; } /** *

* A short, human-readable string to provide additional details for the current status of the job queue. *

* * @return A short, human-readable string to provide additional details for the current status of the job queue. */ public String getStatusReason() { return this.statusReason; } /** *

* A short, human-readable string to provide additional details for the current status of the job queue. *

* * @param statusReason * A short, human-readable string to provide additional details for the current status of the job queue. * @return Returns a reference to this object so that method calls can be chained together. */ public JobQueueDetail withStatusReason(String statusReason) { setStatusReason(statusReason); return this; } /** *

* 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 EC2 (EC2 or SPOT) or Fargate (FARGATE or * FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed. *

* * @param 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 EC2 (EC2 or SPOT) or Fargate ( * FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed. */ public void setPriority(Integer priority) { this.priority = 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 EC2 (EC2 or SPOT) or Fargate (FARGATE or * FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed. *

* * @return 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 EC2 (EC2 or SPOT) or Fargate ( * FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed. */ public Integer getPriority() { return this.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 EC2 (EC2 or SPOT) or Fargate (FARGATE or * FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed. *

* * @param 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 EC2 (EC2 or SPOT) or Fargate ( * FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed. * @return Returns a reference to this object so that method calls can be chained together. */ public JobQueueDetail withPriority(Integer priority) { setPriority(priority); return this; } /** *

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

* * @return 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. */ public java.util.List getComputeEnvironmentOrder() { return 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. *

* * @param 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. */ public void setComputeEnvironmentOrder(java.util.Collection computeEnvironmentOrder) { if (computeEnvironmentOrder == null) { this.computeEnvironmentOrder = null; return; } this.computeEnvironmentOrder = new java.util.ArrayList(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. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setComputeEnvironmentOrder(java.util.Collection)} or * {@link #withComputeEnvironmentOrder(java.util.Collection)} if you want to override the existing values. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public JobQueueDetail withComputeEnvironmentOrder(ComputeEnvironmentOrder... computeEnvironmentOrder) { if (this.computeEnvironmentOrder == null) { setComputeEnvironmentOrder(new java.util.ArrayList(computeEnvironmentOrder.length)); } for (ComputeEnvironmentOrder ele : computeEnvironmentOrder) { this.computeEnvironmentOrder.add(ele); } return this; } /** *

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

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public JobQueueDetail withComputeEnvironmentOrder(java.util.Collection computeEnvironmentOrder) { setComputeEnvironmentOrder(computeEnvironmentOrder); return this; } /** *

* The tags that are applied to the job queue. For more information, see Tagging your Batch resources in * Batch User Guide. *

* * @return The tags that are applied to the job queue. For more information, see Tagging your Batch * resources in Batch User Guide. */ public java.util.Map getTags() { return tags; } /** *

* The tags that are applied to the job queue. For more information, see Tagging your Batch resources in * Batch User Guide. *

* * @param tags * The tags that are applied to the job queue. For more information, see Tagging your Batch resources * in Batch User Guide. */ public void setTags(java.util.Map tags) { this.tags = tags; } /** *

* The tags that are applied to the job queue. For more information, see Tagging your Batch resources in * Batch User Guide. *

* * @param tags * The tags that are applied to the job queue. For more information, see Tagging your Batch resources * in Batch User Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public JobQueueDetail withTags(java.util.Map tags) { setTags(tags); return this; } /** * Add a single Tags entry * * @see JobQueueDetail#withTags * @returns a reference to this object so that method calls can be chained together. */ public JobQueueDetail addTagsEntry(String key, String value) { if (null == this.tags) { this.tags = new java.util.HashMap(); } if (this.tags.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.tags.put(key, value); return this; } /** * Removes all the entries added into Tags. * * @return Returns a reference to this object so that method calls can be chained together. */ public JobQueueDetail clearTagsEntries() { this.tags = null; return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getJobQueueName() != null) sb.append("JobQueueName: ").append(getJobQueueName()).append(","); if (getJobQueueArn() != null) sb.append("JobQueueArn: ").append(getJobQueueArn()).append(","); if (getState() != null) sb.append("State: ").append(getState()).append(","); if (getSchedulingPolicyArn() != null) sb.append("SchedulingPolicyArn: ").append(getSchedulingPolicyArn()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).append(","); if (getStatusReason() != null) sb.append("StatusReason: ").append(getStatusReason()).append(","); if (getPriority() != null) sb.append("Priority: ").append(getPriority()).append(","); if (getComputeEnvironmentOrder() != null) sb.append("ComputeEnvironmentOrder: ").append(getComputeEnvironmentOrder()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof JobQueueDetail == false) return false; JobQueueDetail other = (JobQueueDetail) obj; if (other.getJobQueueName() == null ^ this.getJobQueueName() == null) return false; if (other.getJobQueueName() != null && other.getJobQueueName().equals(this.getJobQueueName()) == false) return false; if (other.getJobQueueArn() == null ^ this.getJobQueueArn() == null) return false; if (other.getJobQueueArn() != null && other.getJobQueueArn().equals(this.getJobQueueArn()) == false) return false; if (other.getState() == null ^ this.getState() == null) return false; if (other.getState() != null && other.getState().equals(this.getState()) == false) return false; if (other.getSchedulingPolicyArn() == null ^ this.getSchedulingPolicyArn() == null) return false; if (other.getSchedulingPolicyArn() != null && other.getSchedulingPolicyArn().equals(this.getSchedulingPolicyArn()) == false) return false; if (other.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false) return false; if (other.getStatusReason() == null ^ this.getStatusReason() == null) return false; if (other.getStatusReason() != null && other.getStatusReason().equals(this.getStatusReason()) == false) return false; if (other.getPriority() == null ^ this.getPriority() == null) return false; if (other.getPriority() != null && other.getPriority().equals(this.getPriority()) == false) return false; if (other.getComputeEnvironmentOrder() == null ^ this.getComputeEnvironmentOrder() == null) return false; if (other.getComputeEnvironmentOrder() != null && other.getComputeEnvironmentOrder().equals(this.getComputeEnvironmentOrder()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getJobQueueName() == null) ? 0 : getJobQueueName().hashCode()); hashCode = prime * hashCode + ((getJobQueueArn() == null) ? 0 : getJobQueueArn().hashCode()); hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode()); hashCode = prime * hashCode + ((getSchedulingPolicyArn() == null) ? 0 : getSchedulingPolicyArn().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getStatusReason() == null) ? 0 : getStatusReason().hashCode()); hashCode = prime * hashCode + ((getPriority() == null) ? 0 : getPriority().hashCode()); hashCode = prime * hashCode + ((getComputeEnvironmentOrder() == null) ? 0 : getComputeEnvironmentOrder().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public JobQueueDetail clone() { try { return (JobQueueDetail) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.batch.model.transform.JobQueueDetailMarshaller.getInstance().marshall(this, protocolMarshaller); } }