Class HttpInstanceSummary
- java.lang.Object
-
- software.amazon.awssdk.services.servicediscovery.model.HttpInstanceSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<HttpInstanceSummary.Builder,HttpInstanceSummary>
@Generated("software.amazon.awssdk:codegen") public final class HttpInstanceSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HttpInstanceSummary.Builder,HttpInstanceSummary>
In a response to a DiscoverInstances request,
HttpInstanceSummarycontains information about one instance that matches the values that you specified in the request.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceHttpInstanceSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,String>attributes()If you included any attributes when you registered the instance, the values of those attributes.static HttpInstanceSummary.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAttributes()For responses, this returns true if the service returned a value for the Attributes property.inthashCode()HealthStatushealthStatus()If you configured health checking in the service, the current health status of the service instance.StringhealthStatusAsString()If you configured health checking in the service, the current health status of the service instance.StringinstanceId()The ID of an instance that matches the values that you specified in the request.StringnamespaceName()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends HttpInstanceSummary.Builder>serializableBuilderClass()StringserviceName()The name of the service that you specified when you registered the instance.HttpInstanceSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
instanceId
public final String 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
public final String namespaceName()
The
HttpNamename of the namespace. It's found in theHttpPropertiesmember of thePropertiesmember of the namespace.- Returns:
The
HttpNamename of the namespace. It's found in theHttpPropertiesmember of thePropertiesmember of the namespace.
-
serviceName
public final String 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
public final HealthStatus 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,
healthStatuswill 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:
HealthStatus
-
healthStatusAsString
public final String 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,
healthStatuswill 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:
HealthStatus
-
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
public final Map<String,String> 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
public HttpInstanceSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<HttpInstanceSummary.Builder,HttpInstanceSummary>
-
builder
public static HttpInstanceSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends HttpInstanceSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-