/* * 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 summary details of a job. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class JobSummary implements Serializable, Cloneable, StructuredPojo { /** ** The Amazon Resource Name (ARN) of the job. *
*/ private String jobArn; /** ** The job ID. *
*/ private String jobId; /** ** The job name. *
*/ private String jobName; /** *
* The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this
* is when the job entered the SUBMITTED
state (at the time SubmitJob was called). For array
* child jobs, this is when the child job was spawned by its parent and entered the PENDING
state.
*
* The current status for the job. *
*/ private String status; /** ** A short, human-readable string to provide more details for the current status of the job. *
*/ private String statusReason; /** *
* The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the
* STARTING
state to the RUNNING
state.
*
* The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the
* RUNNING
state to a terminal state, such as SUCCEEDED
or FAILED
.
*
* An object that represents the details of the container that's associated with the job. *
*/ private ContainerSummary container; /** ** The array properties of the job, if it's an array job. *
*/ private ArrayPropertiesSummary arrayProperties; /** ** The node properties for a single node in a job summary list. *
** This isn't applicable to jobs that are running on Fargate resources. *
** The Amazon Resource Name (ARN) of the job definition. *
*/ private String jobDefinition; /** ** The Amazon Resource Name (ARN) of the job. *
* * @param jobArn * The Amazon Resource Name (ARN) of the job. */ public void setJobArn(String jobArn) { this.jobArn = jobArn; } /** ** The Amazon Resource Name (ARN) of the job. *
* * @return The Amazon Resource Name (ARN) of the job. */ public String getJobArn() { return this.jobArn; } /** ** The Amazon Resource Name (ARN) of the job. *
* * @param jobArn * The Amazon Resource Name (ARN) of the job. * @return Returns a reference to this object so that method calls can be chained together. */ public JobSummary withJobArn(String jobArn) { setJobArn(jobArn); return this; } /** ** The job ID. *
* * @param jobId * The job ID. */ public void setJobId(String jobId) { this.jobId = jobId; } /** ** The job ID. *
* * @return The job ID. */ public String getJobId() { return this.jobId; } /** ** The job ID. *
* * @param jobId * The job ID. * @return Returns a reference to this object so that method calls can be chained together. */ public JobSummary withJobId(String jobId) { setJobId(jobId); return this; } /** ** The job name. *
* * @param jobName * The job name. */ public void setJobName(String jobName) { this.jobName = jobName; } /** ** The job name. *
* * @return The job name. */ public String getJobName() { return this.jobName; } /** ** The job name. *
* * @param jobName * The job name. * @return Returns a reference to this object so that method calls can be chained together. */ public JobSummary withJobName(String jobName) { setJobName(jobName); return this; } /** *
* The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this
* is when the job entered the SUBMITTED
state (at the time SubmitJob was called). For array
* child jobs, this is when the child job was spawned by its parent and entered the PENDING
state.
*
SUBMITTED
state (at the time SubmitJob was
* called). For array child jobs, this is when the child job was spawned by its parent and entered the
* PENDING
state.
*/
public void setCreatedAt(Long createdAt) {
this.createdAt = createdAt;
}
/**
*
* The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this
* is when the job entered the SUBMITTED
state (at the time SubmitJob was called). For array
* child jobs, this is when the child job was spawned by its parent and entered the PENDING
state.
*
SUBMITTED
state (at the time SubmitJob was
* called). For array child jobs, this is when the child job was spawned by its parent and entered the
* PENDING
state.
*/
public Long getCreatedAt() {
return this.createdAt;
}
/**
*
* The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this
* is when the job entered the SUBMITTED
state (at the time SubmitJob was called). For array
* child jobs, this is when the child job was spawned by its parent and entered the PENDING
state.
*
SUBMITTED
state (at the time SubmitJob was
* called). For array child jobs, this is when the child job was spawned by its parent and entered the
* PENDING
state.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSummary withCreatedAt(Long createdAt) {
setCreatedAt(createdAt);
return this;
}
/**
* * The current status for the job. *
* * @param status * The current status for the job. * @see JobStatus */ public void setStatus(String status) { this.status = status; } /** ** The current status for the job. *
* * @return The current status for the job. * @see JobStatus */ public String getStatus() { return this.status; } /** ** The current status for the job. *
* * @param status * The current status for the job. * @return Returns a reference to this object so that method calls can be chained together. * @see JobStatus */ public JobSummary withStatus(String status) { setStatus(status); return this; } /** ** The current status for the job. *
* * @param status * The current status for the job. * @return Returns a reference to this object so that method calls can be chained together. * @see JobStatus */ public JobSummary withStatus(JobStatus status) { this.status = status.toString(); return this; } /** ** A short, human-readable string to provide more details for the current status of the job. *
* * @param statusReason * A short, human-readable string to provide more details for the current status of the job. */ public void setStatusReason(String statusReason) { this.statusReason = statusReason; } /** ** A short, human-readable string to provide more details for the current status of the job. *
* * @return A short, human-readable string to provide more details for the current status of the job. */ public String getStatusReason() { return this.statusReason; } /** ** A short, human-readable string to provide more details for the current status of the job. *
* * @param statusReason * A short, human-readable string to provide more details for the current status of the job. * @return Returns a reference to this object so that method calls can be chained together. */ public JobSummary withStatusReason(String statusReason) { setStatusReason(statusReason); return this; } /** *
* The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the
* STARTING
state to the RUNNING
state.
*
STARTING
state to the RUNNING
state.
*/
public void setStartedAt(Long startedAt) {
this.startedAt = startedAt;
}
/**
*
* The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the
* STARTING
state to the RUNNING
state.
*
STARTING
state to the RUNNING
state.
*/
public Long getStartedAt() {
return this.startedAt;
}
/**
*
* The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the
* STARTING
state to the RUNNING
state.
*
STARTING
state to the RUNNING
state.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSummary withStartedAt(Long startedAt) {
setStartedAt(startedAt);
return this;
}
/**
*
* The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the
* RUNNING
state to a terminal state, such as SUCCEEDED
or FAILED
.
*
RUNNING
state to a terminal state, such as SUCCEEDED
or FAILED
.
*/
public void setStoppedAt(Long stoppedAt) {
this.stoppedAt = stoppedAt;
}
/**
*
* The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the
* RUNNING
state to a terminal state, such as SUCCEEDED
or FAILED
.
*
RUNNING
state to a terminal state, such as SUCCEEDED
or FAILED
* .
*/
public Long getStoppedAt() {
return this.stoppedAt;
}
/**
*
* The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the
* RUNNING
state to a terminal state, such as SUCCEEDED
or FAILED
.
*
RUNNING
state to a terminal state, such as SUCCEEDED
or FAILED
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSummary withStoppedAt(Long stoppedAt) {
setStoppedAt(stoppedAt);
return this;
}
/**
* * An object that represents the details of the container that's associated with the job. *
* * @param container * An object that represents the details of the container that's associated with the job. */ public void setContainer(ContainerSummary container) { this.container = container; } /** ** An object that represents the details of the container that's associated with the job. *
* * @return An object that represents the details of the container that's associated with the job. */ public ContainerSummary getContainer() { return this.container; } /** ** An object that represents the details of the container that's associated with the job. *
* * @param container * An object that represents the details of the container that's associated with the job. * @return Returns a reference to this object so that method calls can be chained together. */ public JobSummary withContainer(ContainerSummary container) { setContainer(container); return this; } /** ** The array properties of the job, if it's an array job. *
* * @param arrayProperties * The array properties of the job, if it's an array job. */ public void setArrayProperties(ArrayPropertiesSummary arrayProperties) { this.arrayProperties = arrayProperties; } /** ** The array properties of the job, if it's an array job. *
* * @return The array properties of the job, if it's an array job. */ public ArrayPropertiesSummary getArrayProperties() { return this.arrayProperties; } /** ** The array properties of the job, if it's an array job. *
* * @param arrayProperties * The array properties of the job, if it's an array job. * @return Returns a reference to this object so that method calls can be chained together. */ public JobSummary withArrayProperties(ArrayPropertiesSummary arrayProperties) { setArrayProperties(arrayProperties); return this; } /** ** The node properties for a single node in a job summary list. *
** This isn't applicable to jobs that are running on Fargate resources. *
** This isn't applicable to jobs that are running on Fargate resources. *
*/ public void setNodeProperties(NodePropertiesSummary nodeProperties) { this.nodeProperties = nodeProperties; } /** ** The node properties for a single node in a job summary list. *
** This isn't applicable to jobs that are running on Fargate resources. *
** This isn't applicable to jobs that are running on Fargate resources. *
*/ public NodePropertiesSummary getNodeProperties() { return this.nodeProperties; } /** ** The node properties for a single node in a job summary list. *
** This isn't applicable to jobs that are running on Fargate resources. *
** This isn't applicable to jobs that are running on Fargate resources. *
* @return Returns a reference to this object so that method calls can be chained together. */ public JobSummary withNodeProperties(NodePropertiesSummary nodeProperties) { setNodeProperties(nodeProperties); return this; } /** ** The Amazon Resource Name (ARN) of the job definition. *
* * @param jobDefinition * The Amazon Resource Name (ARN) of the job definition. */ public void setJobDefinition(String jobDefinition) { this.jobDefinition = jobDefinition; } /** ** The Amazon Resource Name (ARN) of the job definition. *
* * @return The Amazon Resource Name (ARN) of the job definition. */ public String getJobDefinition() { return this.jobDefinition; } /** ** The Amazon Resource Name (ARN) of the job definition. *
* * @param jobDefinition * The Amazon Resource Name (ARN) of the job definition. * @return Returns a reference to this object so that method calls can be chained together. */ public JobSummary withJobDefinition(String jobDefinition) { setJobDefinition(jobDefinition); 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 (getJobArn() != null) sb.append("JobArn: ").append(getJobArn()).append(","); if (getJobId() != null) sb.append("JobId: ").append(getJobId()).append(","); if (getJobName() != null) sb.append("JobName: ").append(getJobName()).append(","); if (getCreatedAt() != null) sb.append("CreatedAt: ").append(getCreatedAt()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).append(","); if (getStatusReason() != null) sb.append("StatusReason: ").append(getStatusReason()).append(","); if (getStartedAt() != null) sb.append("StartedAt: ").append(getStartedAt()).append(","); if (getStoppedAt() != null) sb.append("StoppedAt: ").append(getStoppedAt()).append(","); if (getContainer() != null) sb.append("Container: ").append(getContainer()).append(","); if (getArrayProperties() != null) sb.append("ArrayProperties: ").append(getArrayProperties()).append(","); if (getNodeProperties() != null) sb.append("NodeProperties: ").append(getNodeProperties()).append(","); if (getJobDefinition() != null) sb.append("JobDefinition: ").append(getJobDefinition()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof JobSummary == false) return false; JobSummary other = (JobSummary) obj; if (other.getJobArn() == null ^ this.getJobArn() == null) return false; if (other.getJobArn() != null && other.getJobArn().equals(this.getJobArn()) == false) return false; if (other.getJobId() == null ^ this.getJobId() == null) return false; if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false) return false; if (other.getJobName() == null ^ this.getJobName() == null) return false; if (other.getJobName() != null && other.getJobName().equals(this.getJobName()) == false) return false; if (other.getCreatedAt() == null ^ this.getCreatedAt() == null) return false; if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == 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.getStartedAt() == null ^ this.getStartedAt() == null) return false; if (other.getStartedAt() != null && other.getStartedAt().equals(this.getStartedAt()) == false) return false; if (other.getStoppedAt() == null ^ this.getStoppedAt() == null) return false; if (other.getStoppedAt() != null && other.getStoppedAt().equals(this.getStoppedAt()) == false) return false; if (other.getContainer() == null ^ this.getContainer() == null) return false; if (other.getContainer() != null && other.getContainer().equals(this.getContainer()) == false) return false; if (other.getArrayProperties() == null ^ this.getArrayProperties() == null) return false; if (other.getArrayProperties() != null && other.getArrayProperties().equals(this.getArrayProperties()) == false) return false; if (other.getNodeProperties() == null ^ this.getNodeProperties() == null) return false; if (other.getNodeProperties() != null && other.getNodeProperties().equals(this.getNodeProperties()) == false) return false; if (other.getJobDefinition() == null ^ this.getJobDefinition() == null) return false; if (other.getJobDefinition() != null && other.getJobDefinition().equals(this.getJobDefinition()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getJobArn() == null) ? 0 : getJobArn().hashCode()); hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode()); hashCode = prime * hashCode + ((getJobName() == null) ? 0 : getJobName().hashCode()); hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getStatusReason() == null) ? 0 : getStatusReason().hashCode()); hashCode = prime * hashCode + ((getStartedAt() == null) ? 0 : getStartedAt().hashCode()); hashCode = prime * hashCode + ((getStoppedAt() == null) ? 0 : getStoppedAt().hashCode()); hashCode = prime * hashCode + ((getContainer() == null) ? 0 : getContainer().hashCode()); hashCode = prime * hashCode + ((getArrayProperties() == null) ? 0 : getArrayProperties().hashCode()); hashCode = prime * hashCode + ((getNodeProperties() == null) ? 0 : getNodeProperties().hashCode()); hashCode = prime * hashCode + ((getJobDefinition() == null) ? 0 : getJobDefinition().hashCode()); return hashCode; } @Override public JobSummary clone() { try { return (JobSummary) 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.JobSummaryMarshaller.getInstance().marshall(this, protocolMarshaller); } }