software.amazon.awssdk.services.globalaccelerator.model.EndpointDescription Maven / Gradle / Ivy
Show all versions of globalaccelerator Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.globalaccelerator.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EndpointDescription implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ENDPOINT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(EndpointDescription::endpointId)).setter(setter(Builder::endpointId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointId").build()).build();
private static final SdkField WEIGHT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(EndpointDescription::weight)).setter(setter(Builder::weight))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Weight").build()).build();
private static final SdkField HEALTH_STATE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(EndpointDescription::healthStateAsString)).setter(setter(Builder::healthState))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HealthState").build()).build();
private static final SdkField HEALTH_REASON_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(EndpointDescription::healthReason)).setter(setter(Builder::healthReason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HealthReason").build()).build();
private static final SdkField CLIENT_IP_PRESERVATION_ENABLED_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.getter(getter(EndpointDescription::clientIPPreservationEnabled))
.setter(setter(Builder::clientIPPreservationEnabled))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientIPPreservationEnabled")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ENDPOINT_ID_FIELD,
WEIGHT_FIELD, HEALTH_STATE_FIELD, HEALTH_REASON_FIELD, CLIENT_IP_PRESERVATION_ENABLED_FIELD));
private static final long serialVersionUID = 1L;
private final String endpointId;
private final Integer weight;
private final String healthState;
private final String healthReason;
private final Boolean clientIPPreservationEnabled;
private EndpointDescription(BuilderImpl builder) {
this.endpointId = builder.endpointId;
this.weight = builder.weight;
this.healthState = builder.healthState;
this.healthReason = builder.healthReason;
this.clientIPPreservationEnabled = builder.clientIPPreservationEnabled;
}
/**
*
* 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 EC2 instances, this is the EC2 instance ID.
*
*
* An Application Load Balancer can be either internal or internet-facing.
*
*
* @return 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 EC2 instances, this is the EC2 instance ID.
*
* An Application Load Balancer can be either internal or internet-facing.
*/
public String endpointId() {
return endpointId;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Integer weight() {
return weight;
}
/**
*
* The health status of the endpoint.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #healthState} will
* return {@link HealthState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #healthStateAsString}.
*
*
* @return The health status of the endpoint.
* @see HealthState
*/
public HealthState healthState() {
return HealthState.fromValue(healthState);
}
/**
*
* The health status of the endpoint.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #healthState} will
* return {@link HealthState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #healthStateAsString}.
*
*
* @return The health status of the endpoint.
* @see HealthState
*/
public String healthStateAsString() {
return healthState;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
*/
public String healthReason() {
return healthReason;
}
/**
*
* Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value
* is true or false. The default value is true for new accelerators.
*
*
* 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 Application Load Balancer endpoint fronted by the accelerator.
*
*
* For more information, see Viewing
* Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
*
*
* @return Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint.
* The value is true or false. The default value is true for new accelerators.
*
* 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 Application Load Balancer endpoint fronted by
* the accelerator.
*
*
* For more information, see
* Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer
* Guide.
*/
public Boolean clientIPPreservationEnabled() {
return clientIPPreservationEnabled;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(endpointId());
hashCode = 31 * hashCode + Objects.hashCode(weight());
hashCode = 31 * hashCode + Objects.hashCode(healthStateAsString());
hashCode = 31 * hashCode + Objects.hashCode(healthReason());
hashCode = 31 * hashCode + Objects.hashCode(clientIPPreservationEnabled());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof EndpointDescription)) {
return false;
}
EndpointDescription other = (EndpointDescription) obj;
return Objects.equals(endpointId(), other.endpointId()) && Objects.equals(weight(), other.weight())
&& Objects.equals(healthStateAsString(), other.healthStateAsString())
&& Objects.equals(healthReason(), other.healthReason())
&& Objects.equals(clientIPPreservationEnabled(), other.clientIPPreservationEnabled());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("EndpointDescription").add("EndpointId", endpointId()).add("Weight", weight())
.add("HealthState", healthStateAsString()).add("HealthReason", healthReason())
.add("ClientIPPreservationEnabled", clientIPPreservationEnabled()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "EndpointId":
return Optional.ofNullable(clazz.cast(endpointId()));
case "Weight":
return Optional.ofNullable(clazz.cast(weight()));
case "HealthState":
return Optional.ofNullable(clazz.cast(healthStateAsString()));
case "HealthReason":
return Optional.ofNullable(clazz.cast(healthReason()));
case "ClientIPPreservationEnabled":
return Optional.ofNullable(clazz.cast(clientIPPreservationEnabled()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((EndpointDescription) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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 EC2 instances, this is the EC2 instance ID.
*
*
* An Application Load Balancer can be either internal or internet-facing.
*
*
* @param 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 EC2 instances, this is the EC2 instance ID.
*
* An Application Load Balancer can be either internal or internet-facing.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endpointId(String endpointId);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder weight(Integer weight);
/**
*
* The health status of the endpoint.
*
*
* @param healthState
* The health status of the endpoint.
* @see HealthState
* @return Returns a reference to this object so that method calls can be chained together.
* @see HealthState
*/
Builder healthState(String healthState);
/**
*
* The health status of the endpoint.
*
*
* @param healthState
* The health status of the endpoint.
* @see HealthState
* @return Returns a reference to this object so that method calls can be chained together.
* @see HealthState
*/
Builder healthState(HealthState healthState);
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder healthReason(String healthReason);
/**
*
* Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The
* value is true or false. The default value is true for new accelerators.
*
*
* 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 Application Load Balancer endpoint fronted by the
* accelerator.
*
*
* For more information, see
* Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer
* Guide.
*
*
* @param clientIPPreservationEnabled
* Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint.
* The value is true or false. The default value is true for new accelerators.
*
* 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 Application Load Balancer endpoint fronted by
* the accelerator.
*
*
* For more information, see
* Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer
* Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientIPPreservationEnabled(Boolean clientIPPreservationEnabled);
}
static final class BuilderImpl implements Builder {
private String endpointId;
private Integer weight;
private String healthState;
private String healthReason;
private Boolean clientIPPreservationEnabled;
private BuilderImpl() {
}
private BuilderImpl(EndpointDescription model) {
endpointId(model.endpointId);
weight(model.weight);
healthState(model.healthState);
healthReason(model.healthReason);
clientIPPreservationEnabled(model.clientIPPreservationEnabled);
}
public final String getEndpointId() {
return endpointId;
}
@Override
public final Builder endpointId(String endpointId) {
this.endpointId = endpointId;
return this;
}
public final void setEndpointId(String endpointId) {
this.endpointId = endpointId;
}
public final Integer getWeight() {
return weight;
}
@Override
public final Builder weight(Integer weight) {
this.weight = weight;
return this;
}
public final void setWeight(Integer weight) {
this.weight = weight;
}
public final String getHealthStateAsString() {
return healthState;
}
@Override
public final Builder healthState(String healthState) {
this.healthState = healthState;
return this;
}
@Override
public final Builder healthState(HealthState healthState) {
this.healthState(healthState == null ? null : healthState.toString());
return this;
}
public final void setHealthState(String healthState) {
this.healthState = healthState;
}
public final String getHealthReason() {
return healthReason;
}
@Override
public final Builder healthReason(String healthReason) {
this.healthReason = healthReason;
return this;
}
public final void setHealthReason(String healthReason) {
this.healthReason = healthReason;
}
public final Boolean getClientIPPreservationEnabled() {
return clientIPPreservationEnabled;
}
@Override
public final Builder clientIPPreservationEnabled(Boolean clientIPPreservationEnabled) {
this.clientIPPreservationEnabled = clientIPPreservationEnabled;
return this;
}
public final void setClientIPPreservationEnabled(Boolean clientIPPreservationEnabled) {
this.clientIPPreservationEnabled = clientIPPreservationEnabled;
}
@Override
public EndpointDescription build() {
return new EndpointDescription(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}