Class HttpInstanceSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<HttpInstanceSummary.Builder,
HttpInstanceSummary>
In a response to a DiscoverInstances request,
HttpInstanceSummary
contains information about one instance that matches the values that you specified
in the request.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionIf you included any attributes when you registered the instance, the values of those attributes.static HttpInstanceSummary.Builder
builder()
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 boolean
For responses, this returns true if the service returned a value for the Attributes property.final int
hashCode()
final HealthStatus
If you configured health checking in the service, the current health status of the service instance.final String
If you configured health checking in the service, the current health status of the service instance.final String
The ID of an instance that matches the values that you specified in the request.final String
static Class
<? extends HttpInstanceSummary.Builder> final String
The name of the service that you specified when you registered the instance.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
-
instanceId
The ID of an instance that matches the values that you specified in the request.
- Returns:
- The ID of an instance that matches the values that you specified in the request.
-
namespaceName
The
HttpName
name of the namespace. It's found in theHttpProperties
member of theProperties
member of the namespace.- Returns:
The
HttpName
name of the namespace. It's found in theHttpProperties
member of theProperties
member of the namespace.
-
serviceName
The name of the service that you specified when you registered the instance.
- Returns:
- The name of the service that you specified when you registered the instance.
-
healthStatus
If you configured health checking in the service, the current health status of the service instance.
If the service returns an enum value that is not available in the current SDK version,
healthStatus
will returnHealthStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthStatusAsString()
.- Returns:
- If you configured health checking in the service, the current health status of the service instance.
- See Also:
-
healthStatusAsString
If you configured health checking in the service, the current health status of the service instance.
If the service returns an enum value that is not available in the current SDK version,
healthStatus
will returnHealthStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhealthStatusAsString()
.- Returns:
- If you configured health checking in the service, the current health status of the service instance.
- See Also:
-
hasAttributes
public final boolean hasAttributes()For responses, this returns true if the service returned a value for the Attributes 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. -
attributes
If you included any attributes when you registered the instance, the values of those attributes.
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
hasAttributes()
method.- Returns:
- If you included any attributes when you registered the instance, the values of those attributes.
-
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<HttpInstanceSummary.Builder,
HttpInstanceSummary> - 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
-