Class TargetHealth

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

Information about the connection health of an RDS Proxy target.

See Also:

  • Method Details

    • state

      public final TargetState state()

      The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

      registering > unavailable > available > unavailable > available

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

      Returns:
      The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

      registering > unavailable > available > unavailable > available

      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

      registering > unavailable > available > unavailable > available

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

      Returns:
      The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:

      registering > unavailable > available > unavailable > available

      See Also:

    • reason

      public final TargetHealthReason reason()

      The reason for the current health State of the RDS Proxy target.

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

      Returns:
      The reason for the current health State of the RDS Proxy target.
      See Also:

    • reasonAsString

      public final String reasonAsString()

      The reason for the current health State of the RDS Proxy target.

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

      Returns:
      The reason for the current health State of the RDS Proxy target.
      See Also:

    • description

      public final String description()

      A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

      Returns:
      A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

    • toBuilder

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

    • builder

      public static TargetHealth.Builder builder()

    • serializableBuilderClass

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