Class Host
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Host.Builder,
Host>
Describes the properties of the Dedicated Host.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Instant
The time that the Dedicated Host was allocated.Indicates whether the Dedicated Host supports multiple instance types of the same instance family.final String
Indicates whether the Dedicated Host supports multiple instance types of the same instance family.final String
assetId()
The ID of the Outpost hardware asset on which the Dedicated Host is allocated.final AutoPlacement
Whether auto-placement is on or off.final String
Whether auto-placement is on or off.final String
The Availability Zone of the Dedicated Host.final String
The ID of the Availability Zone in which the Dedicated Host is allocated.final AvailableCapacity
Information about the instances running on the Dedicated Host.static Host.Builder
builder()
final String
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Instances property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
hostId()
The ID of the Dedicated Host.final HostMaintenance
Indicates whether host maintenance is enabled or disabled for the Dedicated Host.final String
Indicates whether host maintenance is enabled or disabled for the Dedicated Host.final HostProperties
The hardware specifications of the Dedicated Host.final HostRecovery
Indicates whether host recovery is enabled or disabled for the Dedicated Host.final String
Indicates whether host recovery is enabled or disabled for the Dedicated Host.final String
The reservation ID of the Dedicated Host.final List
<HostInstance> The IDs and instance type that are currently running on the Dedicated Host.final Boolean
Indicates whether the Dedicated Host is in a host resource group.final String
The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.final String
ownerId()
The ID of the Amazon Web Services account that owns the Dedicated Host.final Instant
The time that the Dedicated Host was released.static Class
<? extends Host.Builder> final AllocationState
state()
The Dedicated Host's state.final String
The Dedicated Host's state.tags()
Any tags assigned to the Dedicated Host.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
autoPlacement
Whether auto-placement is on or off.
If the service returns an enum value that is not available in the current SDK version,
autoPlacement
will returnAutoPlacement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromautoPlacementAsString()
.- Returns:
- Whether auto-placement is on or off.
- See Also:
-
autoPlacementAsString
Whether auto-placement is on or off.
If the service returns an enum value that is not available in the current SDK version,
autoPlacement
will returnAutoPlacement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromautoPlacementAsString()
.- Returns:
- Whether auto-placement is on or off.
- See Also:
-
availabilityZone
The Availability Zone of the Dedicated Host.
- Returns:
- The Availability Zone of the Dedicated Host.
-
availableCapacity
Information about the instances running on the Dedicated Host.
- Returns:
- Information about the instances running on the Dedicated Host.
-
clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
- Returns:
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
-
hostId
The ID of the Dedicated Host.
- Returns:
- The ID of the Dedicated Host.
-
hostProperties
The hardware specifications of the Dedicated Host.
- Returns:
- The hardware specifications of the Dedicated Host.
-
hostReservationId
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.
-
hasInstances
public final boolean hasInstances()For responses, this returns true if the service returned a value for the Instances property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
instances
The IDs and instance type that are currently running on the Dedicated Host.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInstances()
method.- Returns:
- The IDs and instance type that are currently running on the Dedicated Host.
-
state
The Dedicated Host's state.
If the service returns an enum value that is not available in the current SDK version,
state
will returnAllocationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The Dedicated Host's state.
- See Also:
-
stateAsString
The Dedicated Host's state.
If the service returns an enum value that is not available in the current SDK version,
state
will returnAllocationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The Dedicated Host's state.
- See Also:
-
allocationTime
The time that the Dedicated Host was allocated.
- Returns:
- The time that the Dedicated Host was allocated.
-
releaseTime
The time that the Dedicated Host was released.
- Returns:
- The time that the Dedicated Host was released.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
Any tags assigned to the Dedicated Host.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Any tags assigned to the Dedicated Host.
-
hostRecovery
Indicates whether host recovery is enabled or disabled for the Dedicated Host.
If the service returns an enum value that is not available in the current SDK version,
hostRecovery
will returnHostRecovery.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhostRecoveryAsString()
.- Returns:
- Indicates whether host recovery is enabled or disabled for the Dedicated Host.
- See Also:
-
hostRecoveryAsString
Indicates whether host recovery is enabled or disabled for the Dedicated Host.
If the service returns an enum value that is not available in the current SDK version,
hostRecovery
will returnHostRecovery.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhostRecoveryAsString()
.- Returns:
- Indicates whether host recovery is enabled or disabled for the Dedicated Host.
- See Also:
-
allowsMultipleInstanceTypes
Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is
on
, the Dedicated Host supports multiple instance types in the instance family. If the value isoff
, the Dedicated Host supports a single instance type only.If the service returns an enum value that is not available in the current SDK version,
allowsMultipleInstanceTypes
will returnAllowsMultipleInstanceTypes.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromallowsMultipleInstanceTypesAsString()
.- Returns:
- Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the
value is
on
, the Dedicated Host supports multiple instance types in the instance family. If the value isoff
, the Dedicated Host supports a single instance type only. - See Also:
-
allowsMultipleInstanceTypesAsString
Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is
on
, the Dedicated Host supports multiple instance types in the instance family. If the value isoff
, the Dedicated Host supports a single instance type only.If the service returns an enum value that is not available in the current SDK version,
allowsMultipleInstanceTypes
will returnAllowsMultipleInstanceTypes.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromallowsMultipleInstanceTypesAsString()
.- Returns:
- Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the
value is
on
, the Dedicated Host supports multiple instance types in the instance family. If the value isoff
, the Dedicated Host supports a single instance type only. - See Also:
-
ownerId
The ID of the Amazon Web Services account that owns the Dedicated Host.
- Returns:
- The ID of the Amazon Web Services account that owns the Dedicated Host.
-
availabilityZoneId
The ID of the Availability Zone in which the Dedicated Host is allocated.
- Returns:
- The ID of the Availability Zone in which the Dedicated Host is allocated.
-
memberOfServiceLinkedResourceGroup
Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is
true
, the host is in a host resource group; otherwise, it is not.- Returns:
- Indicates whether the Dedicated Host is in a host resource group. If
memberOfServiceLinkedResourceGroup is
true
, the host is in a host resource group; otherwise, it is not.
-
outpostArn
The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.
- Returns:
- The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.
-
hostMaintenance
Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
If the service returns an enum value that is not available in the current SDK version,
hostMaintenance
will returnHostMaintenance.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhostMaintenanceAsString()
.- Returns:
- Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
- See Also:
-
hostMaintenanceAsString
Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
If the service returns an enum value that is not available in the current SDK version,
hostMaintenance
will returnHostMaintenance.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhostMaintenanceAsString()
.- Returns:
- Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
- See Also:
-
assetId
The ID of the Outpost hardware asset on which the Dedicated Host is allocated.
- Returns:
- The ID of the Outpost hardware asset on which the Dedicated Host is allocated.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Host.Builder,
Host> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
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. -
getValueForField
-
sdkFields
-