com.amazonaws.services.elasticbeanstalk.model.RetrieveEnvironmentInfoRequest 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.elasticbeanstalk.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
 * 
 * Request to download logs retrieved with RequestEnvironmentInfo.
 * 
 */
public class RetrieveEnvironmentInfoRequest extends AmazonWebServiceRequest
        implements Serializable, Cloneable {
    /**
     * 
     * The ID of the data's environment.
     * 
     * 
     * If no such environment is found, returns an
     * InvalidParameterValue error.
     * 
     * 
     * Condition: You must specify either this or an EnvironmentName, or both.
     * If you do not specify either, AWS Elastic Beanstalk returns
     * MissingRequiredParameter error.
     * 
     */
    private String environmentId;
    /**
     * 
     * The name of the data's environment.
     * 
     * 
     * If no such environment is found, returns an
     * InvalidParameterValue error.
     * 
     * 
     * Condition: You must specify either this or an EnvironmentId, or both. If
     * you do not specify either, AWS Elastic Beanstalk returns
     * MissingRequiredParameter error.
     * 
     */
    private String environmentName;
    /**
     * 
     * The type of information to retrieve.
     * 
     */
    private String infoType;
    /**
     * Default constructor for RetrieveEnvironmentInfoRequest object. Callers
     * should use the setter or fluent setter (with...) methods to initialize
     * the object after creating it.
     */
    public RetrieveEnvironmentInfoRequest() {
    }
    /**
     * Constructs a new RetrieveEnvironmentInfoRequest object. Callers should
     * use the setter or fluent setter (with...) methods to initialize any
     * additional object members.
     * 
     * @param infoType
     *        The type of information to retrieve.
     */
    public RetrieveEnvironmentInfoRequest(String infoType) {
        setInfoType(infoType);
    }
    /**
     * Constructs a new RetrieveEnvironmentInfoRequest object. Callers should
     * use the setter or fluent setter (with...) methods to initialize any
     * additional object members.
     * 
     * @param infoType
     *        The type of information to retrieve.
     */
    public RetrieveEnvironmentInfoRequest(EnvironmentInfoType infoType) {
        setInfoType(infoType.toString());
    }
    /**
     * 
     * The ID of the data's environment.
     * 
     * 
     * If no such environment is found, returns an
     * InvalidParameterValue error.
     * 
     * 
     * Condition: You must specify either this or an EnvironmentName, or both.
     * If you do not specify either, AWS Elastic Beanstalk returns
     * MissingRequiredParameter error.
     * 
     * 
     * @param environmentId
     *        The ID of the data's environment.
     *        
     *        If no such environment is found, returns an
     *        InvalidParameterValue error.
     *        
     *        
     *        Condition: You must specify either this or an EnvironmentName, or
     *        both. If you do not specify either, AWS Elastic Beanstalk returns
     *        MissingRequiredParameter error.
     */
    public void setEnvironmentId(String environmentId) {
        this.environmentId = environmentId;
    }
    /**
     * 
     * The ID of the data's environment.
     * 
     * 
     * If no such environment is found, returns an
     * InvalidParameterValue error.
     * 
     * 
     * Condition: You must specify either this or an EnvironmentName, or both.
     * If you do not specify either, AWS Elastic Beanstalk returns
     * MissingRequiredParameter error.
     * 
     * 
     * @return The ID of the data's environment.
     *         
     *         If no such environment is found, returns an
     *         InvalidParameterValue error.
     *         
     *         
     *         Condition: You must specify either this or an EnvironmentName, or
     *         both. If you do not specify either, AWS Elastic Beanstalk returns
     *         MissingRequiredParameter error.
     */
    public String getEnvironmentId() {
        return this.environmentId;
    }
    /**
     * 
     * The ID of the data's environment.
     * 
     * 
     * If no such environment is found, returns an
     * InvalidParameterValue error.
     * 
     * 
     * Condition: You must specify either this or an EnvironmentName, or both.
     * If you do not specify either, AWS Elastic Beanstalk returns
     * MissingRequiredParameter error.
     * 
     * 
     * @param environmentId
     *        The ID of the data's environment.
     *        
     *        If no such environment is found, returns an
     *        InvalidParameterValue error.
     *        
     *        
     *        Condition: You must specify either this or an EnvironmentName, or
     *        both. If you do not specify either, AWS Elastic Beanstalk returns
     *        MissingRequiredParameter error.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public RetrieveEnvironmentInfoRequest withEnvironmentId(String environmentId) {
        setEnvironmentId(environmentId);
        return this;
    }
    /**
     * 
     * The name of the data's environment.
     * 
     * 
     * If no such environment is found, returns an
     * InvalidParameterValue error.
     * 
     * 
     * Condition: You must specify either this or an EnvironmentId, or both. If
     * you do not specify either, AWS Elastic Beanstalk returns
     * MissingRequiredParameter error.
     * 
     * 
     * @param environmentName
     *        The name of the data's environment.
     *        
     *        If no such environment is found, returns an
     *        InvalidParameterValue error.
     *        
     *        
     *        Condition: You must specify either this or an EnvironmentId, or
     *        both. If you do not specify either, AWS Elastic Beanstalk returns
     *        MissingRequiredParameter error.
     */
    public void setEnvironmentName(String environmentName) {
        this.environmentName = environmentName;
    }
    /**
     * 
     * The name of the data's environment.
     * 
     * 
     * If no such environment is found, returns an
     * InvalidParameterValue error.
     * 
     * 
     * Condition: You must specify either this or an EnvironmentId, or both. If
     * you do not specify either, AWS Elastic Beanstalk returns
     * MissingRequiredParameter error.
     * 
     * 
     * @return The name of the data's environment.
     *         
     *         If no such environment is found, returns an
     *         InvalidParameterValue error.
     *         
     *         
     *         Condition: You must specify either this or an EnvironmentId, or
     *         both. If you do not specify either, AWS Elastic Beanstalk returns
     *         MissingRequiredParameter error.
     */
    public String getEnvironmentName() {
        return this.environmentName;
    }
    /**
     * 
     * The name of the data's environment.
     * 
     * 
     * If no such environment is found, returns an
     * InvalidParameterValue error.
     * 
     * 
     * Condition: You must specify either this or an EnvironmentId, or both. If
     * you do not specify either, AWS Elastic Beanstalk returns
     * MissingRequiredParameter error.
     * 
     * 
     * @param environmentName
     *        The name of the data's environment.
     *        
     *        If no such environment is found, returns an
     *        InvalidParameterValue error.
     *        
     *        
     *        Condition: You must specify either this or an EnvironmentId, or
     *        both. If you do not specify either, AWS Elastic Beanstalk returns
     *        MissingRequiredParameter error.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public RetrieveEnvironmentInfoRequest withEnvironmentName(
            String environmentName) {
        setEnvironmentName(environmentName);
        return this;
    }
    /**
     * 
     * The type of information to retrieve.
     * 
     * 
     * @param infoType
     *        The type of information to retrieve.
     * @see EnvironmentInfoType
     */
    public void setInfoType(String infoType) {
        this.infoType = infoType;
    }
    /**
     * 
     * The type of information to retrieve.
     * 
     * 
     * @return The type of information to retrieve.
     * @see EnvironmentInfoType
     */
    public String getInfoType() {
        return this.infoType;
    }
    /**
     * 
     * The type of information to retrieve.
     * 
     * 
     * @param infoType
     *        The type of information to retrieve.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see EnvironmentInfoType
     */
    public RetrieveEnvironmentInfoRequest withInfoType(String infoType) {
        setInfoType(infoType);
        return this;
    }
    /**
     * 
     * The type of information to retrieve.
     * 
     * 
     * @param infoType
     *        The type of information to retrieve.
     * @see EnvironmentInfoType
     */
    public void setInfoType(EnvironmentInfoType infoType) {
        this.infoType = infoType.toString();
    }
    /**
     * 
     * The type of information to retrieve.
     * 
     * 
     * @param infoType
     *        The type of information to retrieve.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see EnvironmentInfoType
     */
    public RetrieveEnvironmentInfoRequest withInfoType(
            EnvironmentInfoType infoType) {
        setInfoType(infoType);
        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 (getEnvironmentId() != null)
            sb.append("EnvironmentId: " + getEnvironmentId() + ",");
        if (getEnvironmentName() != null)
            sb.append("EnvironmentName: " + getEnvironmentName() + ",");
        if (getInfoType() != null)
            sb.append("InfoType: " + getInfoType());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof RetrieveEnvironmentInfoRequest == false)
            return false;
        RetrieveEnvironmentInfoRequest other = (RetrieveEnvironmentInfoRequest) obj;
        if (other.getEnvironmentId() == null ^ this.getEnvironmentId() == null)
            return false;
        if (other.getEnvironmentId() != null
                && other.getEnvironmentId().equals(this.getEnvironmentId()) == false)
            return false;
        if (other.getEnvironmentName() == null
                ^ this.getEnvironmentName() == null)
            return false;
        if (other.getEnvironmentName() != null
                && other.getEnvironmentName().equals(this.getEnvironmentName()) == false)
            return false;
        if (other.getInfoType() == null ^ this.getInfoType() == null)
            return false;
        if (other.getInfoType() != null
                && other.getInfoType().equals(this.getInfoType()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime
                * hashCode
                + ((getEnvironmentId() == null) ? 0 : getEnvironmentId()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getEnvironmentName() == null) ? 0 : getEnvironmentName()
                        .hashCode());
        hashCode = prime * hashCode
                + ((getInfoType() == null) ? 0 : getInfoType().hashCode());
        return hashCode;
    }
    @Override
    public RetrieveEnvironmentInfoRequest clone() {
        return (RetrieveEnvironmentInfoRequest) super.clone();
    }
}