com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentRequest 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#updateEnvironment(UpdateEnvironmentRequest) UpdateEnvironment operation}.
*
* Updates the environment description, deploys a new application
* version, updates the configuration settings to an entirely new
* configuration template, or updates select configuration option values
* in the running environment.
*
*
* Attempting to update both the release and configuration is not
* allowed and AWS Elastic Beanstalk returns an
* InvalidParameterCombination error.
*
*
* When updating the configuration settings to a new template or
* individual settings, a draft configuration is created and
* DescribeConfigurationSettings for this environment returns two setting
* descriptions with different DeploymentStatus values.
*
*
* @see com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalk#updateEnvironment(UpdateEnvironmentRequest)
*/
public class UpdateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The ID of the environment to update. If no environment with this
* ID exists, AWS Elastic Beanstalk 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 to update. If no environment with this
* name exists, AWS Elastic Beanstalk 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;
/**
* If this parameter is specified, AWS Elastic Beanstalk updates the
* description of this environment.
*
* Constraints:
* Length: 0 - 200
*/
private String description;
/**
* This specifies the tier to use to update the environment.
* Condition: You can only update the tier version for an environment. If
* you change the name of the type, AWS Elastic Beanstalk returns
* InvalidParameterValue error.
*/
private EnvironmentTier tier;
/**
* If this parameter is specified, AWS Elastic Beanstalk deploys the
* named application version to the environment. If no such application
* version is found, returns an InvalidParameterValue error.
*
* Constraints:
* Length: 1 - 100
*/
private String versionLabel;
/**
* If this parameter is specified, AWS Elastic Beanstalk deploys this
* configuration template to the environment. If no such configuration
* template is found, AWS Elastic Beanstalk returns an
* InvalidParameterValue error.
*
* Constraints:
* Length: 1 - 100
*/
private String templateName;
/**
* If specified, AWS Elastic Beanstalk updates the configuration set
* associated with the running environment and sets the specified
* configuration options to the requested value.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag optionSettings;
/**
* A list of custom user-defined configuration options to remove from the
* configuration set for this environment.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag optionsToRemove;
/**
* Default constructor for a new UpdateEnvironmentRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public UpdateEnvironmentRequest() {}
/**
* The ID of the environment to update. If no environment with this
* ID exists, AWS Elastic Beanstalk 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 to update.
If no environment with this
* ID exists, AWS Elastic Beanstalk 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 to update.
If no environment with this
* ID exists, AWS Elastic Beanstalk 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 to update.
If no environment with this
* ID exists, AWS Elastic Beanstalk 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 to update.
If no environment with this
* ID exists, AWS Elastic Beanstalk 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 to update.
If no environment with this
* ID exists, AWS Elastic Beanstalk 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 UpdateEnvironmentRequest withEnvironmentId(String environmentId) {
this.environmentId = environmentId;
return this;
}
/**
* The name of the environment to update. If no environment with this
* name exists, AWS Elastic Beanstalk 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 to update. If no environment with this
* name exists, AWS Elastic Beanstalk 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 to update. If no environment with this
* name exists, AWS Elastic Beanstalk 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 to update. If no environment with this
* name exists, AWS Elastic Beanstalk 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 to update. If no environment with this
* name exists, AWS Elastic Beanstalk 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 to update. If no environment with this
* name exists, AWS Elastic Beanstalk 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 UpdateEnvironmentRequest withEnvironmentName(String environmentName) {
this.environmentName = environmentName;
return this;
}
/**
* If this parameter is specified, AWS Elastic Beanstalk updates the
* description of this environment.
*
* Constraints:
* Length: 0 - 200
*
* @return If this parameter is specified, AWS Elastic Beanstalk updates the
* description of this environment.
*/
public String getDescription() {
return description;
}
/**
* If this parameter is specified, AWS Elastic Beanstalk updates the
* description of this environment.
*
* Constraints:
* Length: 0 - 200
*
* @param description If this parameter is specified, AWS Elastic Beanstalk updates the
* description of this environment.
*/
public void setDescription(String description) {
this.description = description;
}
/**
* If this parameter is specified, AWS Elastic Beanstalk updates the
* description of this environment.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 200
*
* @param description If this parameter is specified, AWS Elastic Beanstalk updates the
* description of this environment.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateEnvironmentRequest withDescription(String description) {
this.description = description;
return this;
}
/**
* This specifies the tier to use to update the environment.
* Condition: You can only update the tier version for an environment. If
* you change the name of the type, AWS Elastic Beanstalk returns
* InvalidParameterValue error.
*
* @return This specifies the tier to use to update the environment.
* Condition: You can only update the tier version for an environment. If
* you change the name of the type, AWS Elastic Beanstalk returns
* InvalidParameterValue error.
*/
public EnvironmentTier getTier() {
return tier;
}
/**
* This specifies the tier to use to update the environment.
* Condition: You can only update the tier version for an environment. If
* you change the name of the type, AWS Elastic Beanstalk returns
* InvalidParameterValue error.
*
* @param tier This specifies the tier to use to update the environment.
* Condition: You can only update the tier version for an environment. If
* you change the name of the type, AWS Elastic Beanstalk returns
* InvalidParameterValue error.
*/
public void setTier(EnvironmentTier tier) {
this.tier = tier;
}
/**
* This specifies the tier to use to update the environment.
* Condition: You can only update the tier version for an environment. If
* you change the name of the type, AWS Elastic Beanstalk returns
* InvalidParameterValue error.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param tier This specifies the tier to use to update the environment.
* Condition: You can only update the tier version for an environment. If
* you change the name of the type, AWS Elastic Beanstalk returns
* InvalidParameterValue error.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateEnvironmentRequest withTier(EnvironmentTier tier) {
this.tier = tier;
return this;
}
/**
* If this parameter is specified, AWS Elastic Beanstalk deploys the
* named application version to the environment. If no such application
* version is found, returns an InvalidParameterValue error.
*
* Constraints:
* Length: 1 - 100
*
* @return If this parameter is specified, AWS Elastic Beanstalk deploys the
* named application version to the environment. If no such application
* version is found, returns an InvalidParameterValue error.
*/
public String getVersionLabel() {
return versionLabel;
}
/**
* If this parameter is specified, AWS Elastic Beanstalk deploys the
* named application version to the environment. If no such application
* version is found, returns an InvalidParameterValue error.
*
* Constraints:
* Length: 1 - 100
*
* @param versionLabel If this parameter is specified, AWS Elastic Beanstalk deploys the
* named application version to the environment. If no such application
* version is found, returns an InvalidParameterValue error.
*/
public void setVersionLabel(String versionLabel) {
this.versionLabel = versionLabel;
}
/**
* If this parameter is specified, AWS Elastic Beanstalk deploys the
* named application version to the environment. If no such application
* version is found, returns an InvalidParameterValue error.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 100
*
* @param versionLabel If this parameter is specified, AWS Elastic Beanstalk deploys the
* named application version to the environment. If no such application
* version is found, returns an InvalidParameterValue error.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateEnvironmentRequest withVersionLabel(String versionLabel) {
this.versionLabel = versionLabel;
return this;
}
/**
* If this parameter is specified, AWS Elastic Beanstalk deploys this
* configuration template to the environment. If no such configuration
* template is found, AWS Elastic Beanstalk returns an
* InvalidParameterValue error.
*
* Constraints:
* Length: 1 - 100
*
* @return If this parameter is specified, AWS Elastic Beanstalk deploys this
* configuration template to the environment. If no such configuration
* template is found, AWS Elastic Beanstalk returns an
* InvalidParameterValue error.
*/
public String getTemplateName() {
return templateName;
}
/**
* If this parameter is specified, AWS Elastic Beanstalk deploys this
* configuration template to the environment. If no such configuration
* template is found, AWS Elastic Beanstalk returns an
* InvalidParameterValue error.
*
* Constraints:
* Length: 1 - 100
*
* @param templateName If this parameter is specified, AWS Elastic Beanstalk deploys this
* configuration template to the environment. If no such configuration
* template is found, AWS Elastic Beanstalk returns an
* InvalidParameterValue error.
*/
public void setTemplateName(String templateName) {
this.templateName = templateName;
}
/**
* If this parameter is specified, AWS Elastic Beanstalk deploys this
* configuration template to the environment. If no such configuration
* template is found, AWS Elastic Beanstalk returns an
* InvalidParameterValue error.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 100
*
* @param templateName If this parameter is specified, AWS Elastic Beanstalk deploys this
* configuration template to the environment. If no such configuration
* template is found, AWS Elastic Beanstalk returns an
* InvalidParameterValue error.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateEnvironmentRequest withTemplateName(String templateName) {
this.templateName = templateName;
return this;
}
/**
* If specified, AWS Elastic Beanstalk updates the configuration set
* associated with the running environment and sets the specified
* configuration options to the requested value.
*
* @return If specified, AWS Elastic Beanstalk updates the configuration set
* associated with the running environment and sets the specified
* configuration options to the requested value.
*/
public java.util.List getOptionSettings() {
if (optionSettings == null) {
optionSettings = new com.amazonaws.internal.ListWithAutoConstructFlag();
optionSettings.setAutoConstruct(true);
}
return optionSettings;
}
/**
* If specified, AWS Elastic Beanstalk updates the configuration set
* associated with the running environment and sets the specified
* configuration options to the requested value.
*
* @param optionSettings If specified, AWS Elastic Beanstalk updates the configuration set
* associated with the running environment and sets the specified
* configuration options to the requested value.
*/
public void setOptionSettings(java.util.Collection optionSettings) {
if (optionSettings == null) {
this.optionSettings = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag optionSettingsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(optionSettings.size());
optionSettingsCopy.addAll(optionSettings);
this.optionSettings = optionSettingsCopy;
}
/**
* If specified, AWS Elastic Beanstalk updates the configuration set
* associated with the running environment and sets the specified
* configuration options to the requested value.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param optionSettings If specified, AWS Elastic Beanstalk updates the configuration set
* associated with the running environment and sets the specified
* configuration options to the requested value.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateEnvironmentRequest withOptionSettings(ConfigurationOptionSetting... optionSettings) {
if (getOptionSettings() == null) setOptionSettings(new java.util.ArrayList(optionSettings.length));
for (ConfigurationOptionSetting value : optionSettings) {
getOptionSettings().add(value);
}
return this;
}
/**
* If specified, AWS Elastic Beanstalk updates the configuration set
* associated with the running environment and sets the specified
* configuration options to the requested value.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param optionSettings If specified, AWS Elastic Beanstalk updates the configuration set
* associated with the running environment and sets the specified
* configuration options to the requested value.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateEnvironmentRequest withOptionSettings(java.util.Collection optionSettings) {
if (optionSettings == null) {
this.optionSettings = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag optionSettingsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(optionSettings.size());
optionSettingsCopy.addAll(optionSettings);
this.optionSettings = optionSettingsCopy;
}
return this;
}
/**
* A list of custom user-defined configuration options to remove from the
* configuration set for this environment.
*
* @return A list of custom user-defined configuration options to remove from the
* configuration set for this environment.
*/
public java.util.List getOptionsToRemove() {
if (optionsToRemove == null) {
optionsToRemove = new com.amazonaws.internal.ListWithAutoConstructFlag();
optionsToRemove.setAutoConstruct(true);
}
return optionsToRemove;
}
/**
* A list of custom user-defined configuration options to remove from the
* configuration set for this environment.
*
* @param optionsToRemove A list of custom user-defined configuration options to remove from the
* configuration set for this environment.
*/
public void setOptionsToRemove(java.util.Collection optionsToRemove) {
if (optionsToRemove == null) {
this.optionsToRemove = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag optionsToRemoveCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(optionsToRemove.size());
optionsToRemoveCopy.addAll(optionsToRemove);
this.optionsToRemove = optionsToRemoveCopy;
}
/**
* A list of custom user-defined configuration options to remove from the
* configuration set for this environment.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param optionsToRemove A list of custom user-defined configuration options to remove from the
* configuration set for this environment.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateEnvironmentRequest withOptionsToRemove(OptionSpecification... optionsToRemove) {
if (getOptionsToRemove() == null) setOptionsToRemove(new java.util.ArrayList(optionsToRemove.length));
for (OptionSpecification value : optionsToRemove) {
getOptionsToRemove().add(value);
}
return this;
}
/**
* A list of custom user-defined configuration options to remove from the
* configuration set for this environment.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param optionsToRemove A list of custom user-defined configuration options to remove from the
* configuration set for this environment.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateEnvironmentRequest withOptionsToRemove(java.util.Collection optionsToRemove) {
if (optionsToRemove == null) {
this.optionsToRemove = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag optionsToRemoveCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(optionsToRemove.size());
optionsToRemoveCopy.addAll(optionsToRemove);
this.optionsToRemove = optionsToRemoveCopy;
}
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 (getDescription() != null) sb.append("Description: " + getDescription() + ",");
if (getTier() != null) sb.append("Tier: " + getTier() + ",");
if (getVersionLabel() != null) sb.append("VersionLabel: " + getVersionLabel() + ",");
if (getTemplateName() != null) sb.append("TemplateName: " + getTemplateName() + ",");
if (getOptionSettings() != null) sb.append("OptionSettings: " + getOptionSettings() + ",");
if (getOptionsToRemove() != null) sb.append("OptionsToRemove: " + getOptionsToRemove() );
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 + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getTier() == null) ? 0 : getTier().hashCode());
hashCode = prime * hashCode + ((getVersionLabel() == null) ? 0 : getVersionLabel().hashCode());
hashCode = prime * hashCode + ((getTemplateName() == null) ? 0 : getTemplateName().hashCode());
hashCode = prime * hashCode + ((getOptionSettings() == null) ? 0 : getOptionSettings().hashCode());
hashCode = prime * hashCode + ((getOptionsToRemove() == null) ? 0 : getOptionsToRemove().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof UpdateEnvironmentRequest == false) return false;
UpdateEnvironmentRequest other = (UpdateEnvironmentRequest)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.getDescription() == null ^ this.getDescription() == null) return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false;
if (other.getTier() == null ^ this.getTier() == null) return false;
if (other.getTier() != null && other.getTier().equals(this.getTier()) == false) return false;
if (other.getVersionLabel() == null ^ this.getVersionLabel() == null) return false;
if (other.getVersionLabel() != null && other.getVersionLabel().equals(this.getVersionLabel()) == 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.getOptionSettings() == null ^ this.getOptionSettings() == null) return false;
if (other.getOptionSettings() != null && other.getOptionSettings().equals(this.getOptionSettings()) == false) return false;
if (other.getOptionsToRemove() == null ^ this.getOptionsToRemove() == null) return false;
if (other.getOptionsToRemove() != null && other.getOptionsToRemove().equals(this.getOptionsToRemove()) == false) return false;
return true;
}
}