Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 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;
 
 
Container for the parameters to the TerminateEnvironment operation.

Terminates the specified environment.

 
 public class TerminateEnvironmentRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
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.

Constraints:
Length: 4 - 23

 
     private String environmentName;

    
Indicates whether the associated AWS resources should shut down when the environment is terminated: <enumValues> <value name="true">

true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment. </value> <value name="false">

false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate. </value> </enumValues>

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

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

Default: true

Valid Values: true | false

 
     private Boolean terminateResources;

    
Default constructor for a new TerminateEnvironmentRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
 
     public TerminateEnvironmentRequest() {}
    
    
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.

Returns:
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 ;
     }
    
    
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.

Parameters:
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;
    }
    
    
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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.

Returns:
A reference to this updated object so that method calls can be chained together.
    public TerminateEnvironmentRequest withEnvironmentId(String environmentId) {
        this. = 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.

Constraints:
Length: 4 - 23

Returns:
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 ;
    }
    
    
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.

Constraints:
Length: 4 - 23

Parameters:
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;
    }
    
    
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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 4 - 23

Parameters:
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.

Returns:
A reference to this updated object so that method calls can be chained together.
    public TerminateEnvironmentRequest withEnvironmentName(String environmentName) {
        this. = environmentName;
        return this;
    }

    
Indicates whether the associated AWS resources should shut down when the environment is terminated: <enumValues> <value name="true">

true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment. </value> <value name="false">

false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate. </value> </enumValues>

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

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

Default: true

Valid Values: true | false

Returns:
Indicates whether the associated AWS resources should shut down when the environment is terminated: <enumValues> <value name="true">

true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment. </value> <value name="false">

false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate. </value> </enumValues>

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

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

Default: true

Valid Values: true | false

    public Boolean isTerminateResources() {
        return ;
    }
    
    
Indicates whether the associated AWS resources should shut down when the environment is terminated: <enumValues> <value name="true">

true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment. </value> <value name="false">

false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate. </value> </enumValues>

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

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

Default: true

Valid Values: true | false

Parameters:
terminateResources Indicates whether the associated AWS resources should shut down when the environment is terminated: <enumValues> <value name="true">

true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment. </value> <value name="false">

false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate. </value> </enumValues>

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

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

Default: true

Valid Values: true | false

    public void setTerminateResources(Boolean terminateResources) {
        this. = terminateResources;
    }
    
    
Indicates whether the associated AWS resources should shut down when the environment is terminated: <enumValues> <value name="true">

true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment. </value> <value name="false">

false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate. </value> </enumValues>

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

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

Default: true

Valid Values: true | false

Returns a reference to this object so that method calls can be chained together.

Parameters:
terminateResources Indicates whether the associated AWS resources should shut down when the environment is terminated: <enumValues> <value name="true">

true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment. </value> <value name="false">

false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate. </value> </enumValues>

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

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

Default: true

Valid Values: true | false

Returns:
A reference to this updated object so that method calls can be chained together.
    public TerminateEnvironmentRequest withTerminateResources(Boolean terminateResources) {
        this. = terminateResources;
        return this;
    }

    
Indicates whether the associated AWS resources should shut down when the environment is terminated: <enumValues> <value name="true">

true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment. </value> <value name="false">

false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate. </value> </enumValues>

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

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

Default: true

Valid Values: true | false

Returns:
Indicates whether the associated AWS resources should shut down when the environment is terminated: <enumValues> <value name="true">

true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment. </value> <value name="false">

false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate. </value> </enumValues>

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

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

Default: true

Valid Values: true | false

    public Boolean getTerminateResources() {
        return ;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getEnvironmentId() != nullsb.append("EnvironmentId: " + getEnvironmentId() + ",");
        if (getEnvironmentName() != nullsb.append("EnvironmentName: " + getEnvironmentName() + ",");
        if (isTerminateResources() != nullsb.append("TerminateResources: " + isTerminateResources() );
        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 + ((isTerminateResources() == null) ? 0 : isTerminateResources().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof TerminateEnvironmentRequest == falsereturn false;
        
        if (other.getEnvironmentId() == null ^ this.getEnvironmentId() == nullreturn false;
        if (other.getEnvironmentId() != null && other.getEnvironmentId().equals(this.getEnvironmentId()) == falsereturn false
        if (other.getEnvironmentName() == null ^ this.getEnvironmentName() == nullreturn false;
        if (other.getEnvironmentName() != null && other.getEnvironmentName().equals(this.getEnvironmentName()) == falsereturn false
        if (other.isTerminateResources() == null ^ this.isTerminateResources() == nullreturn false;
        if (other.isTerminateResources() != null && other.isTerminateResources().equals(this.isTerminateResources()) == falsereturn false
        return true;
    }
    
    @Override
        
            return (TerminateEnvironmentRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X