com.amazonaws.services.ec2.model.InstanceState Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 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.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Describes the current state of an instance.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class InstanceState implements Serializable, Cloneable {
/**
*
* The state of the instance as a 16-bit unsigned integer.
*
*
* The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535.
* These numerical values are used for internal purposes and should be ignored.
*
*
* The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
*
*
* The valid values for instance-state-code will all be in the range of the low byte and they are:
*
*
* -
*
* 0 : pending
*
*
* -
*
* 16 : running
*
*
* -
*
* 32 : shutting-down
*
*
* -
*
* 48 : terminated
*
*
* -
*
* 64 : stopping
*
*
* -
*
* 80 : stopped
*
*
*
*
* You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
*
*/
private Integer code;
/**
*
* The current state of the instance.
*
*/
private String name;
/**
*
* The state of the instance as a 16-bit unsigned integer.
*
*
* The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535.
* These numerical values are used for internal purposes and should be ignored.
*
*
* The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
*
*
* The valid values for instance-state-code will all be in the range of the low byte and they are:
*
*
* -
*
* 0 : pending
*
*
* -
*
* 16 : running
*
*
* -
*
* 32 : shutting-down
*
*
* -
*
* 48 : terminated
*
*
* -
*
* 64 : stopping
*
*
* -
*
* 80 : stopped
*
*
*
*
* You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
*
*
* @param code
* The state of the instance as a 16-bit unsigned integer.
*
* The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and
* 65,535. These numerical values are used for internal purposes and should be ignored.
*
*
* The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
*
*
* The valid values for instance-state-code will all be in the range of the low byte and they are:
*
*
* -
*
* 0 : pending
*
*
* -
*
* 16 : running
*
*
* -
*
* 32 : shutting-down
*
*
* -
*
* 48 : terminated
*
*
* -
*
* 64 : stopping
*
*
* -
*
* 80 : stopped
*
*
*
*
* You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
*/
public void setCode(Integer code) {
this.code = code;
}
/**
*
* The state of the instance as a 16-bit unsigned integer.
*
*
* The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535.
* These numerical values are used for internal purposes and should be ignored.
*
*
* The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
*
*
* The valid values for instance-state-code will all be in the range of the low byte and they are:
*
*
* -
*
* 0 : pending
*
*
* -
*
* 16 : running
*
*
* -
*
* 32 : shutting-down
*
*
* -
*
* 48 : terminated
*
*
* -
*
* 64 : stopping
*
*
* -
*
* 80 : stopped
*
*
*
*
* You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
*
*
* @return The state of the instance as a 16-bit unsigned integer.
*
* The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and
* 65,535. These numerical values are used for internal purposes and should be ignored.
*
*
* The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
*
*
* The valid values for instance-state-code will all be in the range of the low byte and they are:
*
*
* -
*
* 0 : pending
*
*
* -
*
* 16 : running
*
*
* -
*
* 32 : shutting-down
*
*
* -
*
* 48 : terminated
*
*
* -
*
* 64 : stopping
*
*
* -
*
* 80 : stopped
*
*
*
*
* You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
*/
public Integer getCode() {
return this.code;
}
/**
*
* The state of the instance as a 16-bit unsigned integer.
*
*
* The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535.
* These numerical values are used for internal purposes and should be ignored.
*
*
* The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
*
*
* The valid values for instance-state-code will all be in the range of the low byte and they are:
*
*
* -
*
* 0 : pending
*
*
* -
*
* 16 : running
*
*
* -
*
* 32 : shutting-down
*
*
* -
*
* 48 : terminated
*
*
* -
*
* 64 : stopping
*
*
* -
*
* 80 : stopped
*
*
*
*
* You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
*
*
* @param code
* The state of the instance as a 16-bit unsigned integer.
*
* The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and
* 65,535. These numerical values are used for internal purposes and should be ignored.
*
*
* The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
*
*
* The valid values for instance-state-code will all be in the range of the low byte and they are:
*
*
* -
*
* 0 : pending
*
*
* -
*
* 16 : running
*
*
* -
*
* 32 : shutting-down
*
*
* -
*
* 48 : terminated
*
*
* -
*
* 64 : stopping
*
*
* -
*
* 80 : stopped
*
*
*
*
* You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceState withCode(Integer code) {
setCode(code);
return this;
}
/**
*
* The current state of the instance.
*
*
* @param name
* The current state of the instance.
* @see InstanceStateName
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The current state of the instance.
*
*
* @return The current state of the instance.
* @see InstanceStateName
*/
public String getName() {
return this.name;
}
/**
*
* The current state of the instance.
*
*
* @param name
* The current state of the instance.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceStateName
*/
public InstanceState withName(String name) {
setName(name);
return this;
}
/**
*
* The current state of the instance.
*
*
* @param name
* The current state of the instance.
* @see InstanceStateName
*/
public void setName(InstanceStateName name) {
withName(name);
}
/**
*
* The current state of the instance.
*
*
* @param name
* The current state of the instance.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceStateName
*/
public InstanceState withName(InstanceStateName name) {
this.name = name.toString();
return this;
}
/**
* 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 (getCode() != null)
sb.append("Code: ").append(getCode()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof InstanceState == false)
return false;
InstanceState other = (InstanceState) obj;
if (other.getCode() == null ^ this.getCode() == null)
return false;
if (other.getCode() != null && other.getCode().equals(this.getCode()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCode() == null) ? 0 : getCode().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
return hashCode;
}
@Override
public InstanceState clone() {
try {
return (InstanceState) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}