software.amazon.awssdk.services.globalaccelerator.model

Class EndpointDescription

java.lang.Object

software.amazon.awssdk.services.globalaccelerator.model.EndpointDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EndpointDescription.Builder,EndpointDescription>

@Generated(value="software.amazon.awssdk:codegen")
public final class EndpointDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EndpointDescription.Builder,EndpointDescription>

A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EndpointDescription.Builder

Method Summary

Modifier and Type	Method and Description
static EndpointDescription.Builder	builder()
String	endpointId() An ID for the endpoint.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	healthReason() The reason code associated with why the endpoint is not healthy.
HealthState	healthState() The health status of the endpoint.
String	healthStateAsString() The health status of the endpoint.
List<SdkField<?>>	sdkFields()
static Class<? extends EndpointDescription.Builder>	serializableBuilderClass()
EndpointDescription.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	weight() The weight associated with the endpoint.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

endpointId

public String endpointId()

An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.

Returns:

An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.

weight

public Integer weight()

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

Returns:

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

healthState

public HealthState healthState()

The health status of the endpoint.

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

Returns:

The health status of the endpoint.

See Also:

HealthState

healthStateAsString

public String healthStateAsString()

The health status of the endpoint.

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

Returns:

The health status of the endpoint.

See Also:

HealthState

healthReason

public String healthReason()

The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

If the endpoint state is unhealthy, the reason code can be one of the following values:

• Timeout: The health check requests to the endpoint are timing out before returning a status.

• Failed: The health check failed, for example because the endpoint response was invalid (malformed).

If the endpoint state is initial, the reason code can be one of the following values:

• ProvisioningInProgress: The endpoint is in the process of being provisioned.

• InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.

Returns:

The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

If the endpoint state is unhealthy, the reason code can be one of the following values:

• Timeout: The health check requests to the endpoint are timing out before returning a status.

• Failed: The health check failed, for example because the endpoint response was invalid (malformed).

If the endpoint state is initial, the reason code can be one of the following values:

• ProvisioningInProgress: The endpoint is in the process of being provisioned.

• InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.

toBuilder

public EndpointDescription.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<EndpointDescription.Builder,EndpointDescription>

Returns:

a builder for type T

builder

public static EndpointDescription.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public 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.