com.amazonaws.services.ec2.model.ReportInstanceStatusRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
 * Copyright 2011-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.ec2.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.ReportInstanceStatusRequestMarshaller;
/**
 * 
 * Contains the parameters for ReportInstanceStatus.
 * 
 */
public class ReportInstanceStatusRequest extends AmazonWebServiceRequest
        implements Serializable, Cloneable,
        DryRunSupportedRequest {
    /**
     * 
     * One or more instances.
     * 
     */
    private com.amazonaws.internal.SdkInternalList instances;
    /**
     * 
     * The status of all instances listed.
     * 
     */
    private String status;
    /**
     * 
     * The time at which the reported instance health state began.
     * 
     */
    private java.util.Date startTime;
    /**
     * 
     * The time at which the reported instance health state ended.
     * 
     */
    private java.util.Date endTime;
    /**
     * 
     * One or more reason codes that describes the health state of your
     * instance.
     * 
     * 
     * - 
     * 
     * instance-stuck-in-state: My instance is stuck in a state.
     * 
     *  
     * - 
     * 
     * unresponsive: My instance is unresponsive.
     * 
     *  
     * - 
     * 
     * not-accepting-credentials: My instance is not accepting my
     * credentials.
     * 
     *  
     * - 
     * 
     * password-not-available: A password is not available for my
     * instance.
     * 
     *  
     * - 
     * 
     * performance-network: My instance is experiencing performance
     * problems which I believe are network related.
     * 
     *  
     * - 
     * 
     * performance-instance-store: My instance is experiencing
     * performance problems which I believe are related to the instance stores.
     * 
     *  
     * - 
     * 
     * performance-ebs-volume: My instance is experiencing
     * performance problems which I believe are related to an EBS volume.
     * 
     *  
     * - 
     * 
     * performance-other: My instance is experiencing performance
     * problems.
     * 
     *  
     * - 
     * 
     * other: [explain using the description parameter]
     * 
     *  
     * 
     */
    private com.amazonaws.internal.SdkInternalList reasonCodes;
    /**
     * 
     * Descriptive text about the health state of your instance.
     * 
     */
    private String description;
    /**
     * 
     * One or more instances.
     * 
     * 
     * @return One or more instances.
     */
    public java.util.List getInstances() {
        if (instances == null) {
            instances = new com.amazonaws.internal.SdkInternalList();
        }
        return instances;
    }
    /**
     * 
     * One or more instances.
     * 
     * 
     * @param instances
     *        One or more instances.
     */
    public void setInstances(java.util.Collection instances) {
        if (instances == null) {
            this.instances = null;
            return;
        }
        this.instances = new com.amazonaws.internal.SdkInternalList(
                instances);
    }
    /**
     * 
     * One or more instances.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setInstances(java.util.Collection)} or
     * {@link #withInstances(java.util.Collection)} if you want to override the
     * existing values.
     * 
     * 
     * @param instances
     *        One or more instances.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReportInstanceStatusRequest withInstances(String... instances) {
        if (this.instances == null) {
            setInstances(new com.amazonaws.internal.SdkInternalList(
                    instances.length));
        }
        for (String ele : instances) {
            this.instances.add(ele);
        }
        return this;
    }
    /**
     * 
     * One or more instances.
     * 
     * 
     * @param instances
     *        One or more instances.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReportInstanceStatusRequest withInstances(
            java.util.Collection instances) {
        setInstances(instances);
        return this;
    }
    /**
     * 
     * The status of all instances listed.
     * 
     * 
     * @param status
     *        The status of all instances listed.
     * @see ReportStatusType
     */
    public void setStatus(String status) {
        this.status = status;
    }
    /**
     * 
     * The status of all instances listed.
     * 
     * 
     * @return The status of all instances listed.
     * @see ReportStatusType
     */
    public String getStatus() {
        return this.status;
    }
    /**
     * 
     * The status of all instances listed.
     * 
     * 
     * @param status
     *        The status of all instances listed.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see ReportStatusType
     */
    public ReportInstanceStatusRequest withStatus(String status) {
        setStatus(status);
        return this;
    }
    /**
     * 
     * The status of all instances listed.
     * 
     * 
     * @param status
     *        The status of all instances listed.
     * @see ReportStatusType
     */
    public void setStatus(ReportStatusType status) {
        this.status = status.toString();
    }
    /**
     * 
     * The status of all instances listed.
     * 
     * 
     * @param status
     *        The status of all instances listed.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see ReportStatusType
     */
    public ReportInstanceStatusRequest withStatus(ReportStatusType status) {
        setStatus(status);
        return this;
    }
    /**
     * 
     * The time at which the reported instance health state began.
     * 
     * 
     * @param startTime
     *        The time at which the reported instance health state began.
     */
    public void setStartTime(java.util.Date startTime) {
        this.startTime = startTime;
    }
    /**
     * 
     * The time at which the reported instance health state began.
     * 
     * 
     * @return The time at which the reported instance health state began.
     */
    public java.util.Date getStartTime() {
        return this.startTime;
    }
    /**
     * 
     * The time at which the reported instance health state began.
     * 
     * 
     * @param startTime
     *        The time at which the reported instance health state began.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReportInstanceStatusRequest withStartTime(java.util.Date startTime) {
        setStartTime(startTime);
        return this;
    }
    /**
     * 
     * The time at which the reported instance health state ended.
     * 
     * 
     * @param endTime
     *        The time at which the reported instance health state ended.
     */
    public void setEndTime(java.util.Date endTime) {
        this.endTime = endTime;
    }
    /**
     * 
     * The time at which the reported instance health state ended.
     * 
     * 
     * @return The time at which the reported instance health state ended.
     */
    public java.util.Date getEndTime() {
        return this.endTime;
    }
    /**
     * 
     * The time at which the reported instance health state ended.
     * 
     * 
     * @param endTime
     *        The time at which the reported instance health state ended.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReportInstanceStatusRequest withEndTime(java.util.Date endTime) {
        setEndTime(endTime);
        return this;
    }
    /**
     * 
     * One or more reason codes that describes the health state of your
     * instance.
     * 
     * 
     * - 
     * 
     * instance-stuck-in-state: My instance is stuck in a state.
     * 
     *  
     * - 
     * 
     * unresponsive: My instance is unresponsive.
     * 
     *  
     * - 
     * 
     * not-accepting-credentials: My instance is not accepting my
     * credentials.
     * 
     *  
     * - 
     * 
     * password-not-available: A password is not available for my
     * instance.
     * 
     *  
     * - 
     * 
     * performance-network: My instance is experiencing performance
     * problems which I believe are network related.
     * 
     *  
     * - 
     * 
     * performance-instance-store: My instance is experiencing
     * performance problems which I believe are related to the instance stores.
     * 
     *  
     * - 
     * 
     * performance-ebs-volume: My instance is experiencing
     * performance problems which I believe are related to an EBS volume.
     * 
     *  
     * - 
     * 
     * performance-other: My instance is experiencing performance
     * problems.
     * 
     *  
     * - 
     * 
     * other: [explain using the description parameter]
     * 
     *  
     * 
     * 
     * @return One or more reason codes that describes the health state of your
     *         instance.
     *         
     *         - 
     *         
     *         instance-stuck-in-state: My instance is stuck in a
     *         state.
     *         
     *          
     *         - 
     *         
     *         unresponsive: My instance is unresponsive.
     *         
     *          
     *         - 
     *         
     *         not-accepting-credentials: My instance is not
     *         accepting my credentials.
     *         
     *          
     *         - 
     *         
     *         password-not-available: A password is not available
     *         for my instance.
     *         
     *          
     *         - 
     *         
     *         performance-network: My instance is experiencing
     *         performance problems which I believe are network related.
     *         
     *          
     *         - 
     *         
     *         performance-instance-store: My instance is
     *         experiencing performance problems which I believe are related to
     *         the instance stores.
     *         
     *          
     *         - 
     *         
     *         performance-ebs-volume: My instance is experiencing
     *         performance problems which I believe are related to an EBS
     *         volume.
     *         
     *          
     *         - 
     *         
     *         performance-other: My instance is experiencing
     *         performance problems.
     *         
     *          
     *         - 
     *         
     *         other: [explain using the description parameter]
     *         
     *          
     * @see ReportInstanceReasonCodes
     */
    public java.util.List getReasonCodes() {
        if (reasonCodes == null) {
            reasonCodes = new com.amazonaws.internal.SdkInternalList();
        }
        return reasonCodes;
    }
    /**
     * 
     * One or more reason codes that describes the health state of your
     * instance.
     * 
     * 
     * - 
     * 
     * instance-stuck-in-state: My instance is stuck in a state.
     * 
     *  
     * - 
     * 
     * unresponsive: My instance is unresponsive.
     * 
     *  
     * - 
     * 
     * not-accepting-credentials: My instance is not accepting my
     * credentials.
     * 
     *  
     * - 
     * 
     * password-not-available: A password is not available for my
     * instance.
     * 
     *  
     * - 
     * 
     * performance-network: My instance is experiencing performance
     * problems which I believe are network related.
     * 
     *  
     * - 
     * 
     * performance-instance-store: My instance is experiencing
     * performance problems which I believe are related to the instance stores.
     * 
     *  
     * - 
     * 
     * performance-ebs-volume: My instance is experiencing
     * performance problems which I believe are related to an EBS volume.
     * 
     *  
     * - 
     * 
     * performance-other: My instance is experiencing performance
     * problems.
     * 
     *  
     * - 
     * 
     * other: [explain using the description parameter]
     * 
     *  
     * 
     * 
     * @param reasonCodes
     *        One or more reason codes that describes the health state of your
     *        instance.
     *        
     *        - 
     *        
     *        instance-stuck-in-state: My instance is stuck in a
     *        state.
     *        
     *         
     *        - 
     *        
     *        unresponsive: My instance is unresponsive.
     *        
     *         
     *        - 
     *        
     *        not-accepting-credentials: My instance is not
     *        accepting my credentials.
     *        
     *         
     *        - 
     *        
     *        password-not-available: A password is not available
     *        for my instance.
     *        
     *         
     *        - 
     *        
     *        performance-network: My instance is experiencing
     *        performance problems which I believe are network related.
     *        
     *         
     *        - 
     *        
     *        performance-instance-store: My instance is
     *        experiencing performance problems which I believe are related to
     *        the instance stores.
     *        
     *         
     *        - 
     *        
     *        performance-ebs-volume: My instance is experiencing
     *        performance problems which I believe are related to an EBS volume.
     *        
     *         
     *        - 
     *        
     *        performance-other: My instance is experiencing
     *        performance problems.
     *        
     *         
     *        - 
     *        
     *        other: [explain using the description parameter]
     *        
     *         
     * @see ReportInstanceReasonCodes
     */
    public void setReasonCodes(java.util.Collection reasonCodes) {
        if (reasonCodes == null) {
            this.reasonCodes = null;
            return;
        }
        this.reasonCodes = new com.amazonaws.internal.SdkInternalList(
                reasonCodes);
    }
    /**
     * 
     * One or more reason codes that describes the health state of your
     * instance.
     * 
     * 
     * - 
     * 
     * instance-stuck-in-state: My instance is stuck in a state.
     * 
     *  
     * - 
     * 
     * unresponsive: My instance is unresponsive.
     * 
     *  
     * - 
     * 
     * not-accepting-credentials: My instance is not accepting my
     * credentials.
     * 
     *  
     * - 
     * 
     * password-not-available: A password is not available for my
     * instance.
     * 
     *  
     * - 
     * 
     * performance-network: My instance is experiencing performance
     * problems which I believe are network related.
     * 
     *  
     * - 
     * 
     * performance-instance-store: My instance is experiencing
     * performance problems which I believe are related to the instance stores.
     * 
     *  
     * - 
     * 
     * performance-ebs-volume: My instance is experiencing
     * performance problems which I believe are related to an EBS volume.
     * 
     *  
     * - 
     * 
     * performance-other: My instance is experiencing performance
     * problems.
     * 
     *  
     * - 
     * 
     * other: [explain using the description parameter]
     * 
     *  
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setReasonCodes(java.util.Collection)} or
     * {@link #withReasonCodes(java.util.Collection)} if you want to override
     * the existing values.
     * 
     * 
     * @param reasonCodes
     *        One or more reason codes that describes the health state of your
     *        instance.
     *        
     *        - 
     *        
     *        instance-stuck-in-state: My instance is stuck in a
     *        state.
     *        
     *         
     *        - 
     *        
     *        unresponsive: My instance is unresponsive.
     *        
     *         
     *        - 
     *        
     *        not-accepting-credentials: My instance is not
     *        accepting my credentials.
     *        
     *         
     *        - 
     *        
     *        password-not-available: A password is not available
     *        for my instance.
     *        
     *         
     *        - 
     *        
     *        performance-network: My instance is experiencing
     *        performance problems which I believe are network related.
     *        
     *         
     *        - 
     *        
     *        performance-instance-store: My instance is
     *        experiencing performance problems which I believe are related to
     *        the instance stores.
     *        
     *         
     *        - 
     *        
     *        performance-ebs-volume: My instance is experiencing
     *        performance problems which I believe are related to an EBS volume.
     *        
     *         
     *        - 
     *        
     *        performance-other: My instance is experiencing
     *        performance problems.
     *        
     *         
     *        - 
     *        
     *        other: [explain using the description parameter]
     *        
     *         
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see ReportInstanceReasonCodes
     */
    public ReportInstanceStatusRequest withReasonCodes(String... reasonCodes) {
        if (this.reasonCodes == null) {
            setReasonCodes(new com.amazonaws.internal.SdkInternalList(
                    reasonCodes.length));
        }
        for (String ele : reasonCodes) {
            this.reasonCodes.add(ele);
        }
        return this;
    }
    /**
     * 
     * One or more reason codes that describes the health state of your
     * instance.
     * 
     * 
     * - 
     * 
     * instance-stuck-in-state: My instance is stuck in a state.
     * 
     *  
     * - 
     * 
     * unresponsive: My instance is unresponsive.
     * 
     *  
     * - 
     * 
     * not-accepting-credentials: My instance is not accepting my
     * credentials.
     * 
     *  
     * - 
     * 
     * password-not-available: A password is not available for my
     * instance.
     * 
     *  
     * - 
     * 
     * performance-network: My instance is experiencing performance
     * problems which I believe are network related.
     * 
     *  
     * - 
     * 
     * performance-instance-store: My instance is experiencing
     * performance problems which I believe are related to the instance stores.
     * 
     *  
     * - 
     * 
     * performance-ebs-volume: My instance is experiencing
     * performance problems which I believe are related to an EBS volume.
     * 
     *  
     * - 
     * 
     * performance-other: My instance is experiencing performance
     * problems.
     * 
     *  
     * - 
     * 
     * other: [explain using the description parameter]
     * 
     *  
     * 
     * 
     * @param reasonCodes
     *        One or more reason codes that describes the health state of your
     *        instance.
     *        
     *        - 
     *        
     *        instance-stuck-in-state: My instance is stuck in a
     *        state.
     *        
     *         
     *        - 
     *        
     *        unresponsive: My instance is unresponsive.
     *        
     *         
     *        - 
     *        
     *        not-accepting-credentials: My instance is not
     *        accepting my credentials.
     *        
     *         
     *        - 
     *        
     *        password-not-available: A password is not available
     *        for my instance.
     *        
     *         
     *        - 
     *        
     *        performance-network: My instance is experiencing
     *        performance problems which I believe are network related.
     *        
     *         
     *        - 
     *        
     *        performance-instance-store: My instance is
     *        experiencing performance problems which I believe are related to
     *        the instance stores.
     *        
     *         
     *        - 
     *        
     *        performance-ebs-volume: My instance is experiencing
     *        performance problems which I believe are related to an EBS volume.
     *        
     *         
     *        - 
     *        
     *        performance-other: My instance is experiencing
     *        performance problems.
     *        
     *         
     *        - 
     *        
     *        other: [explain using the description parameter]
     *        
     *         
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see ReportInstanceReasonCodes
     */
    public ReportInstanceStatusRequest withReasonCodes(
            java.util.Collection reasonCodes) {
        setReasonCodes(reasonCodes);
        return this;
    }
    /**
     * 
     * One or more reason codes that describes the health state of your
     * instance.
     * 
     * 
     * - 
     * 
     * instance-stuck-in-state: My instance is stuck in a state.
     * 
     *  
     * - 
     * 
     * unresponsive: My instance is unresponsive.
     * 
     *  
     * - 
     * 
     * not-accepting-credentials: My instance is not accepting my
     * credentials.
     * 
     *  
     * - 
     * 
     * password-not-available: A password is not available for my
     * instance.
     * 
     *  
     * - 
     * 
     * performance-network: My instance is experiencing performance
     * problems which I believe are network related.
     * 
     *  
     * - 
     * 
     * performance-instance-store: My instance is experiencing
     * performance problems which I believe are related to the instance stores.
     * 
     *  
     * - 
     * 
     * performance-ebs-volume: My instance is experiencing
     * performance problems which I believe are related to an EBS volume.
     * 
     *  
     * - 
     * 
     * performance-other: My instance is experiencing performance
     * problems.
     * 
     *  
     * - 
     * 
     * other: [explain using the description parameter]
     * 
     *  
     * 
     * 
     * @param reasonCodes
     *        One or more reason codes that describes the health state of your
     *        instance.
     *        
     *        - 
     *        
     *        instance-stuck-in-state: My instance is stuck in a
     *        state.
     *        
     *         
     *        - 
     *        
     *        unresponsive: My instance is unresponsive.
     *        
     *         
     *        - 
     *        
     *        not-accepting-credentials: My instance is not
     *        accepting my credentials.
     *        
     *         
     *        - 
     *        
     *        password-not-available: A password is not available
     *        for my instance.
     *        
     *         
     *        - 
     *        
     *        performance-network: My instance is experiencing
     *        performance problems which I believe are network related.
     *        
     *         
     *        - 
     *        
     *        performance-instance-store: My instance is
     *        experiencing performance problems which I believe are related to
     *        the instance stores.
     *        
     *         
     *        - 
     *        
     *        performance-ebs-volume: My instance is experiencing
     *        performance problems which I believe are related to an EBS volume.
     *        
     *         
     *        - 
     *        
     *        performance-other: My instance is experiencing
     *        performance problems.
     *        
     *         
     *        - 
     *        
     *        other: [explain using the description parameter]
     *        
     *         
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see ReportInstanceReasonCodes
     */
    public ReportInstanceStatusRequest withReasonCodes(
            ReportInstanceReasonCodes... reasonCodes) {
        com.amazonaws.internal.SdkInternalList reasonCodesCopy = new com.amazonaws.internal.SdkInternalList(
                reasonCodes.length);
        for (ReportInstanceReasonCodes value : reasonCodes) {
            reasonCodesCopy.add(value.toString());
        }
        if (getReasonCodes() == null) {
            setReasonCodes(reasonCodesCopy);
        } else {
            getReasonCodes().addAll(reasonCodesCopy);
        }
        return this;
    }
    /**
     * 
     * Descriptive text about the health state of your instance.
     * 
     * 
     * @param description
     *        Descriptive text about the health state of your instance.
     */
    public void setDescription(String description) {
        this.description = description;
    }
    /**
     * 
     * Descriptive text about the health state of your instance.
     * 
     * 
     * @return Descriptive text about the health state of your instance.
     */
    public String getDescription() {
        return this.description;
    }
    /**
     * 
     * Descriptive text about the health state of your instance.
     * 
     * 
     * @param description
     *        Descriptive text about the health state of your instance.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ReportInstanceStatusRequest withDescription(String description) {
        setDescription(description);
        return this;
    }
    /**
     * This method is intended for internal use only. Returns the marshaled
     * request configured with additional parameters to enable operation
     * dry-run.
     */
    @Override
    public Request getDryRunRequest() {
        Request request = new ReportInstanceStatusRequestMarshaller()
                .marshall(this);
        request.addParameter("DryRun", Boolean.toString(true));
        return request;
    }
    /**
     * 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 (getInstances() != null)
            sb.append("Instances: " + getInstances() + ",");
        if (getStatus() != null)
            sb.append("Status: " + getStatus() + ",");
        if (getStartTime() != null)
            sb.append("StartTime: " + getStartTime() + ",");
        if (getEndTime() != null)
            sb.append("EndTime: " + getEndTime() + ",");
        if (getReasonCodes() != null)
            sb.append("ReasonCodes: " + getReasonCodes() + ",");
        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 ReportInstanceStatusRequest == false)
            return false;
        ReportInstanceStatusRequest other = (ReportInstanceStatusRequest) obj;
        if (other.getInstances() == null ^ this.getInstances() == null)
            return false;
        if (other.getInstances() != null
                && other.getInstances().equals(this.getInstances()) == 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.getStartTime() == null ^ this.getStartTime() == null)
            return false;
        if (other.getStartTime() != null
                && other.getStartTime().equals(this.getStartTime()) == false)
            return false;
        if (other.getEndTime() == null ^ this.getEndTime() == null)
            return false;
        if (other.getEndTime() != null
                && other.getEndTime().equals(this.getEndTime()) == false)
            return false;
        if (other.getReasonCodes() == null ^ this.getReasonCodes() == null)
            return false;
        if (other.getReasonCodes() != null
                && other.getReasonCodes().equals(this.getReasonCodes()) == 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
                + ((getInstances() == null) ? 0 : getInstances().hashCode());
        hashCode = prime * hashCode
                + ((getStatus() == null) ? 0 : getStatus().hashCode());
        hashCode = prime * hashCode
                + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
        hashCode = prime * hashCode
                + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
        hashCode = prime
                * hashCode
                + ((getReasonCodes() == null) ? 0 : getReasonCodes().hashCode());
        hashCode = prime
                * hashCode
                + ((getDescription() == null) ? 0 : getDescription().hashCode());
        return hashCode;
    }
    @Override
    public ReportInstanceStatusRequest clone() {
        return (ReportInstanceStatusRequest) super.clone();
    }
}