/*
 * 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.ecs.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * <p>
 * The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a
 * dependency is defined for container startup, for container shutdown it is reversed.
 * </p>
 * <p>
 * Your Amazon ECS container instances require at least version 1.26.0 of the container agent to use container
 * dependencies. However, we recommend using the latest container agent version. For information about checking your
 * agent version and updating to the latest version, see <a
 * href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html">Updating the Amazon ECS
 * Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you're using an Amazon
 * ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your
 * container instances are launched from version <code>20190301</code> or later, then they contain the required versions
 * of the container agent and <code>ecs-init</code>. For more information, see <a
 * href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux
 * AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.
 * </p>
 * <note>
 * <p>
 * For tasks that use the Fargate launch type, the task or service requires the following platforms:
 * </p>
 * <ul>
 * <li>
 * <p>
 * Linux platform version <code>1.3.0</code> or later.
 * </p>
 * </li>
 * <li>
 * <p>
 * Windows platform version <code>1.0.0</code> or later.
 * </p>
 * </li>
 * </ul>
 * </note>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerDependency" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ContainerDependency implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * The name of a container.
     * </p>
     */
    private String containerName;
    /**
     * <p>
     * The dependency condition of the container. The following are the available conditions and their behavior:
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a
     * dependent container is started before permitting other containers to start.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits) before
     * permitting other containers to start. This can be useful for nonessential containers that run a script and then
     * exit. This condition can't be set on an essential container.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the
     * container exits with a <code>zero</code> status. This condition can't be set on an essential container.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>HEALTHY</code> - This condition validates that the dependent container passes its Docker health check
     * before permitting other containers to start. This requires that the dependent container has health checks
     * configured. This condition is confirmed only at task startup.
     * </p>
     * </li>
     * </ul>
     */
    private String condition;

    /**
     * <p>
     * The name of a container.
     * </p>
     * 
     * @param containerName
     *        The name of a container.
     */

    public void setContainerName(String containerName) {
        this.containerName = containerName;
    }

    /**
     * <p>
     * The name of a container.
     * </p>
     * 
     * @return The name of a container.
     */

    public String getContainerName() {
        return this.containerName;
    }

    /**
     * <p>
     * The name of a container.
     * </p>
     * 
     * @param containerName
     *        The name of a container.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ContainerDependency withContainerName(String containerName) {
        setContainerName(containerName);
        return this;
    }

    /**
     * <p>
     * The dependency condition of the container. The following are the available conditions and their behavior:
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a
     * dependent container is started before permitting other containers to start.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits) before
     * permitting other containers to start. This can be useful for nonessential containers that run a script and then
     * exit. This condition can't be set on an essential container.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the
     * container exits with a <code>zero</code> status. This condition can't be set on an essential container.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>HEALTHY</code> - This condition validates that the dependent container passes its Docker health check
     * before permitting other containers to start. This requires that the dependent container has health checks
     * configured. This condition is confirmed only at task startup.
     * </p>
     * </li>
     * </ul>
     * 
     * @param condition
     *        The dependency condition of the container. The following are the available conditions and their
     *        behavior:</p>
     *        <ul>
     *        <li>
     *        <p>
     *        <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a
     *        dependent container is started before permitting other containers to start.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits)
     *        before permitting other containers to start. This can be useful for nonessential containers that run a
     *        script and then exit. This condition can't be set on an essential container.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the
     *        container exits with a <code>zero</code> status. This condition can't be set on an essential container.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>HEALTHY</code> - This condition validates that the dependent container passes its Docker health
     *        check before permitting other containers to start. This requires that the dependent container has health
     *        checks configured. This condition is confirmed only at task startup.
     *        </p>
     *        </li>
     * @see ContainerCondition
     */

    public void setCondition(String condition) {
        this.condition = condition;
    }

    /**
     * <p>
     * The dependency condition of the container. The following are the available conditions and their behavior:
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a
     * dependent container is started before permitting other containers to start.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits) before
     * permitting other containers to start. This can be useful for nonessential containers that run a script and then
     * exit. This condition can't be set on an essential container.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the
     * container exits with a <code>zero</code> status. This condition can't be set on an essential container.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>HEALTHY</code> - This condition validates that the dependent container passes its Docker health check
     * before permitting other containers to start. This requires that the dependent container has health checks
     * configured. This condition is confirmed only at task startup.
     * </p>
     * </li>
     * </ul>
     * 
     * @return The dependency condition of the container. The following are the available conditions and their
     *         behavior:</p>
     *         <ul>
     *         <li>
     *         <p>
     *         <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a
     *         dependent container is started before permitting other containers to start.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits)
     *         before permitting other containers to start. This can be useful for nonessential containers that run a
     *         script and then exit. This condition can't be set on an essential container.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the
     *         container exits with a <code>zero</code> status. This condition can't be set on an essential container.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>HEALTHY</code> - This condition validates that the dependent container passes its Docker health
     *         check before permitting other containers to start. This requires that the dependent container has health
     *         checks configured. This condition is confirmed only at task startup.
     *         </p>
     *         </li>
     * @see ContainerCondition
     */

    public String getCondition() {
        return this.condition;
    }

    /**
     * <p>
     * The dependency condition of the container. The following are the available conditions and their behavior:
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a
     * dependent container is started before permitting other containers to start.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits) before
     * permitting other containers to start. This can be useful for nonessential containers that run a script and then
     * exit. This condition can't be set on an essential container.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the
     * container exits with a <code>zero</code> status. This condition can't be set on an essential container.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>HEALTHY</code> - This condition validates that the dependent container passes its Docker health check
     * before permitting other containers to start. This requires that the dependent container has health checks
     * configured. This condition is confirmed only at task startup.
     * </p>
     * </li>
     * </ul>
     * 
     * @param condition
     *        The dependency condition of the container. The following are the available conditions and their
     *        behavior:</p>
     *        <ul>
     *        <li>
     *        <p>
     *        <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a
     *        dependent container is started before permitting other containers to start.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits)
     *        before permitting other containers to start. This can be useful for nonessential containers that run a
     *        script and then exit. This condition can't be set on an essential container.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the
     *        container exits with a <code>zero</code> status. This condition can't be set on an essential container.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>HEALTHY</code> - This condition validates that the dependent container passes its Docker health
     *        check before permitting other containers to start. This requires that the dependent container has health
     *        checks configured. This condition is confirmed only at task startup.
     *        </p>
     *        </li>
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see ContainerCondition
     */

    public ContainerDependency withCondition(String condition) {
        setCondition(condition);
        return this;
    }

    /**
     * <p>
     * The dependency condition of the container. The following are the available conditions and their behavior:
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a
     * dependent container is started before permitting other containers to start.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits) before
     * permitting other containers to start. This can be useful for nonessential containers that run a script and then
     * exit. This condition can't be set on an essential container.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the
     * container exits with a <code>zero</code> status. This condition can't be set on an essential container.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>HEALTHY</code> - This condition validates that the dependent container passes its Docker health check
     * before permitting other containers to start. This requires that the dependent container has health checks
     * configured. This condition is confirmed only at task startup.
     * </p>
     * </li>
     * </ul>
     * 
     * @param condition
     *        The dependency condition of the container. The following are the available conditions and their
     *        behavior:</p>
     *        <ul>
     *        <li>
     *        <p>
     *        <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a
     *        dependent container is started before permitting other containers to start.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits)
     *        before permitting other containers to start. This can be useful for nonessential containers that run a
     *        script and then exit. This condition can't be set on an essential container.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the
     *        container exits with a <code>zero</code> status. This condition can't be set on an essential container.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>HEALTHY</code> - This condition validates that the dependent container passes its Docker health
     *        check before permitting other containers to start. This requires that the dependent container has health
     *        checks configured. This condition is confirmed only at task startup.
     *        </p>
     *        </li>
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see ContainerCondition
     */

    public ContainerDependency withCondition(ContainerCondition condition) {
        this.condition = condition.toString();
        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 (getContainerName() != null)
            sb.append("ContainerName: ").append(getContainerName()).append(",");
        if (getCondition() != null)
            sb.append("Condition: ").append(getCondition());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof ContainerDependency == false)
            return false;
        ContainerDependency other = (ContainerDependency) obj;
        if (other.getContainerName() == null ^ this.getContainerName() == null)
            return false;
        if (other.getContainerName() != null && other.getContainerName().equals(this.getContainerName()) == false)
            return false;
        if (other.getCondition() == null ^ this.getCondition() == null)
            return false;
        if (other.getCondition() != null && other.getCondition().equals(this.getCondition()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getContainerName() == null) ? 0 : getContainerName().hashCode());
        hashCode = prime * hashCode + ((getCondition() == null) ? 0 : getCondition().hashCode());
        return hashCode;
    }

    @Override
    public ContainerDependency clone() {
        try {
            return (ContainerDependency) 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.ecs.model.transform.ContainerDependencyMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}
