Package software.amazon.awssdk.services.rds.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TargetHealth.Builder

Method Summary

Modifier and Type	Method	Description
static TargetHealth.Builder	builder()
String	description()	A description of the health of the RDS Proxy target.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
TargetHealthReason	reason()	The reason for the current health State of the RDS Proxy target.
String	reasonAsString()	The reason for the current health State of the RDS Proxy target.
List<SdkField<?>>	sdkFields()
static Class<? extends TargetHealth.Builder>	serializableBuilderClass()
TargetState	state()	The current state of the connection health lifecycle for the RDS Proxy target.
String	stateAsString()	The current state of the connection health lifecycle for the RDS Proxy target.
TargetHealth.Builder	toBuilder()
String	toString()	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

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:

TargetState

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:

TargetState

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:

TargetHealthReason

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:

TargetHealthReason

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()

Specified by:

toBuilder in interface ToCopyableBuilder<TargetHealth.Builder,TargetHealth>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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