com.amazonaws.services.ec2.model.Host Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2014-2019 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 properties of the Dedicated Host.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Host implements Serializable, Cloneable {
/**
*
* Whether auto-placement is on or off.
*
*/
private String autoPlacement;
/**
*
* The Availability Zone of the Dedicated Host.
*
*/
private String availabilityZone;
/**
*
* The number of new instances that can be launched onto the Dedicated Host.
*
*/
private AvailableCapacity availableCapacity;
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to Ensure
* Idempotency.
*
*/
private String clientToken;
/**
*
* The ID of the Dedicated Host.
*
*/
private String hostId;
/**
*
* The hardware specifications of the Dedicated Host.
*
*/
private HostProperties hostProperties;
/**
*
* The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't
* have an associated reservation.
*
*/
private String hostReservationId;
/**
*
* The IDs and instance type that are currently running on the Dedicated Host.
*
*/
private com.amazonaws.internal.SdkInternalList instances;
/**
*
* The Dedicated Host's state.
*
*/
private String state;
/**
*
* The time that the Dedicated Host was allocated.
*
*/
private java.util.Date allocationTime;
/**
*
* The time that the Dedicated Host was released.
*
*/
private java.util.Date releaseTime;
/**
*
* Any tags assigned to the Dedicated Host.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* Indicates whether host recovery is enabled or disabled for the Dedicated Host.
*
*/
private String hostRecovery;
/**
*
* Whether auto-placement is on or off.
*
*
* @param autoPlacement
* Whether auto-placement is on or off.
* @see AutoPlacement
*/
public void setAutoPlacement(String autoPlacement) {
this.autoPlacement = autoPlacement;
}
/**
*
* Whether auto-placement is on or off.
*
*
* @return Whether auto-placement is on or off.
* @see AutoPlacement
*/
public String getAutoPlacement() {
return this.autoPlacement;
}
/**
*
* Whether auto-placement is on or off.
*
*
* @param autoPlacement
* Whether auto-placement is on or off.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutoPlacement
*/
public Host withAutoPlacement(String autoPlacement) {
setAutoPlacement(autoPlacement);
return this;
}
/**
*
* Whether auto-placement is on or off.
*
*
* @param autoPlacement
* Whether auto-placement is on or off.
* @see AutoPlacement
*/
public void setAutoPlacement(AutoPlacement autoPlacement) {
withAutoPlacement(autoPlacement);
}
/**
*
* Whether auto-placement is on or off.
*
*
* @param autoPlacement
* Whether auto-placement is on or off.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutoPlacement
*/
public Host withAutoPlacement(AutoPlacement autoPlacement) {
this.autoPlacement = autoPlacement.toString();
return this;
}
/**
*
* The Availability Zone of the Dedicated Host.
*
*
* @param availabilityZone
* The Availability Zone of the Dedicated Host.
*/
public void setAvailabilityZone(String availabilityZone) {
this.availabilityZone = availabilityZone;
}
/**
*
* The Availability Zone of the Dedicated Host.
*
*
* @return The Availability Zone of the Dedicated Host.
*/
public String getAvailabilityZone() {
return this.availabilityZone;
}
/**
*
* The Availability Zone of the Dedicated Host.
*
*
* @param availabilityZone
* The Availability Zone of the Dedicated Host.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Host withAvailabilityZone(String availabilityZone) {
setAvailabilityZone(availabilityZone);
return this;
}
/**
*
* The number of new instances that can be launched onto the Dedicated Host.
*
*
* @param availableCapacity
* The number of new instances that can be launched onto the Dedicated Host.
*/
public void setAvailableCapacity(AvailableCapacity availableCapacity) {
this.availableCapacity = availableCapacity;
}
/**
*
* The number of new instances that can be launched onto the Dedicated Host.
*
*
* @return The number of new instances that can be launched onto the Dedicated Host.
*/
public AvailableCapacity getAvailableCapacity() {
return this.availableCapacity;
}
/**
*
* The number of new instances that can be launched onto the Dedicated Host.
*
*
* @param availableCapacity
* The number of new instances that can be launched onto the Dedicated Host.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Host withAvailableCapacity(AvailableCapacity availableCapacity) {
setAvailableCapacity(availableCapacity);
return this;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to Ensure
* Idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to Ensure
* Idempotency.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to Ensure
* Idempotency.
*
*
* @return Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to Ensure
* Idempotency.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to Ensure
* Idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
* information, see How to Ensure
* Idempotency.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Host withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The ID of the Dedicated Host.
*
*
* @param hostId
* The ID of the Dedicated Host.
*/
public void setHostId(String hostId) {
this.hostId = hostId;
}
/**
*
* The ID of the Dedicated Host.
*
*
* @return The ID of the Dedicated Host.
*/
public String getHostId() {
return this.hostId;
}
/**
*
* The ID of the Dedicated Host.
*
*
* @param hostId
* The ID of the Dedicated Host.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Host withHostId(String hostId) {
setHostId(hostId);
return this;
}
/**
*
* The hardware specifications of the Dedicated Host.
*
*
* @param hostProperties
* The hardware specifications of the Dedicated Host.
*/
public void setHostProperties(HostProperties hostProperties) {
this.hostProperties = hostProperties;
}
/**
*
* The hardware specifications of the Dedicated Host.
*
*
* @return The hardware specifications of the Dedicated Host.
*/
public HostProperties getHostProperties() {
return this.hostProperties;
}
/**
*
* The hardware specifications of the Dedicated Host.
*
*
* @param hostProperties
* The hardware specifications of the Dedicated Host.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Host withHostProperties(HostProperties hostProperties) {
setHostProperties(hostProperties);
return this;
}
/**
*
* The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't
* have an associated reservation.
*
*
* @param hostReservationId
* The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host
* doesn't have an associated reservation.
*/
public void setHostReservationId(String hostReservationId) {
this.hostReservationId = hostReservationId;
}
/**
*
* The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't
* have an associated reservation.
*
*
* @return The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host
* doesn't have an associated reservation.
*/
public String getHostReservationId() {
return this.hostReservationId;
}
/**
*
* The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't
* have an associated reservation.
*
*
* @param hostReservationId
* The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host
* doesn't have an associated reservation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Host withHostReservationId(String hostReservationId) {
setHostReservationId(hostReservationId);
return this;
}
/**
*
* The IDs and instance type that are currently running on the Dedicated Host.
*
*
* @return The IDs and instance type that are currently running on the Dedicated Host.
*/
public java.util.List getInstances() {
if (instances == null) {
instances = new com.amazonaws.internal.SdkInternalList();
}
return instances;
}
/**
*
* The IDs and instance type that are currently running on the Dedicated Host.
*
*
* @param instances
* The IDs and instance type that are currently running on the Dedicated Host.
*/
public void setInstances(java.util.Collection instances) {
if (instances == null) {
this.instances = null;
return;
}
this.instances = new com.amazonaws.internal.SdkInternalList(instances);
}
/**
*
* The IDs and instance type that are currently running on the Dedicated Host.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setInstances(java.util.Collection)} or {@link #withInstances(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param instances
* The IDs and instance type that are currently running on the Dedicated Host.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Host withInstances(HostInstance... instances) {
if (this.instances == null) {
setInstances(new com.amazonaws.internal.SdkInternalList(instances.length));
}
for (HostInstance ele : instances) {
this.instances.add(ele);
}
return this;
}
/**
*
* The IDs and instance type that are currently running on the Dedicated Host.
*
*
* @param instances
* The IDs and instance type that are currently running on the Dedicated Host.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Host withInstances(java.util.Collection instances) {
setInstances(instances);
return this;
}
/**
*
* The Dedicated Host's state.
*
*
* @param state
* The Dedicated Host's state.
* @see AllocationState
*/
public void setState(String state) {
this.state = state;
}
/**
*
* The Dedicated Host's state.
*
*
* @return The Dedicated Host's state.
* @see AllocationState
*/
public String getState() {
return this.state;
}
/**
*
* The Dedicated Host's state.
*
*
* @param state
* The Dedicated Host's state.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AllocationState
*/
public Host withState(String state) {
setState(state);
return this;
}
/**
*
* The Dedicated Host's state.
*
*
* @param state
* The Dedicated Host's state.
* @see AllocationState
*/
public void setState(AllocationState state) {
withState(state);
}
/**
*
* The Dedicated Host's state.
*
*
* @param state
* The Dedicated Host's state.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AllocationState
*/
public Host withState(AllocationState state) {
this.state = state.toString();
return this;
}
/**
*
* The time that the Dedicated Host was allocated.
*
*
* @param allocationTime
* The time that the Dedicated Host was allocated.
*/
public void setAllocationTime(java.util.Date allocationTime) {
this.allocationTime = allocationTime;
}
/**
*
* The time that the Dedicated Host was allocated.
*
*
* @return The time that the Dedicated Host was allocated.
*/
public java.util.Date getAllocationTime() {
return this.allocationTime;
}
/**
*
* The time that the Dedicated Host was allocated.
*
*
* @param allocationTime
* The time that the Dedicated Host was allocated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Host withAllocationTime(java.util.Date allocationTime) {
setAllocationTime(allocationTime);
return this;
}
/**
*
* The time that the Dedicated Host was released.
*
*
* @param releaseTime
* The time that the Dedicated Host was released.
*/
public void setReleaseTime(java.util.Date releaseTime) {
this.releaseTime = releaseTime;
}
/**
*
* The time that the Dedicated Host was released.
*
*
* @return The time that the Dedicated Host was released.
*/
public java.util.Date getReleaseTime() {
return this.releaseTime;
}
/**
*
* The time that the Dedicated Host was released.
*
*
* @param releaseTime
* The time that the Dedicated Host was released.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Host withReleaseTime(java.util.Date releaseTime) {
setReleaseTime(releaseTime);
return this;
}
/**
*
* Any tags assigned to the Dedicated Host.
*
*
* @return Any tags assigned to the Dedicated Host.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
*
* Any tags assigned to the Dedicated Host.
*
*
* @param tags
* Any tags assigned to the Dedicated Host.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* Any tags assigned to the Dedicated Host.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Any tags assigned to the Dedicated Host.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Host withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Any tags assigned to the Dedicated Host.
*
*
* @param tags
* Any tags assigned to the Dedicated Host.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Host withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* Indicates whether host recovery is enabled or disabled for the Dedicated Host.
*
*
* @param hostRecovery
* Indicates whether host recovery is enabled or disabled for the Dedicated Host.
* @see HostRecovery
*/
public void setHostRecovery(String hostRecovery) {
this.hostRecovery = hostRecovery;
}
/**
*
* Indicates whether host recovery is enabled or disabled for the Dedicated Host.
*
*
* @return Indicates whether host recovery is enabled or disabled for the Dedicated Host.
* @see HostRecovery
*/
public String getHostRecovery() {
return this.hostRecovery;
}
/**
*
* Indicates whether host recovery is enabled or disabled for the Dedicated Host.
*
*
* @param hostRecovery
* Indicates whether host recovery is enabled or disabled for the Dedicated Host.
* @return Returns a reference to this object so that method calls can be chained together.
* @see HostRecovery
*/
public Host withHostRecovery(String hostRecovery) {
setHostRecovery(hostRecovery);
return this;
}
/**
*
* Indicates whether host recovery is enabled or disabled for the Dedicated Host.
*
*
* @param hostRecovery
* Indicates whether host recovery is enabled or disabled for the Dedicated Host.
* @see HostRecovery
*/
public void setHostRecovery(HostRecovery hostRecovery) {
withHostRecovery(hostRecovery);
}
/**
*
* Indicates whether host recovery is enabled or disabled for the Dedicated Host.
*
*
* @param hostRecovery
* Indicates whether host recovery is enabled or disabled for the Dedicated Host.
* @return Returns a reference to this object so that method calls can be chained together.
* @see HostRecovery
*/
public Host withHostRecovery(HostRecovery hostRecovery) {
this.hostRecovery = hostRecovery.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 (getAutoPlacement() != null)
sb.append("AutoPlacement: ").append(getAutoPlacement()).append(",");
if (getAvailabilityZone() != null)
sb.append("AvailabilityZone: ").append(getAvailabilityZone()).append(",");
if (getAvailableCapacity() != null)
sb.append("AvailableCapacity: ").append(getAvailableCapacity()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getHostId() != null)
sb.append("HostId: ").append(getHostId()).append(",");
if (getHostProperties() != null)
sb.append("HostProperties: ").append(getHostProperties()).append(",");
if (getHostReservationId() != null)
sb.append("HostReservationId: ").append(getHostReservationId()).append(",");
if (getInstances() != null)
sb.append("Instances: ").append(getInstances()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getAllocationTime() != null)
sb.append("AllocationTime: ").append(getAllocationTime()).append(",");
if (getReleaseTime() != null)
sb.append("ReleaseTime: ").append(getReleaseTime()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getHostRecovery() != null)
sb.append("HostRecovery: ").append(getHostRecovery());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Host == false)
return false;
Host other = (Host) obj;
if (other.getAutoPlacement() == null ^ this.getAutoPlacement() == null)
return false;
if (other.getAutoPlacement() != null && other.getAutoPlacement().equals(this.getAutoPlacement()) == false)
return false;
if (other.getAvailabilityZone() == null ^ this.getAvailabilityZone() == null)
return false;
if (other.getAvailabilityZone() != null && other.getAvailabilityZone().equals(this.getAvailabilityZone()) == false)
return false;
if (other.getAvailableCapacity() == null ^ this.getAvailableCapacity() == null)
return false;
if (other.getAvailableCapacity() != null && other.getAvailableCapacity().equals(this.getAvailableCapacity()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getHostId() == null ^ this.getHostId() == null)
return false;
if (other.getHostId() != null && other.getHostId().equals(this.getHostId()) == false)
return false;
if (other.getHostProperties() == null ^ this.getHostProperties() == null)
return false;
if (other.getHostProperties() != null && other.getHostProperties().equals(this.getHostProperties()) == false)
return false;
if (other.getHostReservationId() == null ^ this.getHostReservationId() == null)
return false;
if (other.getHostReservationId() != null && other.getHostReservationId().equals(this.getHostReservationId()) == false)
return false;
if (other.getInstances() == null ^ this.getInstances() == null)
return false;
if (other.getInstances() != null && other.getInstances().equals(this.getInstances()) == false)
return false;
if (other.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == false)
return false;
if (other.getAllocationTime() == null ^ this.getAllocationTime() == null)
return false;
if (other.getAllocationTime() != null && other.getAllocationTime().equals(this.getAllocationTime()) == false)
return false;
if (other.getReleaseTime() == null ^ this.getReleaseTime() == null)
return false;
if (other.getReleaseTime() != null && other.getReleaseTime().equals(this.getReleaseTime()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getHostRecovery() == null ^ this.getHostRecovery() == null)
return false;
if (other.getHostRecovery() != null && other.getHostRecovery().equals(this.getHostRecovery()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAutoPlacement() == null) ? 0 : getAutoPlacement().hashCode());
hashCode = prime * hashCode + ((getAvailabilityZone() == null) ? 0 : getAvailabilityZone().hashCode());
hashCode = prime * hashCode + ((getAvailableCapacity() == null) ? 0 : getAvailableCapacity().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getHostId() == null) ? 0 : getHostId().hashCode());
hashCode = prime * hashCode + ((getHostProperties() == null) ? 0 : getHostProperties().hashCode());
hashCode = prime * hashCode + ((getHostReservationId() == null) ? 0 : getHostReservationId().hashCode());
hashCode = prime * hashCode + ((getInstances() == null) ? 0 : getInstances().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getAllocationTime() == null) ? 0 : getAllocationTime().hashCode());
hashCode = prime * hashCode + ((getReleaseTime() == null) ? 0 : getReleaseTime().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getHostRecovery() == null) ? 0 : getHostRecovery().hashCode());
return hashCode;
}
@Override
public Host clone() {
try {
return (Host) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}