Class Host
- java.lang.Object
-
- com.amazonaws.services.ec2.model.Host
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class Host extends Object implements Serializable, Cloneable
Describes the properties of the Dedicated host.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Host()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Host
clone()
boolean
equals(Object obj)
String
getAutoPlacement()
Whether auto-placement is on or off.String
getAvailabilityZone()
The Availability Zone of the Dedicated host.AvailableCapacity
getAvailableCapacity()
The number of new instances that can be launched onto the Dedicated host.String
getClientToken()
Unique, case-sensitive identifier you provide to ensure idempotency of the request.String
getHostId()
The ID of the Dedicated host.HostProperties
getHostProperties()
The hardware specifications of the Dedicated host.String
getHostReservationId()
The reservation ID of the Dedicated host.List<HostInstance>
getInstances()
The IDs and instance type that are currently running on the Dedicated host.String
getState()
The Dedicated host's state.int
hashCode()
void
setAutoPlacement(AutoPlacement autoPlacement)
Whether auto-placement is on or off.void
setAutoPlacement(String autoPlacement)
Whether auto-placement is on or off.void
setAvailabilityZone(String availabilityZone)
The Availability Zone of the Dedicated host.void
setAvailableCapacity(AvailableCapacity availableCapacity)
The number of new instances that can be launched onto the Dedicated host.void
setClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request.void
setHostId(String hostId)
The ID of the Dedicated host.void
setHostProperties(HostProperties hostProperties)
The hardware specifications of the Dedicated host.void
setHostReservationId(String hostReservationId)
The reservation ID of the Dedicated host.void
setInstances(Collection<HostInstance> instances)
The IDs and instance type that are currently running on the Dedicated host.void
setState(AllocationState state)
The Dedicated host's state.void
setState(String state)
The Dedicated host's state.String
toString()
Returns a string representation of this object; useful for testing and debugging.Host
withAutoPlacement(AutoPlacement autoPlacement)
Whether auto-placement is on or off.Host
withAutoPlacement(String autoPlacement)
Whether auto-placement is on or off.Host
withAvailabilityZone(String availabilityZone)
The Availability Zone of the Dedicated host.Host
withAvailableCapacity(AvailableCapacity availableCapacity)
The number of new instances that can be launched onto the Dedicated host.Host
withClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request.Host
withHostId(String hostId)
The ID of the Dedicated host.Host
withHostProperties(HostProperties hostProperties)
The hardware specifications of the Dedicated host.Host
withHostReservationId(String hostReservationId)
The reservation ID of the Dedicated host.Host
withInstances(HostInstance... instances)
The IDs and instance type that are currently running on the Dedicated host.Host
withInstances(Collection<HostInstance> instances)
The IDs and instance type that are currently running on the Dedicated host.Host
withState(AllocationState state)
The Dedicated host's state.Host
withState(String state)
The Dedicated host's state.
-
-
-
Method Detail
-
setHostId
public void setHostId(String hostId)
The ID of the Dedicated host.
- Parameters:
hostId
- The ID of the Dedicated host.
-
getHostId
public String getHostId()
The ID of the Dedicated host.
- Returns:
- The ID of the Dedicated host.
-
withHostId
public Host withHostId(String hostId)
The ID of the Dedicated host.
- Parameters:
hostId
- The ID of the Dedicated host.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAutoPlacement
public void setAutoPlacement(String autoPlacement)
Whether auto-placement is on or off.
- Parameters:
autoPlacement
- Whether auto-placement is on or off.- See Also:
AutoPlacement
-
getAutoPlacement
public String getAutoPlacement()
Whether auto-placement is on or off.
- Returns:
- Whether auto-placement is on or off.
- See Also:
AutoPlacement
-
withAutoPlacement
public Host withAutoPlacement(String autoPlacement)
Whether auto-placement is on or off.
- Parameters:
autoPlacement
- Whether auto-placement is on or off.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AutoPlacement
-
setAutoPlacement
public void setAutoPlacement(AutoPlacement autoPlacement)
Whether auto-placement is on or off.
- Parameters:
autoPlacement
- Whether auto-placement is on or off.- See Also:
AutoPlacement
-
withAutoPlacement
public Host withAutoPlacement(AutoPlacement autoPlacement)
Whether auto-placement is on or off.
- Parameters:
autoPlacement
- Whether auto-placement is on or off.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AutoPlacement
-
setHostReservationId
public void setHostReservationId(String hostReservationId)
The reservation ID of the Dedicated host. This returns a
null
response if the Dedicated host doesn't have an associated reservation.- Parameters:
hostReservationId
- The reservation ID of the Dedicated host. This returns anull
response if the Dedicated host doesn't have an associated reservation.
-
getHostReservationId
public String getHostReservationId()
The reservation ID of the Dedicated host. This returns a
null
response if the Dedicated host doesn't have an associated reservation.- Returns:
- The reservation ID of the Dedicated host. This returns a
null
response if the Dedicated host doesn't have an associated reservation.
-
withHostReservationId
public Host withHostReservationId(String hostReservationId)
The reservation ID of the Dedicated host. This returns a
null
response if the Dedicated host doesn't have an associated reservation.- Parameters:
hostReservationId
- The reservation ID of the Dedicated host. This returns anull
response if the Dedicated host doesn't have an associated reservation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setClientToken
public void setClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
- Parameters:
clientToken
- Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
-
getClientToken
public String getClientToken()
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
- Returns:
- Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
-
withClientToken
public Host withClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
- Parameters:
clientToken
- Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHostProperties
public void setHostProperties(HostProperties hostProperties)
The hardware specifications of the Dedicated host.
- Parameters:
hostProperties
- The hardware specifications of the Dedicated host.
-
getHostProperties
public HostProperties getHostProperties()
The hardware specifications of the Dedicated host.
- Returns:
- The hardware specifications of the Dedicated host.
-
withHostProperties
public Host withHostProperties(HostProperties hostProperties)
The hardware specifications of the Dedicated host.
- Parameters:
hostProperties
- The hardware specifications of the Dedicated host.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setState
public void setState(String state)
The Dedicated host's state.
- Parameters:
state
- The Dedicated host's state.- See Also:
AllocationState
-
getState
public String getState()
The Dedicated host's state.
- Returns:
- The Dedicated host's state.
- See Also:
AllocationState
-
withState
public Host withState(String state)
The Dedicated host's state.
- Parameters:
state
- The Dedicated host's state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AllocationState
-
setState
public void setState(AllocationState state)
The Dedicated host's state.
- Parameters:
state
- The Dedicated host's state.- See Also:
AllocationState
-
withState
public Host withState(AllocationState state)
The Dedicated host's state.
- Parameters:
state
- The Dedicated host's state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AllocationState
-
setAvailabilityZone
public void setAvailabilityZone(String availabilityZone)
The Availability Zone of the Dedicated host.
- Parameters:
availabilityZone
- The Availability Zone of the Dedicated host.
-
getAvailabilityZone
public String getAvailabilityZone()
The Availability Zone of the Dedicated host.
- Returns:
- The Availability Zone of the Dedicated host.
-
withAvailabilityZone
public Host withAvailabilityZone(String availabilityZone)
The Availability Zone of the Dedicated host.
- Parameters:
availabilityZone
- The Availability Zone of the Dedicated host.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getInstances
public List<HostInstance> getInstances()
The IDs and instance type that are currently running on the Dedicated host.
- Returns:
- The IDs and instance type that are currently running on the Dedicated host.
-
setInstances
public void setInstances(Collection<HostInstance> instances)
The IDs and instance type that are currently running on the Dedicated host.
- Parameters:
instances
- The IDs and instance type that are currently running on the Dedicated host.
-
withInstances
public Host withInstances(HostInstance... 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
setInstances(java.util.Collection)
orwithInstances(java.util.Collection)
if you want to override the existing values.- Parameters:
instances
- The IDs and instance type that are currently running on the Dedicated host.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withInstances
public Host withInstances(Collection<HostInstance> instances)
The IDs and instance type that are currently running on the Dedicated host.
- Parameters:
instances
- The IDs and instance type that are currently running on the Dedicated host.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAvailableCapacity
public void setAvailableCapacity(AvailableCapacity availableCapacity)
The number of new instances that can be launched onto the Dedicated host.
- Parameters:
availableCapacity
- The number of new instances that can be launched onto the Dedicated host.
-
getAvailableCapacity
public AvailableCapacity getAvailableCapacity()
The number of new instances that can be launched onto the Dedicated host.
- Returns:
- The number of new instances that can be launched onto the Dedicated host.
-
withAvailableCapacity
public Host withAvailableCapacity(AvailableCapacity availableCapacity)
The number of new instances that can be launched onto the Dedicated host.
- Parameters:
availableCapacity
- The number of new instances that can be launched onto the Dedicated host.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
-