com.amazonaws.services.elasticloadbalancing.model.InstanceState Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
 * Copyright 2010-2016 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.elasticloadbalancing.model;
import java.io.Serializable;
/**
 * 
 * Information about the state of a back-end instance.
 * 
 */
public class InstanceState implements Serializable, Cloneable {
    /**
     * 
     * The ID of the instance.
     * 
     */
    private String instanceId;
    /**
     * 
     * The current state of the instance.
     * 
     * 
     * Valid values: InService | OutOfService |
     * Unknown
     * 
     */
    private String state;
    /**
     * 
     * Information about the cause of OutOfService instances.
     * Specifically, whether the cause is Elastic Load Balancing or the
     * instance.
     * 
     * 
     * Valid values: ELB | Instance | N/A
     * 
     */
    private String reasonCode;
    /**
     * 
     * A description of the instance state. This string can contain one or more
     * of the following messages.
     * 
     * 
     * - 
     * 
     * N/A
     * 
     *  
     * - 
     * 
     * A transient error occurred. Please try again later.
     * 
     *  
     * - 
     * 
     * Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
     * 
     *  
     * - 
     * 
     * Instance has not passed the configured HealthyThreshold number of health checks consecutively.
     * 
     *  
     * - 
     * 
     * Instance registration is still in progress.
     * 
     *  
     * - 
     * 
     * Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.
     * 
     *  
     * - 
     * 
     * Instance is not currently registered with the LoadBalancer.
     * 
     *  
     * - 
     * 
     * Instance deregistration currently in progress.
     * 
     *  
     * - 
     * 
     * Disable Availability Zone is currently in progress.
     * 
     *  
     * - 
     * 
     * Instance is in pending state.
     * 
     *  
     * - 
     * 
     * Instance is in stopped state.
     * 
     *  
     * - 
     * 
     * Instance is in terminated state.
     * 
     *  
     * 
     */
    private String description;
    /**
     * 
     * The ID of the instance.
     * 
     * 
     * @param instanceId
     *        The ID of the instance.
     */
    public void setInstanceId(String instanceId) {
        this.instanceId = instanceId;
    }
    /**
     * 
     * The ID of the instance.
     * 
     * 
     * @return The ID of the instance.
     */
    public String getInstanceId() {
        return this.instanceId;
    }
    /**
     * 
     * The ID of the instance.
     * 
     * 
     * @param instanceId
     *        The ID of the instance.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceState withInstanceId(String instanceId) {
        setInstanceId(instanceId);
        return this;
    }
    /**
     * 
     * The current state of the instance.
     * 
     * 
     * Valid values: InService | OutOfService |
     * Unknown
     * 
     * 
     * @param state
     *        The current state of the instance.
     *        
     *        Valid values: InService | OutOfService |
     *        Unknown
     */
    public void setState(String state) {
        this.state = state;
    }
    /**
     * 
     * The current state of the instance.
     * 
     * 
     * Valid values: InService | OutOfService |
     * Unknown
     * 
     * 
     * @return The current state of the instance.
     *         
     *         Valid values: InService | OutOfService
     *         | Unknown
     */
    public String getState() {
        return this.state;
    }
    /**
     * 
     * The current state of the instance.
     * 
     * 
     * Valid values: InService | OutOfService |
     * Unknown
     * 
     * 
     * @param state
     *        The current state of the instance.
     *        
     *        Valid values: InService | OutOfService |
     *        Unknown
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceState withState(String state) {
        setState(state);
        return this;
    }
    /**
     * 
     * Information about the cause of OutOfService instances.
     * Specifically, whether the cause is Elastic Load Balancing or the
     * instance.
     * 
     * 
     * Valid values: ELB | Instance | N/A
     * 
     * 
     * @param reasonCode
     *        Information about the cause of OutOfService
     *        instances. Specifically, whether the cause is Elastic Load
     *        Balancing or the instance.
     *        
     *        Valid values: ELB | Instance |
     *        N/A
     */
    public void setReasonCode(String reasonCode) {
        this.reasonCode = reasonCode;
    }
    /**
     * 
     * Information about the cause of OutOfService instances.
     * Specifically, whether the cause is Elastic Load Balancing or the
     * instance.
     * 
     * 
     * Valid values: ELB | Instance | N/A
     * 
     * 
     * @return Information about the cause of OutOfService
     *         instances. Specifically, whether the cause is Elastic Load
     *         Balancing or the instance.
     *         
     *         Valid values: ELB | Instance |
     *         N/A
     */
    public String getReasonCode() {
        return this.reasonCode;
    }
    /**
     * 
     * Information about the cause of OutOfService instances.
     * Specifically, whether the cause is Elastic Load Balancing or the
     * instance.
     * 
     * 
     * Valid values: ELB | Instance | N/A
     * 
     * 
     * @param reasonCode
     *        Information about the cause of OutOfService
     *        instances. Specifically, whether the cause is Elastic Load
     *        Balancing or the instance.
     *        
     *        Valid values: ELB | Instance |
     *        N/A
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceState withReasonCode(String reasonCode) {
        setReasonCode(reasonCode);
        return this;
    }
    /**
     * 
     * A description of the instance state. This string can contain one or more
     * of the following messages.
     * 
     * 
     * - 
     * 
     * N/A
     * 
     *  
     * - 
     * 
     * A transient error occurred. Please try again later.
     * 
     *  
     * - 
     * 
     * Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
     * 
     *  
     * - 
     * 
     * Instance has not passed the configured HealthyThreshold number of health checks consecutively.
     * 
     *  
     * - 
     * 
     * Instance registration is still in progress.
     * 
     *  
     * - 
     * 
     * Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.
     * 
     *  
     * - 
     * 
     * Instance is not currently registered with the LoadBalancer.
     * 
     *  
     * - 
     * 
     * Instance deregistration currently in progress.
     * 
     *  
     * - 
     * 
     * Disable Availability Zone is currently in progress.
     * 
     *  
     * - 
     * 
     * Instance is in pending state.
     * 
     *  
     * - 
     * 
     * Instance is in stopped state.
     * 
     *  
     * - 
     * 
     * Instance is in terminated state.
     * 
     *  
     * 
     * 
     * @param description
     *        A description of the instance state. This string can contain one
     *        or more of the following messages.
     *        
     *        - 
     *        
     *        N/A
     *        
     *         
     *        - 
     *        
     *        A transient error occurred. Please try again later.
     *        
     *         
     *        - 
     *        
     *        Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
     *        
     *         
     *        - 
     *        
     *        Instance has not passed the configured HealthyThreshold number of health checks consecutively.
     *        
     *         
     *        - 
     *        
     *        Instance registration is still in progress.
     *        
     *         
     *        - 
     *        
     *        Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.
     *        
     *         
     *        - 
     *        
     *        Instance is not currently registered with the LoadBalancer.
     *        
     *         
     *        - 
     *        
     *        Instance deregistration currently in progress.
     *        
     *         
     *        - 
     *        
     *        Disable Availability Zone is currently in progress.
     *        
     *         
     *        - 
     *        
     *        Instance is in pending state.
     *        
     *         
     *        - 
     *        
     *        Instance is in stopped state.
     *        
     *         
     *        - 
     *        
     *        Instance is in terminated state.
     *        
     *         
     */
    public void setDescription(String description) {
        this.description = description;
    }
    /**
     * 
     * A description of the instance state. This string can contain one or more
     * of the following messages.
     * 
     * 
     * - 
     * 
     * N/A
     * 
     *  
     * - 
     * 
     * A transient error occurred. Please try again later.
     * 
     *  
     * - 
     * 
     * Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
     * 
     *  
     * - 
     * 
     * Instance has not passed the configured HealthyThreshold number of health checks consecutively.
     * 
     *  
     * - 
     * 
     * Instance registration is still in progress.
     * 
     *  
     * - 
     * 
     * Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.
     * 
     *  
     * - 
     * 
     * Instance is not currently registered with the LoadBalancer.
     * 
     *  
     * - 
     * 
     * Instance deregistration currently in progress.
     * 
     *  
     * - 
     * 
     * Disable Availability Zone is currently in progress.
     * 
     *  
     * - 
     * 
     * Instance is in pending state.
     * 
     *  
     * - 
     * 
     * Instance is in stopped state.
     * 
     *  
     * - 
     * 
     * Instance is in terminated state.
     * 
     *  
     * 
     * 
     * @return A description of the instance state. This string can contain one
     *         or more of the following messages.
     *         
     *         - 
     *         
     *         N/A
     *         
     *          
     *         - 
     *         
     *         A transient error occurred. Please try again later.
     *         
     *          
     *         - 
     *         
     *         Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
     *         
     *          
     *         - 
     *         
     *         Instance has not passed the configured HealthyThreshold number of health checks consecutively.
     *         
     *          
     *         - 
     *         
     *         Instance registration is still in progress.
     *         
     *          
     *         - 
     *         
     *         Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.
     *         
     *          
     *         - 
     *         
     *         Instance is not currently registered with the LoadBalancer.
     *         
     *          
     *         - 
     *         
     *         Instance deregistration currently in progress.
     *         
     *          
     *         - 
     *         
     *         Disable Availability Zone is currently in progress.
     *         
     *          
     *         - 
     *         
     *         Instance is in pending state.
     *         
     *          
     *         - 
     *         
     *         Instance is in stopped state.
     *         
     *          
     *         - 
     *         
     *         Instance is in terminated state.
     *         
     *          
     */
    public String getDescription() {
        return this.description;
    }
    /**
     * 
     * A description of the instance state. This string can contain one or more
     * of the following messages.
     * 
     * 
     * - 
     * 
     * N/A
     * 
     *  
     * - 
     * 
     * A transient error occurred. Please try again later.
     * 
     *  
     * - 
     * 
     * Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
     * 
     *  
     * - 
     * 
     * Instance has not passed the configured HealthyThreshold number of health checks consecutively.
     * 
     *  
     * - 
     * 
     * Instance registration is still in progress.
     * 
     *  
     * - 
     * 
     * Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.
     * 
     *  
     * - 
     * 
     * Instance is not currently registered with the LoadBalancer.
     * 
     *  
     * - 
     * 
     * Instance deregistration currently in progress.
     * 
     *  
     * - 
     * 
     * Disable Availability Zone is currently in progress.
     * 
     *  
     * - 
     * 
     * Instance is in pending state.
     * 
     *  
     * - 
     * 
     * Instance is in stopped state.
     * 
     *  
     * - 
     * 
     * Instance is in terminated state.
     * 
     *  
     * 
     * 
     * @param description
     *        A description of the instance state. This string can contain one
     *        or more of the following messages.
     *        
     *        - 
     *        
     *        N/A
     *        
     *         
     *        - 
     *        
     *        A transient error occurred. Please try again later.
     *        
     *         
     *        - 
     *        
     *        Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
     *        
     *         
     *        - 
     *        
     *        Instance has not passed the configured HealthyThreshold number of health checks consecutively.
     *        
     *         
     *        - 
     *        
     *        Instance registration is still in progress.
     *        
     *         
     *        - 
     *        
     *        Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.
     *        
     *         
     *        - 
     *        
     *        Instance is not currently registered with the LoadBalancer.
     *        
     *         
     *        - 
     *        
     *        Instance deregistration currently in progress.
     *        
     *         
     *        - 
     *        
     *        Disable Availability Zone is currently in progress.
     *        
     *         
     *        - 
     *        
     *        Instance is in pending state.
     *        
     *         
     *        - 
     *        
     *        Instance is in stopped state.
     *        
     *         
     *        - 
     *        
     *        Instance is in terminated state.
     *        
     *         
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceState withDescription(String description) {
        setDescription(description);
        return this;
    }
    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getInstanceId() != null)
            sb.append("InstanceId: " + getInstanceId() + ",");
        if (getState() != null)
            sb.append("State: " + getState() + ",");
        if (getReasonCode() != null)
            sb.append("ReasonCode: " + getReasonCode() + ",");
        if (getDescription() != null)
            sb.append("Description: " + getDescription());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof InstanceState == false)
            return false;
        InstanceState other = (InstanceState) obj;
        if (other.getInstanceId() == null ^ this.getInstanceId() == null)
            return false;
        if (other.getInstanceId() != null
                && other.getInstanceId().equals(this.getInstanceId()) == 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.getReasonCode() == null ^ this.getReasonCode() == null)
            return false;
        if (other.getReasonCode() != null
                && other.getReasonCode().equals(this.getReasonCode()) == false)
            return false;
        if (other.getDescription() == null ^ this.getDescription() == null)
            return false;
        if (other.getDescription() != null
                && other.getDescription().equals(this.getDescription()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode());
        hashCode = prime * hashCode
                + ((getState() == null) ? 0 : getState().hashCode());
        hashCode = prime * hashCode
                + ((getReasonCode() == null) ? 0 : getReasonCode().hashCode());
        hashCode = prime
                * hashCode
                + ((getDescription() == null) ? 0 : getDescription().hashCode());
        return hashCode;
    }
    @Override
    public InstanceState clone() {
        try {
            return (InstanceState) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}