com.amazonaws.services.lightsail.model.InstanceHealthSummary Maven / Gradle / Ivy
/*
* Copyright 2018-2023 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 com.amazonaws.services.lightsail.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes information about the health of the instance.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class InstanceHealthSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the Lightsail instance for which you are requesting health check data.
*
*/
private String instanceName;
/**
*
* Describes the overall instance health. Valid values are below.
*
*/
private String instanceHealth;
/**
*
* More information about the instance health. If the instanceHealth is healthy, then an
* instanceHealthReason value is not provided.
*
*
* If instanceHealth is initial, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Lb.RegistrationInProgress - The target instance is in the process of being registered with
* the load balancer.
*
*
* -
*
* Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance
* the minimum number of health checks required to determine its health status.
*
*
*
*
* If instanceHealth is unhealthy, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
*
*
* -
*
* Instance.Timeout - The health check requests timed out.
*
*
* -
*
* Instance.FailedHealthChecks - The health checks failed because the connection to the target
* instance timed out, the target instance response was malformed, or the target instance failed the health check
* for an unknown reason.
*
*
* -
*
* Lb.InternalError - The health checks failed due to an internal error.
*
*
*
*
* If instanceHealth is unused, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.NotRegistered - The target instance is not registered with the target group.
*
*
* -
*
* Instance.NotInUse - The target group is not used by any load balancer, or the target
* instance is in an Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load
* balancer.
*
*
* -
*
* Instance.InvalidState - The target is in the stopped or terminated state.
*
*
*
*
* If instanceHealth is draining, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.DeregistrationInProgress - The target instance is in the process of being
* deregistered and the deregistration delay period has not expired.
*
*
*
*/
private String instanceHealthReason;
/**
*
* The name of the Lightsail instance for which you are requesting health check data.
*
*
* @param instanceName
* The name of the Lightsail instance for which you are requesting health check data.
*/
public void setInstanceName(String instanceName) {
this.instanceName = instanceName;
}
/**
*
* The name of the Lightsail instance for which you are requesting health check data.
*
*
* @return The name of the Lightsail instance for which you are requesting health check data.
*/
public String getInstanceName() {
return this.instanceName;
}
/**
*
* The name of the Lightsail instance for which you are requesting health check data.
*
*
* @param instanceName
* The name of the Lightsail instance for which you are requesting health check data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InstanceHealthSummary withInstanceName(String instanceName) {
setInstanceName(instanceName);
return this;
}
/**
*
* Describes the overall instance health. Valid values are below.
*
*
* @param instanceHealth
* Describes the overall instance health. Valid values are below.
* @see InstanceHealthState
*/
public void setInstanceHealth(String instanceHealth) {
this.instanceHealth = instanceHealth;
}
/**
*
* Describes the overall instance health. Valid values are below.
*
*
* @return Describes the overall instance health. Valid values are below.
* @see InstanceHealthState
*/
public String getInstanceHealth() {
return this.instanceHealth;
}
/**
*
* Describes the overall instance health. Valid values are below.
*
*
* @param instanceHealth
* Describes the overall instance health. Valid values are below.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceHealthState
*/
public InstanceHealthSummary withInstanceHealth(String instanceHealth) {
setInstanceHealth(instanceHealth);
return this;
}
/**
*
* Describes the overall instance health. Valid values are below.
*
*
* @param instanceHealth
* Describes the overall instance health. Valid values are below.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceHealthState
*/
public InstanceHealthSummary withInstanceHealth(InstanceHealthState instanceHealth) {
this.instanceHealth = instanceHealth.toString();
return this;
}
/**
*
* More information about the instance health. If the instanceHealth is healthy, then an
* instanceHealthReason value is not provided.
*
*
* If instanceHealth is initial, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Lb.RegistrationInProgress - The target instance is in the process of being registered with
* the load balancer.
*
*
* -
*
* Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance
* the minimum number of health checks required to determine its health status.
*
*
*
*
* If instanceHealth is unhealthy, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
*
*
* -
*
* Instance.Timeout - The health check requests timed out.
*
*
* -
*
* Instance.FailedHealthChecks - The health checks failed because the connection to the target
* instance timed out, the target instance response was malformed, or the target instance failed the health check
* for an unknown reason.
*
*
* -
*
* Lb.InternalError - The health checks failed due to an internal error.
*
*
*
*
* If instanceHealth is unused, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.NotRegistered - The target instance is not registered with the target group.
*
*
* -
*
* Instance.NotInUse - The target group is not used by any load balancer, or the target
* instance is in an Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load
* balancer.
*
*
* -
*
* Instance.InvalidState - The target is in the stopped or terminated state.
*
*
*
*
* If instanceHealth is draining, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.DeregistrationInProgress - The target instance is in the process of being
* deregistered and the deregistration delay period has not expired.
*
*
*
*
* @param instanceHealthReason
* More information about the instance health. If the instanceHealth is healthy,
* then an instanceHealthReason value is not provided.
*
* If instanceHealth is initial, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Lb.RegistrationInProgress - The target instance is in the process of being
* registered with the load balancer.
*
*
* -
*
* Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target
* instance the minimum number of health checks required to determine its health status.
*
*
*
*
* If instanceHealth is unhealthy, the
* instanceHealthReason value can be one of the following:
*
*
* -
*
* Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP
* code.
*
*
* -
*
* Instance.Timeout - The health check requests timed out.
*
*
* -
*
* Instance.FailedHealthChecks - The health checks failed because the connection to the
* target instance timed out, the target instance response was malformed, or the target instance failed the
* health check for an unknown reason.
*
*
* -
*
* Lb.InternalError - The health checks failed due to an internal error.
*
*
*
*
* If instanceHealth is unused, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.NotRegistered - The target instance is not registered with the target
* group.
*
*
* -
*
* Instance.NotInUse - The target group is not used by any load balancer, or the target
* instance is in an Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load
* balancer.
*
*
* -
*
* Instance.InvalidState - The target is in the stopped or terminated state.
*
*
*
*
* If instanceHealth is draining, the
* instanceHealthReason value can be one of the following:
*
*
* -
*
* Instance.DeregistrationInProgress - The target instance is in the process of being
* deregistered and the deregistration delay period has not expired.
*
*
* @see InstanceHealthReason
*/
public void setInstanceHealthReason(String instanceHealthReason) {
this.instanceHealthReason = instanceHealthReason;
}
/**
*
* More information about the instance health. If the instanceHealth is healthy, then an
* instanceHealthReason value is not provided.
*
*
* If instanceHealth is initial, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Lb.RegistrationInProgress - The target instance is in the process of being registered with
* the load balancer.
*
*
* -
*
* Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance
* the minimum number of health checks required to determine its health status.
*
*
*
*
* If instanceHealth is unhealthy, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
*
*
* -
*
* Instance.Timeout - The health check requests timed out.
*
*
* -
*
* Instance.FailedHealthChecks - The health checks failed because the connection to the target
* instance timed out, the target instance response was malformed, or the target instance failed the health check
* for an unknown reason.
*
*
* -
*
* Lb.InternalError - The health checks failed due to an internal error.
*
*
*
*
* If instanceHealth is unused, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.NotRegistered - The target instance is not registered with the target group.
*
*
* -
*
* Instance.NotInUse - The target group is not used by any load balancer, or the target
* instance is in an Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load
* balancer.
*
*
* -
*
* Instance.InvalidState - The target is in the stopped or terminated state.
*
*
*
*
* If instanceHealth is draining, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.DeregistrationInProgress - The target instance is in the process of being
* deregistered and the deregistration delay period has not expired.
*
*
*
*
* @return More information about the instance health. If the instanceHealth is healthy,
* then an instanceHealthReason value is not provided.
*
* If instanceHealth is initial, the
* instanceHealthReason value can be one of the following:
*
*
* -
*
* Lb.RegistrationInProgress - The target instance is in the process of being
* registered with the load balancer.
*
*
* -
*
* Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target
* instance the minimum number of health checks required to determine its health status.
*
*
*
*
* If instanceHealth is unhealthy, the
* instanceHealthReason value can be one of the following:
*
*
* -
*
* Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP
* code.
*
*
* -
*
* Instance.Timeout - The health check requests timed out.
*
*
* -
*
* Instance.FailedHealthChecks - The health checks failed because the connection to
* the target instance timed out, the target instance response was malformed, or the target instance failed
* the health check for an unknown reason.
*
*
* -
*
* Lb.InternalError - The health checks failed due to an internal error.
*
*
*
*
* If instanceHealth is unused, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.NotRegistered - The target instance is not registered with the target
* group.
*
*
* -
*
* Instance.NotInUse - The target group is not used by any load balancer, or the
* target instance is in an Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load
* balancer.
*
*
* -
*
* Instance.InvalidState - The target is in the stopped or terminated state.
*
*
*
*
* If instanceHealth is draining, the
* instanceHealthReason value can be one of the following:
*
*
* -
*
* Instance.DeregistrationInProgress - The target instance is in the process of being
* deregistered and the deregistration delay period has not expired.
*
*
* @see InstanceHealthReason
*/
public String getInstanceHealthReason() {
return this.instanceHealthReason;
}
/**
*
* More information about the instance health. If the instanceHealth is healthy, then an
* instanceHealthReason value is not provided.
*
*
* If instanceHealth is initial, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Lb.RegistrationInProgress - The target instance is in the process of being registered with
* the load balancer.
*
*
* -
*
* Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance
* the minimum number of health checks required to determine its health status.
*
*
*
*
* If instanceHealth is unhealthy, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
*
*
* -
*
* Instance.Timeout - The health check requests timed out.
*
*
* -
*
* Instance.FailedHealthChecks - The health checks failed because the connection to the target
* instance timed out, the target instance response was malformed, or the target instance failed the health check
* for an unknown reason.
*
*
* -
*
* Lb.InternalError - The health checks failed due to an internal error.
*
*
*
*
* If instanceHealth is unused, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.NotRegistered - The target instance is not registered with the target group.
*
*
* -
*
* Instance.NotInUse - The target group is not used by any load balancer, or the target
* instance is in an Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load
* balancer.
*
*
* -
*
* Instance.InvalidState - The target is in the stopped or terminated state.
*
*
*
*
* If instanceHealth is draining, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.DeregistrationInProgress - The target instance is in the process of being
* deregistered and the deregistration delay period has not expired.
*
*
*
*
* @param instanceHealthReason
* More information about the instance health. If the instanceHealth is healthy,
* then an instanceHealthReason value is not provided.
*
* If instanceHealth is initial, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Lb.RegistrationInProgress - The target instance is in the process of being
* registered with the load balancer.
*
*
* -
*
* Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target
* instance the minimum number of health checks required to determine its health status.
*
*
*
*
* If instanceHealth is unhealthy, the
* instanceHealthReason value can be one of the following:
*
*
* -
*
* Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP
* code.
*
*
* -
*
* Instance.Timeout - The health check requests timed out.
*
*
* -
*
* Instance.FailedHealthChecks - The health checks failed because the connection to the
* target instance timed out, the target instance response was malformed, or the target instance failed the
* health check for an unknown reason.
*
*
* -
*
* Lb.InternalError - The health checks failed due to an internal error.
*
*
*
*
* If instanceHealth is unused, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.NotRegistered - The target instance is not registered with the target
* group.
*
*
* -
*
* Instance.NotInUse - The target group is not used by any load balancer, or the target
* instance is in an Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load
* balancer.
*
*
* -
*
* Instance.InvalidState - The target is in the stopped or terminated state.
*
*
*
*
* If instanceHealth is draining, the
* instanceHealthReason value can be one of the following:
*
*
* -
*
* Instance.DeregistrationInProgress - The target instance is in the process of being
* deregistered and the deregistration delay period has not expired.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceHealthReason
*/
public InstanceHealthSummary withInstanceHealthReason(String instanceHealthReason) {
setInstanceHealthReason(instanceHealthReason);
return this;
}
/**
*
* More information about the instance health. If the instanceHealth is healthy, then an
* instanceHealthReason value is not provided.
*
*
* If instanceHealth is initial, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Lb.RegistrationInProgress - The target instance is in the process of being registered with
* the load balancer.
*
*
* -
*
* Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance
* the minimum number of health checks required to determine its health status.
*
*
*
*
* If instanceHealth is unhealthy, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.
*
*
* -
*
* Instance.Timeout - The health check requests timed out.
*
*
* -
*
* Instance.FailedHealthChecks - The health checks failed because the connection to the target
* instance timed out, the target instance response was malformed, or the target instance failed the health check
* for an unknown reason.
*
*
* -
*
* Lb.InternalError - The health checks failed due to an internal error.
*
*
*
*
* If instanceHealth is unused, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.NotRegistered - The target instance is not registered with the target group.
*
*
* -
*
* Instance.NotInUse - The target group is not used by any load balancer, or the target
* instance is in an Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load
* balancer.
*
*
* -
*
* Instance.InvalidState - The target is in the stopped or terminated state.
*
*
*
*
* If instanceHealth is draining, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.DeregistrationInProgress - The target instance is in the process of being
* deregistered and the deregistration delay period has not expired.
*
*
*
*
* @param instanceHealthReason
* More information about the instance health. If the instanceHealth is healthy,
* then an instanceHealthReason value is not provided.
*
* If instanceHealth is initial, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Lb.RegistrationInProgress - The target instance is in the process of being
* registered with the load balancer.
*
*
* -
*
* Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target
* instance the minimum number of health checks required to determine its health status.
*
*
*
*
* If instanceHealth is unhealthy, the
* instanceHealthReason value can be one of the following:
*
*
* -
*
* Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP
* code.
*
*
* -
*
* Instance.Timeout - The health check requests timed out.
*
*
* -
*
* Instance.FailedHealthChecks - The health checks failed because the connection to the
* target instance timed out, the target instance response was malformed, or the target instance failed the
* health check for an unknown reason.
*
*
* -
*
* Lb.InternalError - The health checks failed due to an internal error.
*
*
*
*
* If instanceHealth is unused, the instanceHealthReason
* value can be one of the following:
*
*
* -
*
* Instance.NotRegistered - The target instance is not registered with the target
* group.
*
*
* -
*
* Instance.NotInUse - The target group is not used by any load balancer, or the target
* instance is in an Availability Zone that is not enabled for its load balancer.
*
*
* -
*
* Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load
* balancer.
*
*
* -
*
* Instance.InvalidState - The target is in the stopped or terminated state.
*
*
*
*
* If instanceHealth is draining, the
* instanceHealthReason value can be one of the following:
*
*
* -
*
* Instance.DeregistrationInProgress - The target instance is in the process of being
* deregistered and the deregistration delay period has not expired.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceHealthReason
*/
public InstanceHealthSummary withInstanceHealthReason(InstanceHealthReason instanceHealthReason) {
this.instanceHealthReason = instanceHealthReason.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getInstanceName() != null)
sb.append("InstanceName: ").append(getInstanceName()).append(",");
if (getInstanceHealth() != null)
sb.append("InstanceHealth: ").append(getInstanceHealth()).append(",");
if (getInstanceHealthReason() != null)
sb.append("InstanceHealthReason: ").append(getInstanceHealthReason());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof InstanceHealthSummary == false)
return false;
InstanceHealthSummary other = (InstanceHealthSummary) obj;
if (other.getInstanceName() == null ^ this.getInstanceName() == null)
return false;
if (other.getInstanceName() != null && other.getInstanceName().equals(this.getInstanceName()) == false)
return false;
if (other.getInstanceHealth() == null ^ this.getInstanceHealth() == null)
return false;
if (other.getInstanceHealth() != null && other.getInstanceHealth().equals(this.getInstanceHealth()) == false)
return false;
if (other.getInstanceHealthReason() == null ^ this.getInstanceHealthReason() == null)
return false;
if (other.getInstanceHealthReason() != null && other.getInstanceHealthReason().equals(this.getInstanceHealthReason()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInstanceName() == null) ? 0 : getInstanceName().hashCode());
hashCode = prime * hashCode + ((getInstanceHealth() == null) ? 0 : getInstanceHealth().hashCode());
hashCode = prime * hashCode + ((getInstanceHealthReason() == null) ? 0 : getInstanceHealthReason().hashCode());
return hashCode;
}
@Override
public InstanceHealthSummary clone() {
try {
return (InstanceHealthSummary) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.lightsail.model.transform.InstanceHealthSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}