Class EndpointDescription

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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.