Class DescribeHostsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeHostsRequest.Builder,
DescribeHostsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DescribeHostsRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filter()
The filters.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Filter property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the HostIds property.hostIds()
The IDs of the Dedicated Hosts.final Integer
The maximum number of results to return for the request in a single page.final String
The token to use to retrieve the next page of results.static Class
<? extends DescribeHostsRequest.Builder> 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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasFilter
public final boolean hasFilter()For responses, this returns true if the service returned a value for the Filter 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. -
filter
The filters.
-
auto-placement
- Whether auto-placement is enabled or disabled (on
|off
). -
availability-zone
- The Availability Zone of the host. -
client-token
- The idempotency token that you provided when you allocated the host. -
host-reservation-id
- The ID of the reservation assigned to this host. -
instance-type
- The instance type size that the Dedicated Host is configured to support. -
state
- The allocation state of the Dedicated Host (available
|under-assessment
|permanent-failure
|released
|released-permanent-failure
). -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
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
hasFilter()
method.- Returns:
- The filters.
-
auto-placement
- Whether auto-placement is enabled or disabled (on
|off
). -
availability-zone
- The Availability Zone of the host. -
client-token
- The idempotency token that you provided when you allocated the host. -
host-reservation-id
- The ID of the reservation assigned to this host. -
instance-type
- The instance type size that the Dedicated Host is configured to support. -
state
- The allocation state of the Dedicated Host (available
|under-assessment
|permanent-failure
|released
|released-permanent-failure
). -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
-
-
-
hasHostIds
public final boolean hasHostIds()For responses, this returns true if the service returned a value for the HostIds 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. -
hostIds
The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
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
hasHostIds()
method.- Returns:
- The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.
-
maxResults
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned
nextToken
value. This value can be between 5 and 500. IfmaxResults
is given a larger value than 500, you receive an error.You cannot specify this parameter and the host IDs parameter in the same request.
- Returns:
- The maximum number of results to return for the request in a single page. The remaining results can be
seen by sending another request with the returned
nextToken
value. This value can be between 5 and 500. IfmaxResults
is given a larger value than 500, you receive an error.You cannot specify this parameter and the host IDs parameter in the same request.
-
nextToken
The token to use to retrieve the next page of results.
- Returns:
- The token to use to retrieve the next page of results.
-
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<DescribeHostsRequest.Builder,
DescribeHostsRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-