All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentRequest Maven / Gradle / Ivy

Go to download

The AWS Java SDK for AWS Elastic Beanstalk module holds the client classes that are used for communicating with AWS Elastic Beanstalk Service

The newest version!
/*
 * 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 update an environment. *

*/ public class UpdateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The name of the application with which the environment is associated. *

*/ private String applicationName; /** *

* 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. *

*/ private String environmentName; /** *

* The name of the group to which the target environment belongs. Specify a * group name only if the environment's name is specified in an environment * manifest and not with the environment name or environment ID parameters. * See Environment Manifest (env.yaml) for details. *

*/ private String groupName; /** *

* If this parameter is specified, AWS Elastic Beanstalk updates the * description of this environment. *

*/ private String description; /** *

* This specifies the tier to use to update the environment. *

*

* Condition: At this time, if you change the tier version, name, or 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. *

*/ 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. *

*/ private String templateName; /** *

* This specifies the platform version that the environment will run after * the environment is updated. *

*/ private String solutionStackName; /** *

* 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.SdkInternalList optionSettings; /** *

* A list of custom user-defined configuration options to remove from the * configuration set for this environment. *

*/ private com.amazonaws.internal.SdkInternalList optionsToRemove; /** *

* The name of the application with which the environment is associated. *

* * @param applicationName * The name of the application with which the environment is * associated. */ public void setApplicationName(String applicationName) { this.applicationName = applicationName; } /** *

* The name of the application with which the environment is associated. *

* * @return The name of the application with which the environment is * associated. */ public String getApplicationName() { return this.applicationName; } /** *

* The name of the application with which the environment is associated. *

* * @param applicationName * The name of the application with which the environment is * associated. * @return Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withApplicationName(String applicationName) { setApplicationName(applicationName); return this; } /** *

* 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. *

* * @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 this.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. * @return Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withEnvironmentId(String environmentId) { setEnvironmentId(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. *

* * @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. *

* * @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 this.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. *

* * @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 Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withEnvironmentName(String environmentName) { setEnvironmentName(environmentName); return this; } /** *

* The name of the group to which the target environment belongs. Specify a * group name only if the environment's name is specified in an environment * manifest and not with the environment name or environment ID parameters. * See Environment Manifest (env.yaml) for details. *

* * @param groupName * The name of the group to which the target environment belongs. * Specify a group name only if the environment's name is specified * in an environment manifest and not with the environment name or * environment ID parameters. See Environment Manifest (env.yaml) for details. */ public void setGroupName(String groupName) { this.groupName = groupName; } /** *

* The name of the group to which the target environment belongs. Specify a * group name only if the environment's name is specified in an environment * manifest and not with the environment name or environment ID parameters. * See Environment Manifest (env.yaml) for details. *

* * @return The name of the group to which the target environment belongs. * Specify a group name only if the environment's name is specified * in an environment manifest and not with the environment name or * environment ID parameters. See Environment Manifest (env.yaml) for details. */ public String getGroupName() { return this.groupName; } /** *

* The name of the group to which the target environment belongs. Specify a * group name only if the environment's name is specified in an environment * manifest and not with the environment name or environment ID parameters. * See Environment Manifest (env.yaml) for details. *

* * @param groupName * The name of the group to which the target environment belongs. * Specify a group name only if the environment's name is specified * in an environment manifest and not with the environment name or * environment ID parameters. See Environment Manifest (env.yaml) for details. * @return Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withGroupName(String groupName) { setGroupName(groupName); return this; } /** *

* If this parameter is specified, AWS Elastic Beanstalk updates the * description of this environment. *

* * @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. *

* * @return If this parameter is specified, AWS Elastic Beanstalk updates the * description of this environment. */ public String getDescription() { return this.description; } /** *

* If this parameter is specified, AWS Elastic Beanstalk updates the * description of this environment. *

* * @param description * If this parameter is specified, AWS Elastic Beanstalk updates the * description of this environment. * @return Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withDescription(String description) { setDescription(description); return this; } /** *

* This specifies the tier to use to update the environment. *

*

* Condition: At this time, if you change the tier version, name, or type, * AWS Elastic Beanstalk returns InvalidParameterValue error. *

* * @param tier * This specifies the tier to use to update the environment.

*

* Condition: At this time, if you change the tier version, name, or * 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: At this time, if you change the tier version, name, or type, * AWS Elastic Beanstalk returns InvalidParameterValue error. *

* * @return This specifies the tier to use to update the environment.

*

* Condition: At this time, if you change the tier version, name, or * type, AWS Elastic Beanstalk returns * InvalidParameterValue error. */ public EnvironmentTier getTier() { return this.tier; } /** *

* This specifies the tier to use to update the environment. *

*

* Condition: At this time, if you change the tier version, name, or type, * AWS Elastic Beanstalk returns InvalidParameterValue error. *

* * @param tier * This specifies the tier to use to update the environment.

*

* Condition: At this time, if you change the tier version, name, or * type, AWS Elastic Beanstalk returns * InvalidParameterValue error. * @return Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withTier(EnvironmentTier tier) { setTier(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. *

* * @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. *

* * @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 this.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. *

* * @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 Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withVersionLabel(String versionLabel) { setVersionLabel(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. *

* * @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. *

* * @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 this.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. *

* * @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 Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withTemplateName(String templateName) { setTemplateName(templateName); return this; } /** *

* This specifies the platform version that the environment will run after * the environment is updated. *

* * @param solutionStackName * This specifies the platform version that the environment will run * after the environment is updated. */ public void setSolutionStackName(String solutionStackName) { this.solutionStackName = solutionStackName; } /** *

* This specifies the platform version that the environment will run after * the environment is updated. *

* * @return This specifies the platform version that the environment will run * after the environment is updated. */ public String getSolutionStackName() { return this.solutionStackName; } /** *

* This specifies the platform version that the environment will run after * the environment is updated. *

* * @param solutionStackName * This specifies the platform version that the environment will run * after the environment is updated. * @return Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withSolutionStackName( String solutionStackName) { setSolutionStackName(solutionStackName); 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.SdkInternalList(); } 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; } this.optionSettings = new com.amazonaws.internal.SdkInternalList( 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. *

*

* NOTE: This method appends the values to the existing list (if * any). Use {@link #setOptionSettings(java.util.Collection)} or * {@link #withOptionSettings(java.util.Collection)} if you want to override * the existing values. *

* * @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 Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withOptionSettings( ConfigurationOptionSetting... optionSettings) { if (this.optionSettings == null) { setOptionSettings(new com.amazonaws.internal.SdkInternalList( optionSettings.length)); } for (ConfigurationOptionSetting ele : optionSettings) { this.optionSettings.add(ele); } 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. *

* * @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 Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withOptionSettings( java.util.Collection optionSettings) { setOptionSettings(optionSettings); 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.SdkInternalList(); } 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; } this.optionsToRemove = new com.amazonaws.internal.SdkInternalList( optionsToRemove); } /** *

* A list of custom user-defined configuration options to remove from the * configuration set for this environment. *

*

* NOTE: This method appends the values to the existing list (if * any). Use {@link #setOptionsToRemove(java.util.Collection)} or * {@link #withOptionsToRemove(java.util.Collection)} if you want to * override the existing values. *

* * @param optionsToRemove * A list of custom user-defined configuration options to remove from * the configuration set for this environment. * @return Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withOptionsToRemove( OptionSpecification... optionsToRemove) { if (this.optionsToRemove == null) { setOptionsToRemove(new com.amazonaws.internal.SdkInternalList( optionsToRemove.length)); } for (OptionSpecification ele : optionsToRemove) { this.optionsToRemove.add(ele); } return this; } /** *

* 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. * @return Returns a reference to this object so that method calls can be * chained together. */ public UpdateEnvironmentRequest withOptionsToRemove( java.util.Collection optionsToRemove) { setOptionsToRemove(optionsToRemove); 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 (getEnvironmentId() != null) sb.append("EnvironmentId: " + getEnvironmentId() + ","); if (getEnvironmentName() != null) sb.append("EnvironmentName: " + getEnvironmentName() + ","); if (getGroupName() != null) sb.append("GroupName: " + getGroupName() + ","); 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 (getSolutionStackName() != null) sb.append("SolutionStackName: " + getSolutionStackName() + ","); if (getOptionSettings() != null) sb.append("OptionSettings: " + getOptionSettings() + ","); if (getOptionsToRemove() != null) sb.append("OptionsToRemove: " + getOptionsToRemove()); sb.append("}"); return sb.toString(); } @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.getApplicationName() == null ^ this.getApplicationName() == null) return false; if (other.getApplicationName() != null && other.getApplicationName().equals(this.getApplicationName()) == false) return false; 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.getGroupName() == null ^ this.getGroupName() == null) return false; if (other.getGroupName() != null && other.getGroupName().equals(this.getGroupName()) == 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.getSolutionStackName() == null ^ this.getSolutionStackName() == null) return false; if (other.getSolutionStackName() != null && other.getSolutionStackName().equals( this.getSolutionStackName()) == 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; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getApplicationName() == null) ? 0 : getApplicationName() .hashCode()); hashCode = prime * hashCode + ((getEnvironmentId() == null) ? 0 : getEnvironmentId() .hashCode()); hashCode = prime * hashCode + ((getEnvironmentName() == null) ? 0 : getEnvironmentName() .hashCode()); hashCode = prime * hashCode + ((getGroupName() == null) ? 0 : getGroupName().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 + ((getSolutionStackName() == null) ? 0 : getSolutionStackName().hashCode()); hashCode = prime * hashCode + ((getOptionSettings() == null) ? 0 : getOptionSettings() .hashCode()); hashCode = prime * hashCode + ((getOptionsToRemove() == null) ? 0 : getOptionsToRemove() .hashCode()); return hashCode; } @Override public UpdateEnvironmentRequest clone() { return (UpdateEnvironmentRequest) super.clone(); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy