Class TargetSummary

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

Summary information about a target.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target type is ALB, this is the ARN of an Application Load Balancer.

      Returns:
      The ID of the target. If the target group type is INSTANCE, this is an instance ID. If the target group type is IP, this is an IP address. If the target group type is LAMBDA, this is the ARN of a Lambda function. If the target type is ALB, this is the ARN of an Application Load Balancer.

    • port

      public final Integer port()

      The port on which the target is listening.

      Returns:
      The port on which the target is listening.

    • reasonCode

      public final String reasonCode()

      The code for why the target status is what it is.

      Returns:
      The code for why the target status is what it is.

    • status

      public final TargetStatus status()

      The status of the target.

      • DRAINING: The target is being deregistered. No new connections are sent to this target while current connections are being drained. The default draining time is 5 minutes.

      • UNAVAILABLE: Health checks are unavailable for the target group.

      • HEALTHY: The target is healthy.

      • UNHEALTHY: The target is unhealthy.

      • INITIAL: Initial health checks on the target are being performed.

      • UNUSED: Target group is not used in a service.

      If the service returns an enum value that is not available in the current SDK version, status will return TargetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the target.

      • DRAINING: The target is being deregistered. No new connections are sent to this target while current connections are being drained. The default draining time is 5 minutes.

      • UNAVAILABLE: Health checks are unavailable for the target group.

      • HEALTHY: The target is healthy.

      • UNHEALTHY: The target is unhealthy.

      • INITIAL: Initial health checks on the target are being performed.

      • UNUSED: Target group is not used in a service.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the target.

      • DRAINING: The target is being deregistered. No new connections are sent to this target while current connections are being drained. The default draining time is 5 minutes.

      • UNAVAILABLE: Health checks are unavailable for the target group.

      • HEALTHY: The target is healthy.

      • UNHEALTHY: The target is unhealthy.

      • INITIAL: Initial health checks on the target are being performed.

      • UNUSED: Target group is not used in a service.

      If the service returns an enum value that is not available in the current SDK version, status will return TargetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the target.

      • DRAINING: The target is being deregistered. No new connections are sent to this target while current connections are being drained. The default draining time is 5 minutes.

      • UNAVAILABLE: Health checks are unavailable for the target group.

      • HEALTHY: The target is healthy.

      • UNHEALTHY: The target is unhealthy.

      • INITIAL: Initial health checks on the target are being performed.

      • UNUSED: Target group is not used in a service.

      See Also:

    • toBuilder

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

    • builder

      public static TargetSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TargetSummary.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.