/* * Copyright 2018-2023 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 javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *

* Request to terminate an environment. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class TerminateEnvironmentRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The ID of the environment to terminate. *

*

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

*

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

* Indicates whether the associated AWS resources should shut down when the environment is terminated: *

* *

* For more information, see the AWS Elastic * Beanstalk User Guide. *

*

* Default: true *

*

* Valid Values: true | false *

*/ private Boolean terminateResources; /** *

* Terminates the target environment even if another environment in the same group is dependent on it. *

*/ private Boolean forceTerminate; /** *

* The ID of the environment to terminate. *

*

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

*

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

*

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

*

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

*

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

*

* 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 TerminateEnvironmentRequest withEnvironmentId(String environmentId) { setEnvironmentId(environmentId); return this; } /** *

* The name of the environment to terminate. *

*

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

*

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

*

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

*

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

*

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

*

* 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 TerminateEnvironmentRequest withEnvironmentName(String environmentName) { setEnvironmentName(environmentName); return this; } /** *

* Indicates whether the associated AWS resources should shut down when the environment is terminated: *

* *

* For more information, see the AWS Elastic * Beanstalk User Guide. *

*

* Default: true *

*

* Valid Values: true | false *

* * @param terminateResources * Indicates whether the associated AWS resources should shut down when the environment is terminated:

* *

* For more information, see the AWS * Elastic Beanstalk User Guide. *

*

* Default: true *

*

* Valid Values: true | false */ public void setTerminateResources(Boolean terminateResources) { this.terminateResources = terminateResources; } /** *

* Indicates whether the associated AWS resources should shut down when the environment is terminated: *

* *

* For more information, see the AWS Elastic * Beanstalk User Guide. *

*

* Default: true *

*

* Valid Values: true | false *

* * @return Indicates whether the associated AWS resources should shut down when the environment is terminated:

* *

* For more information, see the AWS * Elastic Beanstalk User Guide. *

*

* Default: true *

*

* Valid Values: true | false */ public Boolean getTerminateResources() { return this.terminateResources; } /** *

* Indicates whether the associated AWS resources should shut down when the environment is terminated: *

* *

* For more information, see the AWS Elastic * Beanstalk User Guide. *

*

* Default: true *

*

* Valid Values: true | false *

* * @param terminateResources * Indicates whether the associated AWS resources should shut down when the environment is terminated:

* *

* For more information, see the AWS * Elastic Beanstalk User Guide. *

*

* Default: true *

*

* Valid Values: true | false * @return Returns a reference to this object so that method calls can be chained together. */ public TerminateEnvironmentRequest withTerminateResources(Boolean terminateResources) { setTerminateResources(terminateResources); return this; } /** *

* Indicates whether the associated AWS resources should shut down when the environment is terminated: *

* *

* For more information, see the AWS Elastic * Beanstalk User Guide. *

*

* Default: true *

*

* Valid Values: true | false *

* * @return Indicates whether the associated AWS resources should shut down when the environment is terminated:

* *

* For more information, see the AWS * Elastic Beanstalk User Guide. *

*

* Default: true *

*

* Valid Values: true | false */ public Boolean isTerminateResources() { return this.terminateResources; } /** *

* Terminates the target environment even if another environment in the same group is dependent on it. *

* * @param forceTerminate * Terminates the target environment even if another environment in the same group is dependent on it. */ public void setForceTerminate(Boolean forceTerminate) { this.forceTerminate = forceTerminate; } /** *

* Terminates the target environment even if another environment in the same group is dependent on it. *

* * @return Terminates the target environment even if another environment in the same group is dependent on it. */ public Boolean getForceTerminate() { return this.forceTerminate; } /** *

* Terminates the target environment even if another environment in the same group is dependent on it. *

* * @param forceTerminate * Terminates the target environment even if another environment in the same group is dependent on it. * @return Returns a reference to this object so that method calls can be chained together. */ public TerminateEnvironmentRequest withForceTerminate(Boolean forceTerminate) { setForceTerminate(forceTerminate); return this; } /** *

* Terminates the target environment even if another environment in the same group is dependent on it. *

* * @return Terminates the target environment even if another environment in the same group is dependent on it. */ public Boolean isForceTerminate() { return this.forceTerminate; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @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: ").append(getEnvironmentId()).append(","); if (getEnvironmentName() != null) sb.append("EnvironmentName: ").append(getEnvironmentName()).append(","); if (getTerminateResources() != null) sb.append("TerminateResources: ").append(getTerminateResources()).append(","); if (getForceTerminate() != null) sb.append("ForceTerminate: ").append(getForceTerminate()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof TerminateEnvironmentRequest == false) return false; TerminateEnvironmentRequest other = (TerminateEnvironmentRequest) 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.getTerminateResources() == null ^ this.getTerminateResources() == null) return false; if (other.getTerminateResources() != null && other.getTerminateResources().equals(this.getTerminateResources()) == false) return false; if (other.getForceTerminate() == null ^ this.getForceTerminate() == null) return false; if (other.getForceTerminate() != null && other.getForceTerminate().equals(this.getForceTerminate()) == 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 + ((getTerminateResources() == null) ? 0 : getTerminateResources().hashCode()); hashCode = prime * hashCode + ((getForceTerminate() == null) ? 0 : getForceTerminate().hashCode()); return hashCode; } @Override public TerminateEnvironmentRequest clone() { return (TerminateEnvironmentRequest) super.clone(); } }