software.amazon.awssdk.services.elasticloadbalancingv2.model.TargetHealth Maven / Gradle / Ivy
Show all versions of elasticloadbalancingv2 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.elasticloadbalancingv2.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;
/**
*
* Information about the current health of a target.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class TargetHealth implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(TargetHealth::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField REASON_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Reason")
.getter(getter(TargetHealth::reasonAsString)).setter(setter(Builder::reason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Reason").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(TargetHealth::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STATE_FIELD, REASON_FIELD,
DESCRIPTION_FIELD));
private static final long serialVersionUID = 1L;
private final String state;
private final String reason;
private final String description;
private TargetHealth(BuilderImpl builder) {
this.state = builder.state;
this.reason = builder.reason;
this.description = builder.description;
}
/**
*
* The state of the target.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link TargetHealthStateEnum#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The state of the target.
* @see TargetHealthStateEnum
*/
public final TargetHealthStateEnum state() {
return TargetHealthStateEnum.fromValue(state);
}
/**
*
* The state of the target.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link TargetHealthStateEnum#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The state of the target.
* @see TargetHealthStateEnum
*/
public final String stateAsString() {
return state;
}
/**
*
* The reason code.
*
*
* If the target state is healthy
, a reason code is not provided.
*
*
* If the target state is initial
, the reason code can be one of the following values:
*
*
* -
*
* Elb.RegistrationInProgress
- The target is in the process of being registered with the load
* balancer.
*
*
* -
*
* Elb.InitialHealthChecking
- The load balancer is still sending the target the minimum number of
* health checks required to determine its health status.
*
*
*
*
* If the target state is unhealthy
, the reason code can be one of the following values:
*
*
* -
*
* Target.ResponseCodeMismatch
- The health checks did not return an expected HTTP code. Applies only
* to Application Load Balancers and Gateway Load Balancers.
*
*
* -
*
* Target.Timeout
- The health check requests timed out. Applies only to Application Load Balancers and
* Gateway Load Balancers.
*
*
* -
*
* Target.FailedHealthChecks
- The load balancer received an error while establishing a connection to
* the target or the target response was malformed.
*
*
* -
*
* Elb.InternalError
- The health checks failed due to an internal error. Applies only to Application
* Load Balancers.
*
*
*
*
* If the target state is unused
, the reason code can be one of the following values:
*
*
* -
*
* Target.NotRegistered
- The target is not registered with the target group.
*
*
* -
*
* Target.NotInUse
- The target group is not used by any load balancer or the target is in an
* Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Target.InvalidState
- The target is in the stopped or terminated state.
*
*
* -
*
* Target.IpUnusable
- The target IP address is reserved for use by a load balancer.
*
*
*
*
* If the target state is draining
, the reason code can be the following value:
*
*
* -
*
* Target.DeregistrationInProgress
- The target is in the process of being deregistered and the
* deregistration delay period has not expired.
*
*
*
*
* If the target state is unavailable
, the reason code can be the following value:
*
*
* -
*
* Target.HealthCheckDisabled
- Health checks are disabled for the target group. Applies only to
* Application Load Balancers.
*
*
* -
*
* Elb.InternalError
- Target health is unavailable due to an internal error. Applies only to Network
* Load Balancers.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #reason} will
* return {@link TargetHealthReasonEnum#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #reasonAsString}.
*
*
* @return The reason code.
*
* If the target state is healthy
, a reason code is not provided.
*
*
* If the target state is initial
, the reason code can be one of the following values:
*
*
* -
*
* Elb.RegistrationInProgress
- The target is in the process of being registered with the load
* balancer.
*
*
* -
*
* Elb.InitialHealthChecking
- The load balancer is still sending the target the minimum number
* of health checks required to determine its health status.
*
*
*
*
* If the target state is unhealthy
, the reason code can be one of the following values:
*
*
* -
*
* Target.ResponseCodeMismatch
- The health checks did not return an expected HTTP code.
* Applies only to Application Load Balancers and Gateway Load Balancers.
*
*
* -
*
* Target.Timeout
- The health check requests timed out. Applies only to Application Load
* Balancers and Gateway Load Balancers.
*
*
* -
*
* Target.FailedHealthChecks
- The load balancer received an error while establishing a
* connection to the target or the target response was malformed.
*
*
* -
*
* Elb.InternalError
- The health checks failed due to an internal error. Applies only to
* Application Load Balancers.
*
*
*
*
* If the target state is unused
, the reason code can be one of the following values:
*
*
* -
*
* Target.NotRegistered
- The target is not registered with the target group.
*
*
* -
*
* Target.NotInUse
- The target group is not used by any load balancer or the target is in an
* Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Target.InvalidState
- The target is in the stopped or terminated state.
*
*
* -
*
* Target.IpUnusable
- The target IP address is reserved for use by a load balancer.
*
*
*
*
* If the target state is draining
, the reason code can be the following value:
*
*
* -
*
* Target.DeregistrationInProgress
- The target is in the process of being deregistered and the
* deregistration delay period has not expired.
*
*
*
*
* If the target state is unavailable
, the reason code can be the following value:
*
*
* -
*
* Target.HealthCheckDisabled
- Health checks are disabled for the target group. Applies only
* to Application Load Balancers.
*
*
* -
*
* Elb.InternalError
- Target health is unavailable due to an internal error. Applies only to
* Network Load Balancers.
*
*
* @see TargetHealthReasonEnum
*/
public final TargetHealthReasonEnum reason() {
return TargetHealthReasonEnum.fromValue(reason);
}
/**
*
* The reason code.
*
*
* If the target state is healthy
, a reason code is not provided.
*
*
* If the target state is initial
, the reason code can be one of the following values:
*
*
* -
*
* Elb.RegistrationInProgress
- The target is in the process of being registered with the load
* balancer.
*
*
* -
*
* Elb.InitialHealthChecking
- The load balancer is still sending the target the minimum number of
* health checks required to determine its health status.
*
*
*
*
* If the target state is unhealthy
, the reason code can be one of the following values:
*
*
* -
*
* Target.ResponseCodeMismatch
- The health checks did not return an expected HTTP code. Applies only
* to Application Load Balancers and Gateway Load Balancers.
*
*
* -
*
* Target.Timeout
- The health check requests timed out. Applies only to Application Load Balancers and
* Gateway Load Balancers.
*
*
* -
*
* Target.FailedHealthChecks
- The load balancer received an error while establishing a connection to
* the target or the target response was malformed.
*
*
* -
*
* Elb.InternalError
- The health checks failed due to an internal error. Applies only to Application
* Load Balancers.
*
*
*
*
* If the target state is unused
, the reason code can be one of the following values:
*
*
* -
*
* Target.NotRegistered
- The target is not registered with the target group.
*
*
* -
*
* Target.NotInUse
- The target group is not used by any load balancer or the target is in an
* Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Target.InvalidState
- The target is in the stopped or terminated state.
*
*
* -
*
* Target.IpUnusable
- The target IP address is reserved for use by a load balancer.
*
*
*
*
* If the target state is draining
, the reason code can be the following value:
*
*
* -
*
* Target.DeregistrationInProgress
- The target is in the process of being deregistered and the
* deregistration delay period has not expired.
*
*
*
*
* If the target state is unavailable
, the reason code can be the following value:
*
*
* -
*
* Target.HealthCheckDisabled
- Health checks are disabled for the target group. Applies only to
* Application Load Balancers.
*
*
* -
*
* Elb.InternalError
- Target health is unavailable due to an internal error. Applies only to Network
* Load Balancers.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #reason} will
* return {@link TargetHealthReasonEnum#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #reasonAsString}.
*
*
* @return The reason code.
*
* If the target state is healthy
, a reason code is not provided.
*
*
* If the target state is initial
, the reason code can be one of the following values:
*
*
* -
*
* Elb.RegistrationInProgress
- The target is in the process of being registered with the load
* balancer.
*
*
* -
*
* Elb.InitialHealthChecking
- The load balancer is still sending the target the minimum number
* of health checks required to determine its health status.
*
*
*
*
* If the target state is unhealthy
, the reason code can be one of the following values:
*
*
* -
*
* Target.ResponseCodeMismatch
- The health checks did not return an expected HTTP code.
* Applies only to Application Load Balancers and Gateway Load Balancers.
*
*
* -
*
* Target.Timeout
- The health check requests timed out. Applies only to Application Load
* Balancers and Gateway Load Balancers.
*
*
* -
*
* Target.FailedHealthChecks
- The load balancer received an error while establishing a
* connection to the target or the target response was malformed.
*
*
* -
*
* Elb.InternalError
- The health checks failed due to an internal error. Applies only to
* Application Load Balancers.
*
*
*
*
* If the target state is unused
, the reason code can be one of the following values:
*
*
* -
*
* Target.NotRegistered
- The target is not registered with the target group.
*
*
* -
*
* Target.NotInUse
- The target group is not used by any load balancer or the target is in an
* Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Target.InvalidState
- The target is in the stopped or terminated state.
*
*
* -
*
* Target.IpUnusable
- The target IP address is reserved for use by a load balancer.
*
*
*
*
* If the target state is draining
, the reason code can be the following value:
*
*
* -
*
* Target.DeregistrationInProgress
- The target is in the process of being deregistered and the
* deregistration delay period has not expired.
*
*
*
*
* If the target state is unavailable
, the reason code can be the following value:
*
*
* -
*
* Target.HealthCheckDisabled
- Health checks are disabled for the target group. Applies only
* to Application Load Balancers.
*
*
* -
*
* Elb.InternalError
- Target health is unavailable due to an internal error. Applies only to
* Network Load Balancers.
*
*
* @see TargetHealthReasonEnum
*/
public final String reasonAsString() {
return reason;
}
/**
*
* A description of the target health that provides additional details. If the state is healthy
, a
* description is not provided.
*
*
* @return A description of the target health that provides additional details. If the state is healthy
* , a description is not provided.
*/
public final String description() {
return description;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(reasonAsString());
hashCode = 31 * hashCode + Objects.hashCode(description());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof TargetHealth)) {
return false;
}
TargetHealth other = (TargetHealth) obj;
return Objects.equals(stateAsString(), other.stateAsString()) && Objects.equals(reasonAsString(), other.reasonAsString())
&& Objects.equals(description(), other.description());
}
/**
* 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 final String toString() {
return ToString.builder("TargetHealth").add("State", stateAsString()).add("Reason", reasonAsString())
.add("Description", description()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "Reason":
return Optional.ofNullable(clazz.cast(reasonAsString()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function