com.amazonaws.services.elasticbeanstalk.model.RequestEnvironmentInfoRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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;
/**
* Container for the parameters to the {@link com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalk#requestEnvironmentInfo(RequestEnvironmentInfoRequest) RequestEnvironmentInfo operation}.
*
* Initiates a request to compile the specified type of information of
* the deployed environment.
*
*
* Setting the InfoType to tail compiles the
* last lines from the application server log files of every Amazon EC2
* instance in your environment. Use RetrieveEnvironmentInfo to access
* the compiled information.
*
*
* Related Topics
*
*
*
* - RetrieveEnvironmentInfo
*
*
*
* @see com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalk#requestEnvironmentInfo(RequestEnvironmentInfoRequest)
*/
public class RequestEnvironmentInfoRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The ID of the environment of the requested data. If no such
* environment is found, RequestEnvironmentInfo 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 environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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.
*
* Constraints:
* Length: 4 - 23
*/
private String environmentName;
/**
* The type of information to request.
*
* Constraints:
* Allowed Values: tail
*/
private String infoType;
/**
* Default constructor for a new RequestEnvironmentInfoRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public RequestEnvironmentInfoRequest() {}
/**
* Constructs a new RequestEnvironmentInfoRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param infoType The type of information to request.
*/
public RequestEnvironmentInfoRequest(String infoType) {
setInfoType(infoType);
}
/**
* Constructs a new RequestEnvironmentInfoRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param infoType The type of information to request.
*/
public RequestEnvironmentInfoRequest(EnvironmentInfoType infoType) {
this.infoType = infoType.toString();
}
/**
* The ID of the environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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 environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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 environmentId;
}
/**
* The ID of the environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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 environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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 environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param environmentId The ID of the environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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 A reference to this updated object so that method calls can be chained
* together.
*/
public RequestEnvironmentInfoRequest withEnvironmentId(String environmentId) {
this.environmentId = environmentId;
return this;
}
/**
* The name of the environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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.
*
* Constraints:
* Length: 4 - 23
*
* @return The name of the environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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 environmentName;
}
/**
* The name of the environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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.
*
* Constraints:
* Length: 4 - 23
*
* @param environmentName The name of the environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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 environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 4 - 23
*
* @param environmentName The name of the environment of the requested data.
If no such
* environment is found, RequestEnvironmentInfo 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 A reference to this updated object so that method calls can be chained
* together.
*/
public RequestEnvironmentInfoRequest withEnvironmentName(String environmentName) {
this.environmentName = environmentName;
return this;
}
/**
* The type of information to request.
*
* Constraints:
* Allowed Values: tail
*
* @return The type of information to request.
*
* @see EnvironmentInfoType
*/
public String getInfoType() {
return infoType;
}
/**
* The type of information to request.
*
* Constraints:
* Allowed Values: tail
*
* @param infoType The type of information to request.
*
* @see EnvironmentInfoType
*/
public void setInfoType(String infoType) {
this.infoType = infoType;
}
/**
* The type of information to request.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: tail
*
* @param infoType The type of information to request.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see EnvironmentInfoType
*/
public RequestEnvironmentInfoRequest withInfoType(String infoType) {
this.infoType = infoType;
return this;
}
/**
* The type of information to request.
*
* Constraints:
* Allowed Values: tail
*
* @param infoType The type of information to request.
*
* @see EnvironmentInfoType
*/
public void setInfoType(EnvironmentInfoType infoType) {
this.infoType = infoType.toString();
}
/**
* The type of information to request.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: tail
*
* @param infoType The type of information to request.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see EnvironmentInfoType
*/
public RequestEnvironmentInfoRequest withInfoType(EnvironmentInfoType infoType) {
this.infoType = infoType.toString();
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 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 boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof RequestEnvironmentInfoRequest == false) return false;
RequestEnvironmentInfoRequest other = (RequestEnvironmentInfoRequest)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;
}
}