com.amazonaws.services.batch.model.AttemptContainerDetail Maven / Gradle / Ivy
Show all versions of aws-java-sdk-batch Show documentation
/*
* Copyright 2019-2024 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 of a container that's part of a job attempt.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AttemptContainerDetail implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
*
*/
private String containerInstanceArn;
/**
*
* The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container
* attempt receives a task ARN when they reach the STARTING status.
*
*/
private String taskArn;
/**
*
* The exit code for the job attempt. A non-zero exit code is considered failed.
*
*/
private Integer exitCode;
/**
*
* A short (255 max characters) human-readable string to provide additional details for a running or stopped
* container.
*
*/
private String reason;
/**
*
* The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is
* /aws/batch/job. Each container attempt receives a log stream name when they reach the
* RUNNING status.
*
*/
private String logStreamName;
/**
*
* The network interfaces that are associated with the job attempt.
*
*/
private java.util.List networkInterfaces;
/**
*
* The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
*
*
* @param containerInstanceArn
* The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
*/
public void setContainerInstanceArn(String containerInstanceArn) {
this.containerInstanceArn = containerInstanceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
*
*
* @return The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
*/
public String getContainerInstanceArn() {
return this.containerInstanceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
*
*
* @param containerInstanceArn
* The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AttemptContainerDetail withContainerInstanceArn(String containerInstanceArn) {
setContainerInstanceArn(containerInstanceArn);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container
* attempt receives a task ARN when they reach the STARTING status.
*
*
* @param taskArn
* The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each
* container attempt receives a task ARN when they reach the STARTING status.
*/
public void setTaskArn(String taskArn) {
this.taskArn = taskArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container
* attempt receives a task ARN when they reach the STARTING status.
*
*
* @return The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each
* container attempt receives a task ARN when they reach the STARTING status.
*/
public String getTaskArn() {
return this.taskArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container
* attempt receives a task ARN when they reach the STARTING status.
*
*
* @param taskArn
* The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each
* container attempt receives a task ARN when they reach the STARTING status.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AttemptContainerDetail withTaskArn(String taskArn) {
setTaskArn(taskArn);
return this;
}
/**
*
* The exit code for the job attempt. A non-zero exit code is considered failed.
*
*
* @param exitCode
* The exit code for the job attempt. A non-zero exit code is considered failed.
*/
public void setExitCode(Integer exitCode) {
this.exitCode = exitCode;
}
/**
*
* The exit code for the job attempt. A non-zero exit code is considered failed.
*
*
* @return The exit code for the job attempt. A non-zero exit code is considered failed.
*/
public Integer getExitCode() {
return this.exitCode;
}
/**
*
* The exit code for the job attempt. A non-zero exit code is considered failed.
*
*
* @param exitCode
* The exit code for the job attempt. A non-zero exit code is considered failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AttemptContainerDetail withExitCode(Integer exitCode) {
setExitCode(exitCode);
return this;
}
/**
*
* A short (255 max characters) human-readable string to provide additional details for a running or stopped
* container.
*
*
* @param reason
* A short (255 max characters) human-readable string to provide additional details for a running or stopped
* container.
*/
public void setReason(String reason) {
this.reason = reason;
}
/**
*
* A short (255 max characters) human-readable string to provide additional details for a running or stopped
* container.
*
*
* @return A short (255 max characters) human-readable string to provide additional details for a running or stopped
* container.
*/
public String getReason() {
return this.reason;
}
/**
*
* A short (255 max characters) human-readable string to provide additional details for a running or stopped
* container.
*
*
* @param reason
* A short (255 max characters) human-readable string to provide additional details for a running or stopped
* container.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AttemptContainerDetail withReason(String reason) {
setReason(reason);
return this;
}
/**
*
* The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is
* /aws/batch/job. Each container attempt receives a log stream name when they reach the
* RUNNING status.
*
*
* @param logStreamName
* The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch
* jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the
* RUNNING status.
*/
public void setLogStreamName(String logStreamName) {
this.logStreamName = logStreamName;
}
/**
*
* The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is
* /aws/batch/job. Each container attempt receives a log stream name when they reach the
* RUNNING status.
*
*
* @return The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch
* jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach
* the RUNNING status.
*/
public String getLogStreamName() {
return this.logStreamName;
}
/**
*
* The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is
* /aws/batch/job. Each container attempt receives a log stream name when they reach the
* RUNNING status.
*
*
* @param logStreamName
* The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch
* jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the
* RUNNING status.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AttemptContainerDetail withLogStreamName(String logStreamName) {
setLogStreamName(logStreamName);
return this;
}
/**
*
* The network interfaces that are associated with the job attempt.
*
*
* @return The network interfaces that are associated with the job attempt.
*/
public java.util.List getNetworkInterfaces() {
return networkInterfaces;
}
/**
*
* The network interfaces that are associated with the job attempt.
*
*
* @param networkInterfaces
* The network interfaces that are associated with the job attempt.
*/
public void setNetworkInterfaces(java.util.Collection networkInterfaces) {
if (networkInterfaces == null) {
this.networkInterfaces = null;
return;
}
this.networkInterfaces = new java.util.ArrayList(networkInterfaces);
}
/**
*
* The network interfaces that are associated with the job attempt.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setNetworkInterfaces(java.util.Collection)} or {@link #withNetworkInterfaces(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param networkInterfaces
* The network interfaces that are associated with the job attempt.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AttemptContainerDetail withNetworkInterfaces(NetworkInterface... networkInterfaces) {
if (this.networkInterfaces == null) {
setNetworkInterfaces(new java.util.ArrayList(networkInterfaces.length));
}
for (NetworkInterface ele : networkInterfaces) {
this.networkInterfaces.add(ele);
}
return this;
}
/**
*
* The network interfaces that are associated with the job attempt.
*
*
* @param networkInterfaces
* The network interfaces that are associated with the job attempt.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AttemptContainerDetail withNetworkInterfaces(java.util.Collection networkInterfaces) {
setNetworkInterfaces(networkInterfaces);
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 (getContainerInstanceArn() != null)
sb.append("ContainerInstanceArn: ").append(getContainerInstanceArn()).append(",");
if (getTaskArn() != null)
sb.append("TaskArn: ").append(getTaskArn()).append(",");
if (getExitCode() != null)
sb.append("ExitCode: ").append(getExitCode()).append(",");
if (getReason() != null)
sb.append("Reason: ").append(getReason()).append(",");
if (getLogStreamName() != null)
sb.append("LogStreamName: ").append(getLogStreamName()).append(",");
if (getNetworkInterfaces() != null)
sb.append("NetworkInterfaces: ").append(getNetworkInterfaces());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AttemptContainerDetail == false)
return false;
AttemptContainerDetail other = (AttemptContainerDetail) obj;
if (other.getContainerInstanceArn() == null ^ this.getContainerInstanceArn() == null)
return false;
if (other.getContainerInstanceArn() != null && other.getContainerInstanceArn().equals(this.getContainerInstanceArn()) == false)
return false;
if (other.getTaskArn() == null ^ this.getTaskArn() == null)
return false;
if (other.getTaskArn() != null && other.getTaskArn().equals(this.getTaskArn()) == false)
return false;
if (other.getExitCode() == null ^ this.getExitCode() == null)
return false;
if (other.getExitCode() != null && other.getExitCode().equals(this.getExitCode()) == false)
return false;
if (other.getReason() == null ^ this.getReason() == null)
return false;
if (other.getReason() != null && other.getReason().equals(this.getReason()) == false)
return false;
if (other.getLogStreamName() == null ^ this.getLogStreamName() == null)
return false;
if (other.getLogStreamName() != null && other.getLogStreamName().equals(this.getLogStreamName()) == false)
return false;
if (other.getNetworkInterfaces() == null ^ this.getNetworkInterfaces() == null)
return false;
if (other.getNetworkInterfaces() != null && other.getNetworkInterfaces().equals(this.getNetworkInterfaces()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getContainerInstanceArn() == null) ? 0 : getContainerInstanceArn().hashCode());
hashCode = prime * hashCode + ((getTaskArn() == null) ? 0 : getTaskArn().hashCode());
hashCode = prime * hashCode + ((getExitCode() == null) ? 0 : getExitCode().hashCode());
hashCode = prime * hashCode + ((getReason() == null) ? 0 : getReason().hashCode());
hashCode = prime * hashCode + ((getLogStreamName() == null) ? 0 : getLogStreamName().hashCode());
hashCode = prime * hashCode + ((getNetworkInterfaces() == null) ? 0 : getNetworkInterfaces().hashCode());
return hashCode;
}
@Override
public AttemptContainerDetail clone() {
try {
return (AttemptContainerDetail) 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.AttemptContainerDetailMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}