/* * 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; /** *

* The details for container properties that are returned by DescribeJobs for jobs that use Amazon EKS. *

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

* The name of the container. If the name isn't specified, the default name "Default" is used. Each * container in a pod must have a unique name. *

*/ private String name; /** *

* The Docker image used to start the container. *

*/ private String image; /** *

* The image pull policy for the container. Supported values are Always, IfNotPresent, and * Never. This parameter defaults to Always if the :latest tag is specified, * IfNotPresent otherwise. For more information, see Updating images in the * Kubernetes documentation. *

*/ private String imagePullPolicy; /** *

* The entrypoint for the container. For more information, see Entrypoint * in the Kubernetes documentation. *

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

* An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is * used. This corresponds to the args member in the Entrypoint * portion of the Pod * in Kubernetes. Environment variable references are expanded using the container's environment. *

* If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if * the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the * command string will remain "$(NAME1)". $$ is replaced with $ and the * resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) * whether or not the VAR_NAME environment variable exists. For more information, see CMD in the Dockerfile reference and Define a * command and arguments for a pod in the Kubernetes documentation. *

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

* The environment variables to pass to a container. *

* *

* Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for * variables that Batch sets. *

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

* The type and amount of resources to assign to a container. The supported resources include memory, * cpu, and nvidia.com/gpu. For more information, see Resource management for * pods and containers in the Kubernetes documentation. *

*/ private EksContainerResourceRequirements resources; /** *

* The exit code for the job attempt. A non-zero exit code is considered failed. *

*/ private Integer exitCode; /** *

* A short human-readable string to provide additional details for a running or stopped container. It can be up to * 255 characters long. *

*/ private String reason; /** *

* The volume mounts for the container. Batch supports emptyDir, hostPath, and * secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation. *

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

* The security context for a job. For more information, see Configure a security context * for a pod or container in the Kubernetes documentation. *

*/ private EksContainerSecurityContext securityContext; /** *

* The name of the container. If the name isn't specified, the default name "Default" is used. Each * container in a pod must have a unique name. *

* * @param name * The name of the container. If the name isn't specified, the default name "Default" is used. * Each container in a pod must have a unique name. */ public void setName(String name) { this.name = name; } /** *

* The name of the container. If the name isn't specified, the default name "Default" is used. Each * container in a pod must have a unique name. *

* * @return The name of the container. If the name isn't specified, the default name "Default" is used. * Each container in a pod must have a unique name. */ public String getName() { return this.name; } /** *

* The name of the container. If the name isn't specified, the default name "Default" is used. Each * container in a pod must have a unique name. *

* * @param name * The name of the container. If the name isn't specified, the default name "Default" is used. * Each container in a pod must have a unique name. * @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withName(String name) { setName(name); return this; } /** *

* The Docker image used to start the container. *

* * @param image * The Docker image used to start the container. */ public void setImage(String image) { this.image = image; } /** *

* The Docker image used to start the container. *

* * @return The Docker image used to start the container. */ public String getImage() { return this.image; } /** *

* The Docker image used to start the container. *

* * @param image * The Docker image used to start the container. * @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withImage(String image) { setImage(image); return this; } /** *

* * @param imagePullPolicy * The image pull policy for the container. Supported values are Always, * IfNotPresent, and Never. This parameter defaults to Always if the * :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the * Kubernetes documentation. */ public void setImagePullPolicy(String imagePullPolicy) { this.imagePullPolicy = imagePullPolicy; } /** *

* * @return The image pull policy for the container. Supported values are Always, * IfNotPresent, and Never. This parameter defaults to Always if the * :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the * Kubernetes documentation. */ public String getImagePullPolicy() { return this.imagePullPolicy; } /** *

* * @param imagePullPolicy * The image pull policy for the container. Supported values are Always, * IfNotPresent, and Never. This parameter defaults to Always if the * :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the * Kubernetes documentation. * @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withImagePullPolicy(String imagePullPolicy) { setImagePullPolicy(imagePullPolicy); return this; } /** *

* The entrypoint for the container. For more information, see Entrypoint * in the Kubernetes documentation. *

* * @return The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation. */ public java.util.List getCommand() { return command; } /** *

* The entrypoint for the container. For more information, see Entrypoint * in the Kubernetes documentation. *

* * @param command * The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation. */ public void setCommand(java.util.Collection command) { if (command == null) { this.command = null; return; } this.command = new java.util.ArrayList(command); } /** *

* The entrypoint for the container. For more information, see Entrypoint * in the Kubernetes documentation. *

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

* * @param command * The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation. * @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withCommand(String... command) { if (this.command == null) { setCommand(new java.util.ArrayList(command.length)); } for (String ele : command) { this.command.add(ele); } return this; } /** *

* The entrypoint for the container. For more information, see Entrypoint * in the Kubernetes documentation. *

* * @param command * The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation. * @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withCommand(java.util.Collection command) { setCommand(command); return this; } /** *

* * @return An array of arguments to the entrypoint. If this isn't specified, the CMD of the container * image is used. This corresponds to the args member in the Entrypoint portion of the Pod in * Kubernetes. Environment variable references are expanded using the container's environment.

* If the referenced environment variable doesn't exist, the reference in the command isn't changed. For * example, if the reference is to "$(NAME1)" and the NAME1 environment variable * doesn't exist, the command string will remain "$(NAME1)". $$ is replaced with * $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed * as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For * more information, see CMD in the * Dockerfile reference and Define * a command and arguments for a pod in the Kubernetes documentation. */ public java.util.List getArgs() { return args; } /** *

* * @param args * An array of arguments to the entrypoint. If this isn't specified, the CMD of the container * image is used. This corresponds to the args member in the Entrypoint portion of the Pod in * Kubernetes. Environment variable references are expanded using the container's environment.

* If the referenced environment variable doesn't exist, the reference in the command isn't changed. For * example, if the reference is to "$(NAME1)" and the NAME1 environment variable * doesn't exist, the command string will remain "$(NAME1)". $$ is replaced with * $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed * as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more * information, see CMD in the * Dockerfile reference and Define * a command and arguments for a pod in the Kubernetes documentation. */ public void setArgs(java.util.Collection args) { if (args == null) { this.args = null; return; } this.args = new java.util.ArrayList(args); } /** *

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

* If the referenced environment variable doesn't exist, the reference in the command isn't changed. For * example, if the reference is to "$(NAME1)" and the NAME1 environment variable * doesn't exist, the command string will remain "$(NAME1)". $$ is replaced with * $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed * as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more * information, see CMD in the * Dockerfile reference and Define * a command and arguments for a pod in the Kubernetes documentation. * @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withArgs(String... args) { if (this.args == null) { setArgs(new java.util.ArrayList(args.length)); } for (String ele : args) { this.args.add(ele); } return this; } /** *

* If the referenced environment variable doesn't exist, the reference in the command isn't changed. For * example, if the reference is to "$(NAME1)" and the NAME1 environment variable * doesn't exist, the command string will remain "$(NAME1)". $$ is replaced with * $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed * as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more * information, see CMD in the * Dockerfile reference and Define * a command and arguments for a pod in the Kubernetes documentation. * @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withArgs(java.util.Collection args) { setArgs(args); return this; } /** *

* The environment variables to pass to a container. *

* *

* Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for * variables that Batch sets. *

* * * @return The environment variables to pass to a container.

* Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for * variables that Batch sets. *

*/ public java.util.List getEnv() { return env; } /** *

* The environment variables to pass to a container. *

* *

* Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for * variables that Batch sets. *

* * * @param env * The environment variables to pass to a container.

* Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for * variables that Batch sets. *

*/ public void setEnv(java.util.Collection env) { if (env == null) { this.env = null; return; } this.env = new java.util.ArrayList(env); } /** *

* The environment variables to pass to a container. *

* *

* Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for * variables that Batch sets. *

* *

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

* * @param env * The environment variables to pass to a container.

* Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for * variables that Batch sets. *

* @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withEnv(EksContainerEnvironmentVariable... env) { if (this.env == null) { setEnv(new java.util.ArrayList(env.length)); } for (EksContainerEnvironmentVariable ele : env) { this.env.add(ele); } return this; } /** *

* The environment variables to pass to a container. *

* *

* Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for * variables that Batch sets. *

* * * @param env * The environment variables to pass to a container.

* Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for * variables that Batch sets. *

* @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withEnv(java.util.Collection env) { setEnv(env); return this; } /** *

* * @param resources * The type and amount of resources to assign to a container. The supported resources include * memory, cpu, and nvidia.com/gpu. For more information, see Resource management * for pods and containers in the Kubernetes documentation. */ public void setResources(EksContainerResourceRequirements resources) { this.resources = resources; } /** *

* * @return The type and amount of resources to assign to a container. The supported resources include * memory, cpu, and nvidia.com/gpu. For more information, see Resource management * for pods and containers in the Kubernetes documentation. */ public EksContainerResourceRequirements getResources() { return this.resources; } /** *

* * @param resources * The type and amount of resources to assign to a container. The supported resources include * memory, cpu, and nvidia.com/gpu. For more information, see Resource management * for pods and containers in the Kubernetes documentation. * @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withResources(EksContainerResourceRequirements resources) { setResources(resources); 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 EksContainerDetail withExitCode(Integer exitCode) { setExitCode(exitCode); return this; } /** *

* A short human-readable string to provide additional details for a running or stopped container. It can be up to * 255 characters long. *

* * @param reason * A short human-readable string to provide additional details for a running or stopped container. It can be * up to 255 characters long. */ public void setReason(String reason) { this.reason = reason; } /** *

* A short human-readable string to provide additional details for a running or stopped container. It can be up to * 255 characters long. *

* * @return A short human-readable string to provide additional details for a running or stopped container. It can be * up to 255 characters long. */ public String getReason() { return this.reason; } /** *

* A short human-readable string to provide additional details for a running or stopped container. It can be up to * 255 characters long. *

* * @param reason * A short human-readable string to provide additional details for a running or stopped container. It can be * up to 255 characters long. * @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withReason(String reason) { setReason(reason); return this; } /** *

* * @return The volume mounts for the container. Batch supports emptyDir, hostPath, and * secret volume types. For more information about volumes and volume mounts in Kubernetes, see * Volumes in the Kubernetes * documentation. */ public java.util.List getVolumeMounts() { return volumeMounts; } /** *

* * @param volumeMounts * The volume mounts for the container. Batch supports emptyDir, hostPath, and * secret volume types. For more information about volumes and volume mounts in Kubernetes, see * Volumes in the Kubernetes * documentation. */ public void setVolumeMounts(java.util.Collection volumeMounts) { if (volumeMounts == null) { this.volumeMounts = null; return; } this.volumeMounts = new java.util.ArrayList(volumeMounts); } /** *

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

* * @param volumeMounts * The volume mounts for the container. Batch supports emptyDir, hostPath, and * secret volume types. For more information about volumes and volume mounts in Kubernetes, see * Volumes in the Kubernetes * documentation. * @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withVolumeMounts(EksContainerVolumeMount... volumeMounts) { if (this.volumeMounts == null) { setVolumeMounts(new java.util.ArrayList(volumeMounts.length)); } for (EksContainerVolumeMount ele : volumeMounts) { this.volumeMounts.add(ele); } return this; } /** *

* * @param volumeMounts * The volume mounts for the container. Batch supports emptyDir, hostPath, and * secret volume types. For more information about volumes and volume mounts in Kubernetes, see * Volumes in the Kubernetes * documentation. * @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withVolumeMounts(java.util.Collection volumeMounts) { setVolumeMounts(volumeMounts); return this; } /** *

* The security context for a job. For more information, see Configure a security context * for a pod or container in the Kubernetes documentation. *

* * @param securityContext * The security context for a job. For more information, see Configure a security * context for a pod or container in the Kubernetes documentation. */ public void setSecurityContext(EksContainerSecurityContext securityContext) { this.securityContext = securityContext; } /** *

* The security context for a job. For more information, see Configure a security context * for a pod or container in the Kubernetes documentation. *

* * @return The security context for a job. For more information, see Configure a security * context for a pod or container in the Kubernetes documentation. */ public EksContainerSecurityContext getSecurityContext() { return this.securityContext; } /** *

* The security context for a job. For more information, see Configure a security context * for a pod or container in the Kubernetes documentation. *

* * @param securityContext * The security context for a job. For more information, see Configure a security * context for a pod or container in the Kubernetes documentation. * @return Returns a reference to this object so that method calls can be chained together. */ public EksContainerDetail withSecurityContext(EksContainerSecurityContext securityContext) { setSecurityContext(securityContext); 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 (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getImage() != null) sb.append("Image: ").append(getImage()).append(","); if (getImagePullPolicy() != null) sb.append("ImagePullPolicy: ").append(getImagePullPolicy()).append(","); if (getCommand() != null) sb.append("Command: ").append(getCommand()).append(","); if (getArgs() != null) sb.append("Args: ").append(getArgs()).append(","); if (getEnv() != null) sb.append("Env: ").append(getEnv()).append(","); if (getResources() != null) sb.append("Resources: ").append(getResources()).append(","); if (getExitCode() != null) sb.append("ExitCode: ").append(getExitCode()).append(","); if (getReason() != null) sb.append("Reason: ").append(getReason()).append(","); if (getVolumeMounts() != null) sb.append("VolumeMounts: ").append(getVolumeMounts()).append(","); if (getSecurityContext() != null) sb.append("SecurityContext: ").append(getSecurityContext()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof EksContainerDetail == false) return false; EksContainerDetail other = (EksContainerDetail) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getImage() == null ^ this.getImage() == null) return false; if (other.getImage() != null && other.getImage().equals(this.getImage()) == false) return false; if (other.getImagePullPolicy() == null ^ this.getImagePullPolicy() == null) return false; if (other.getImagePullPolicy() != null && other.getImagePullPolicy().equals(this.getImagePullPolicy()) == false) return false; if (other.getCommand() == null ^ this.getCommand() == null) return false; if (other.getCommand() != null && other.getCommand().equals(this.getCommand()) == false) return false; if (other.getArgs() == null ^ this.getArgs() == null) return false; if (other.getArgs() != null && other.getArgs().equals(this.getArgs()) == false) return false; if (other.getEnv() == null ^ this.getEnv() == null) return false; if (other.getEnv() != null && other.getEnv().equals(this.getEnv()) == false) return false; if (other.getResources() == null ^ this.getResources() == null) return false; if (other.getResources() != null && other.getResources().equals(this.getResources()) == 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.getVolumeMounts() == null ^ this.getVolumeMounts() == null) return false; if (other.getVolumeMounts() != null && other.getVolumeMounts().equals(this.getVolumeMounts()) == false) return false; if (other.getSecurityContext() == null ^ this.getSecurityContext() == null) return false; if (other.getSecurityContext() != null && other.getSecurityContext().equals(this.getSecurityContext()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getImage() == null) ? 0 : getImage().hashCode()); hashCode = prime * hashCode + ((getImagePullPolicy() == null) ? 0 : getImagePullPolicy().hashCode()); hashCode = prime * hashCode + ((getCommand() == null) ? 0 : getCommand().hashCode()); hashCode = prime * hashCode + ((getArgs() == null) ? 0 : getArgs().hashCode()); hashCode = prime * hashCode + ((getEnv() == null) ? 0 : getEnv().hashCode()); hashCode = prime * hashCode + ((getResources() == null) ? 0 : getResources().hashCode()); hashCode = prime * hashCode + ((getExitCode() == null) ? 0 : getExitCode().hashCode()); hashCode = prime * hashCode + ((getReason() == null) ? 0 : getReason().hashCode()); hashCode = prime * hashCode + ((getVolumeMounts() == null) ? 0 : getVolumeMounts().hashCode()); hashCode = prime * hashCode + ((getSecurityContext() == null) ? 0 : getSecurityContext().hashCode()); return hashCode; } @Override public EksContainerDetail clone() { try { return (EksContainerDetail) 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.EksContainerDetailMarshaller.getInstance().marshall(this, protocolMarshaller); } }