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)`
`String`	`getEndpointId()` An ID for the endpoint.
`String`	`getHealthReason()` The reason code associated with why the endpoint is not healthy.
`String`	`getHealthState()` The health status of the endpoint.
`Integer`	`getWeight()` The weight associated with the endpoint.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEndpointId(String endpointId)` An ID for the endpoint.
`void`	`setHealthReason(String healthReason)` The reason code associated with why the endpoint is not healthy.
`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`	`withEndpointId(String endpointId)` An ID for the endpoint.
`EndpointDescription`	`withHealthReason(String healthReason)` The reason code associated with why the endpoint is not healthy.
`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.
    
    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.
  - 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.
    
    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.
  - 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.
    
    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.
    
    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 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.
    
    Parameters:
    
    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.
  - getWeight
```
public Integer getWeight()
```
    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.
  - withWeight
```
public EndpointDescription withWeight(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.
    
    Parameters:
    
    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:
    
    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)
```
    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.
    Parameters:
    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.
  - getHealthReason
```
public String getHealthReason()
```
    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.
  - withHealthReason
```
public EndpointDescription withHealthReason(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.

Did this page help you?

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

toString

equals

hashCode

clone

marshall