java.lang.Object
- software.amazon.awssdk.services.globalaccelerator.model.EndpointDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EndpointDescription.Builder,EndpointDescription>
```
@Generated("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 Description

static interface EndpointDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static EndpointDescription.Builder`	`builder()`
`Boolean`	`clientIPPreservationEnabled()`	Indicates whether client IP address preservation is enabled for an endpoint.
`String`	`endpointId()`	An ID for the endpoint.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`healthReason()`	Returns a null result.
`HealthState`	`healthState()`	The health status of the endpoint.
`String`	`healthStateAsString()`	The health status of the endpoint.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EndpointDescription.Builder>`	`serializableBuilderClass()`
`EndpointDescription.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Integer`	`weight()`	The weight associated with the endpoint.

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
  - endpointId
```
public final 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. For Amazon EC2 instances, this is the EC2 instance ID.
    
    An Application Load Balancer can be either internal or internet-facing.
    
    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. For Amazon EC2 instances, this is the EC2 instance ID.
    
    An Application Load Balancer can be either internal or internet-facing.
  - weight
```
public final Integer weight()
```
    The weight associated with the endpoint. When you add weights to endpoints, you configure 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 Global Accelerator Developer Guide.
    
    Returns:
    
    The weight associated with the endpoint. When you add weights to endpoints, you configure 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 Global Accelerator Developer Guide.
  - healthState
```
public final 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 final 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 final String healthReason()
```
    Returns a null result.
    
    Returns:
    
    Returns a null result.
  - clientIPPreservationEnabled
```
public final Boolean clientIPPreservationEnabled()
```
    Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancers endpoints.
    
    If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator.
    
    Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
    
    For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
    
    Returns:
    
    Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for Application Load Balancers endpoints.
    
    If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator.
    
    Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers, Amazon EC2 instances, and Network Load Balancers with security groups. IMPORTANT: You cannot use client IP address preservation with Network Load Balancers with TLS listeners.
    
    For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.
  - toBuilder
```
public EndpointDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EndpointDescription.Builder,EndpointDescription>
  - builder
```
public static EndpointDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EndpointDescription.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class EndpointDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

endpointId

weight

healthState

healthStateAsString

healthReason

clientIPPreservationEnabled

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField