Class InstanceSummary

java.lang.Object
software.amazon.awssdk.services.servicediscovery.model.InstanceSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceSummary.Builder,InstanceSummary>
@Generated("software.amazon.awssdk:codegen") public final class InstanceSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceSummary.Builder,InstanceSummary>

A complex type that contains information about the instances that you registered by using a specified service.

See Also:

  • Method Details

    • id

      public final String id()

      The ID for an instance that you created by using a specified service.

      Returns:
      The ID for an instance that you created by using a specified service.

    • 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 the isEmpty() 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()

      A string map that contains the following information:

      • The attributes that are associated with the instance.

      • For each attribute, the applicable value.

      Supported attribute keys include the following:

      AWS_ALIAS_DNS_NAME

      For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with the load balancer.

      AWS_EC2_INSTANCE_ID (HTTP namespaces only)

      The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

      AWS_INIT_HEALTH_STATUS

      If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

      AWS_INSTANCE_CNAME

      For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for example, example.com).

      AWS_INSTANCE_IPV4

      For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for example, 192.0.2.44).

      AWS_INSTANCE_IPV6

      For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

      AWS_INSTANCE_PORT

      For an SRV record, the value that Route 53 returns for the port. In addition, if the service includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.

      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:
      A string map that contains the following information:

      • The attributes that are associated with the instance.

      • For each attribute, the applicable value.

      Supported attribute keys include the following:

      AWS_ALIAS_DNS_NAME

      For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with the load balancer.

      AWS_EC2_INSTANCE_ID (HTTP namespaces only)

      The Amazon EC2 instance ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

      AWS_INIT_HEALTH_STATUS

      If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

      AWS_INSTANCE_CNAME

      For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for example, example.com).

      AWS_INSTANCE_IPV4

      For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for example, 192.0.2.44).

      AWS_INSTANCE_IPV6

      For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries (for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

      AWS_INSTANCE_PORT

      For an SRV record, the value that Route 53 returns for the port. In addition, if the service includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.

    • toBuilder

      public InstanceSummary.Builder 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 interface ToCopyableBuilder<InstanceSummary.Builder,InstanceSummary>
      Returns:
      a builder for type T

    • builder

      public static InstanceSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InstanceSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.