com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationSettingsRequest 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#describeConfigurationSettings(DescribeConfigurationSettingsRequest) DescribeConfigurationSettings operation}.
*
* Returns a description of the settings for the specified configuration
* set, that is, either a configuration template or the configuration set
* associated with a running environment.
*
*
* When describing the settings for the configuration set associated
* with a running environment, it is possible to receive two sets of
* setting descriptions. One is the deployed configuration set, and the
* other is a draft configuration of an environment that is either in the
* process of deployment or that failed to deploy.
*
*
* Related Topics
*
*
*
* - DeleteEnvironmentConfiguration
*
*
*
* @see com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalk#describeConfigurationSettings(DescribeConfigurationSettingsRequest)
*/
public class DescribeConfigurationSettingsRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The application for the environment or configuration template.
*
* Constraints:
* Length: 1 - 100
*/
private String applicationName;
/**
* The name of the configuration template to describe.
Conditional:
* You must specify either this parameter or an EnvironmentName, but not
* both. If you specify both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. If you do not specify
* either, AWS Elastic Beanstalk returns a
* MissingRequiredParameter error.
*
* Constraints:
* Length: 1 - 100
*/
private String templateName;
/**
* The name of the environment to describe.
Condition: You must
* specify either this or a TemplateName, but not both. If you specify
* both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. If you do not specify
* either, AWS Elastic Beanstalk returns
* MissingRequiredParameter error.
*
* Constraints:
* Length: 4 - 23
*/
private String environmentName;
/**
* Default constructor for a new DescribeConfigurationSettingsRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public DescribeConfigurationSettingsRequest() {}
/**
* Constructs a new DescribeConfigurationSettingsRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param applicationName The application for the environment or
* configuration template.
*/
public DescribeConfigurationSettingsRequest(String applicationName) {
setApplicationName(applicationName);
}
/**
* The application for the environment or configuration template.
*
* Constraints:
* Length: 1 - 100
*
* @return The application for the environment or configuration template.
*/
public String getApplicationName() {
return applicationName;
}
/**
* The application for the environment or configuration template.
*
* Constraints:
* Length: 1 - 100
*
* @param applicationName The application for the environment or configuration template.
*/
public void setApplicationName(String applicationName) {
this.applicationName = applicationName;
}
/**
* The application for the environment or configuration template.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 100
*
* @param applicationName The application for the environment or configuration template.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeConfigurationSettingsRequest withApplicationName(String applicationName) {
this.applicationName = applicationName;
return this;
}
/**
* The name of the configuration template to describe.
Conditional:
* You must specify either this parameter or an EnvironmentName, but not
* both. If you specify both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. If you do not specify
* either, AWS Elastic Beanstalk returns a
* MissingRequiredParameter error.
*
* Constraints:
* Length: 1 - 100
*
* @return The name of the configuration template to describe.
Conditional:
* You must specify either this parameter or an EnvironmentName, but not
* both. If you specify both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. If you do not specify
* either, AWS Elastic Beanstalk returns a
* MissingRequiredParameter error.
*/
public String getTemplateName() {
return templateName;
}
/**
* The name of the configuration template to describe.
Conditional:
* You must specify either this parameter or an EnvironmentName, but not
* both. If you specify both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. If you do not specify
* either, AWS Elastic Beanstalk returns a
* MissingRequiredParameter error.
*
* Constraints:
* Length: 1 - 100
*
* @param templateName The name of the configuration template to describe.
Conditional:
* You must specify either this parameter or an EnvironmentName, but not
* both. If you specify both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. If you do not specify
* either, AWS Elastic Beanstalk returns a
* MissingRequiredParameter error.
*/
public void setTemplateName(String templateName) {
this.templateName = templateName;
}
/**
* The name of the configuration template to describe.
Conditional:
* You must specify either this parameter or an EnvironmentName, but not
* both. If you specify both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. If you do not specify
* either, AWS Elastic Beanstalk returns a
* MissingRequiredParameter error.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 100
*
* @param templateName The name of the configuration template to describe.
Conditional:
* You must specify either this parameter or an EnvironmentName, but not
* both. If you specify both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. If you do not specify
* either, AWS Elastic Beanstalk returns a
* MissingRequiredParameter error.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeConfigurationSettingsRequest withTemplateName(String templateName) {
this.templateName = templateName;
return this;
}
/**
* The name of the environment to describe.
Condition: You must
* specify either this or a TemplateName, but not both. If you specify
* both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. If you do not specify
* either, AWS Elastic Beanstalk returns
* MissingRequiredParameter error.
*
* Constraints:
* Length: 4 - 23
*
* @return The name of the environment to describe.
Condition: You must
* specify either this or a TemplateName, but not both. If you specify
* both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. If you do not specify
* either, AWS Elastic Beanstalk returns
* MissingRequiredParameter error.
*/
public String getEnvironmentName() {
return environmentName;
}
/**
* The name of the environment to describe.
Condition: You must
* specify either this or a TemplateName, but not both. If you specify
* both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. If you do not specify
* either, AWS Elastic Beanstalk returns
* MissingRequiredParameter error.
*
* Constraints:
* Length: 4 - 23
*
* @param environmentName The name of the environment to describe.
Condition: You must
* specify either this or a TemplateName, but not both. If you specify
* both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. 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 to describe.
Condition: You must
* specify either this or a TemplateName, but not both. If you specify
* both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. 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 to describe.
Condition: You must
* specify either this or a TemplateName, but not both. If you specify
* both, AWS Elastic Beanstalk returns an
* InvalidParameterCombination error. 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 DescribeConfigurationSettingsRequest withEnvironmentName(String environmentName) {
this.environmentName = environmentName;
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 (getApplicationName() != null) sb.append("ApplicationName: " + getApplicationName() + ",");
if (getTemplateName() != null) sb.append("TemplateName: " + getTemplateName() + ",");
if (getEnvironmentName() != null) sb.append("EnvironmentName: " + getEnvironmentName() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getApplicationName() == null) ? 0 : getApplicationName().hashCode());
hashCode = prime * hashCode + ((getTemplateName() == null) ? 0 : getTemplateName().hashCode());
hashCode = prime * hashCode + ((getEnvironmentName() == null) ? 0 : getEnvironmentName().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeConfigurationSettingsRequest == false) return false;
DescribeConfigurationSettingsRequest other = (DescribeConfigurationSettingsRequest)obj;
if (other.getApplicationName() == null ^ this.getApplicationName() == null) return false;
if (other.getApplicationName() != null && other.getApplicationName().equals(this.getApplicationName()) == false) return false;
if (other.getTemplateName() == null ^ this.getTemplateName() == null) return false;
if (other.getTemplateName() != null && other.getTemplateName().equals(this.getTemplateName()) == false) return false;
if (other.getEnvironmentName() == null ^ this.getEnvironmentName() == null) return false;
if (other.getEnvironmentName() != null && other.getEnvironmentName().equals(this.getEnvironmentName()) == false) return false;
return true;
}
}