Package software.amazon.awssdk.services.vpclattice.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TargetSummary.Builder

Method Summary

Modifier and Type	Method	Description
static TargetSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The ID of the target.
Integer	port()	The port on which the target is listening.
String	reasonCode()	The code for why the target status is what it is.
List<SdkField<?>>	sdkFields()
static Class<? extends TargetSummary.Builder>	serializableBuilderClass()
TargetStatus	status()	The status of the target.
String	statusAsString()	The status of the target.
TargetSummary.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

id

public final String id()

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

Returns:

The ID of the target. If the target type of the target group is INSTANCE, this is an instance ID. If the target type is IP , this is an IP address. If the target type is LAMBDA, this is the ARN of the Lambda function. If the target type is ALB, this is the ARN of the 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 will be sent to this target while current connections are being drained. 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 will be sent to this target while current connections are being drained. 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:

TargetStatus

statusAsString

public final String statusAsString()

The status of the target.

• Draining: The target is being deregistered. No new connections will be sent to this target while current connections are being drained. 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 will be sent to this target while current connections are being drained. 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:

TargetStatus

toBuilder

public TargetSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TargetSummary.Builder,TargetSummary>

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)

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