EndpointDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.globalaccelerator.model.EndpointDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EndpointDescription
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EndpointDescription()

Constructors
Constructor and Description
`EndpointDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EndpointDescription`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getClientIPPreservationEnabled()` Indicates whether client IP address preservation is enabled for an endpoint.
`String`	`getEndpointId()` An ID for the endpoint.
`String`	`getHealthReason()` Returns a null result.
`String`	`getHealthState()` The health status of the endpoint.
`Integer`	`getWeight()` The weight associated with the endpoint.
`int`	`hashCode()`
`Boolean`	`isClientIPPreservationEnabled()` Indicates whether client IP address preservation is enabled for an endpoint.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setClientIPPreservationEnabled(Boolean clientIPPreservationEnabled)` Indicates whether client IP address preservation is enabled for an endpoint.
`void`	`setEndpointId(String endpointId)` An ID for the endpoint.
`void`	`setHealthReason(String healthReason)` Returns a null result.
`void`	`setHealthState(String healthState)` The health status of the endpoint.
`void`	`setWeight(Integer weight)` The weight associated with the endpoint.
`String`	`toString()` Returns a string representation of this object.
`EndpointDescription`	`withClientIPPreservationEnabled(Boolean clientIPPreservationEnabled)` Indicates whether client IP address preservation is enabled for an endpoint.
`EndpointDescription`	`withEndpointId(String endpointId)` An ID for the endpoint.
`EndpointDescription`	`withHealthReason(String healthReason)` Returns a null result.
`EndpointDescription`	`withHealthState(HealthState healthState)` The health status of the endpoint.
`EndpointDescription`	`withHealthState(String healthState)` The health status of the endpoint.
`EndpointDescription`	`withWeight(Integer weight)` The weight associated with the endpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EndpointDescription
```
public EndpointDescription()
```
- Method Detail
  - setEndpointId
```
public void setEndpointId(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.
    
    Parameters:
    
    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.
  - getEndpointId
```
public String getEndpointId()
```
    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.
  - withEndpointId
```
public EndpointDescription withEndpointId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWeight
```
public void setWeight(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.
    
    Parameters:
    
    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.
  - getWeight
```
public Integer getWeight()
```
    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.
  - withWeight
```
public EndpointDescription withWeight(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHealthState
```
public void setHealthState(String healthState)
```
    The health status of the endpoint.
    
    Parameters:
    
    healthState - The health status of the endpoint.
    
    See Also:
    
    HealthState
  - getHealthState
```
public String getHealthState()
```
    The health status of the endpoint.
    
    Returns:
    
    The health status of the endpoint.
    
    See Also:
    
    HealthState
  - withHealthState
```
public EndpointDescription withHealthState(String healthState)
```
    The health status of the endpoint.
    
    Parameters:
    
    healthState - The health status of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HealthState
  - withHealthState
```
public EndpointDescription withHealthState(HealthState healthState)
```
    The health status of the endpoint.
    
    Parameters:
    
    healthState - The health status of the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HealthState
  - setHealthReason
```
public void setHealthReason(String healthReason)
```
    Returns a null result.
    
    Parameters:
    
    healthReason - Returns a null result.
  - getHealthReason
```
public String getHealthReason()
```
    Returns a null result.
    
    Returns:
    
    Returns a null result.
  - withHealthReason
```
public EndpointDescription withHealthReason(String healthReason)
```
    Returns a null result.
    
    Parameters:
    
    healthReason - Returns a null result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientIPPreservationEnabled
```
public void setClientIPPreservationEnabled(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.
    
    Parameters:
    
    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.
  - getClientIPPreservationEnabled
```
public Boolean getClientIPPreservationEnabled()
```
    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.
  - withClientIPPreservationEnabled
```
public EndpointDescription withClientIPPreservationEnabled(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isClientIPPreservationEnabled
```
public Boolean isClientIPPreservationEnabled()
```
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EndpointDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class EndpointDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EndpointDescription

Method Detail

setEndpointId

getEndpointId

withEndpointId

setWeight

getWeight

withWeight

setHealthState

getHealthState

withHealthState

withHealthState

setHealthReason

getHealthReason

withHealthReason

setClientIPPreservationEnabled

getClientIPPreservationEnabled

withClientIPPreservationEnabled

isClientIPPreservationEnabled

toString

equals

hashCode

clone

marshall