Class GetInstancesHealthStatusRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetInstancesHealthStatusRequest.Builder,
GetInstancesHealthStatusRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Instances property.An array that contains the IDs of all the instances that you want to get the health status for.final Integer
The maximum number of instances that you want Cloud Map to return in the response to aGetInstancesHealthStatus
request.final String
For the firstGetInstancesHealthStatus
request, omit this value.static Class
<? extends GetInstancesHealthStatusRequest.Builder> final String
The ID of the service that the instance is associated with.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
-
serviceId
The ID of the service that the instance is associated with.
- Returns:
- The ID of the service that the instance is associated with.
-
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
An array that contains the IDs of all the instances that you want to get the health status for.
If you omit
Instances
, Cloud Map returns the health status for all the instances that are associated with the specified service.To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.
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:
- An array that contains the IDs of all the instances that you want to get the health status for.
If you omit
Instances
, Cloud Map returns the health status for all the instances that are associated with the specified service.To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.
-
maxResults
The maximum number of instances that you want Cloud Map to return in the response to a
GetInstancesHealthStatus
request. If you don't specify a value forMaxResults
, Cloud Map returns up to 100 instances.- Returns:
- The maximum number of instances that you want Cloud Map to return in the response to a
GetInstancesHealthStatus
request. If you don't specify a value forMaxResults
, Cloud Map returns up to 100 instances.
-
nextToken
For the first
GetInstancesHealthStatus
request, omit this value.If more than
MaxResults
instances match the specified criteria, you can submit anotherGetInstancesHealthStatus
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.- Returns:
- For the first
GetInstancesHealthStatus
request, omit this value.If more than
MaxResults
instances match the specified criteria, you can submit anotherGetInstancesHealthStatus
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.
-
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<GetInstancesHealthStatusRequest.Builder,
GetInstancesHealthStatusRequest> - Specified by:
toBuilder
in classServiceDiscoveryRequest
- 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
-