All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.elasticloadbalancing.model.HealthCheck Maven / Gradle / Ivy

Go to download

The AWS SDK for Java with support for OSGi. The AWS SDK for Java provides Java APIs for building software on AWS' cost-effective, scalable, and reliable infrastructure products. The AWS Java SDK allows developers to code against APIs for all of Amazon's infrastructure web services (Amazon S3, Amazon EC2, Amazon SQS, Amazon Relational Database Service, Amazon AutoScaling, etc).

There is a newer version: 1.11.60
Show newest version
/*
 * Copyright 2011-2016 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.elasticloadbalancing.model;

import java.io.Serializable;

/**
 * 

* Information about a health check. *

*/ public class HealthCheck implements Serializable, Cloneable { /** *

* The instance being checked. The protocol is either TCP, HTTP, HTTPS, or * SSL. The range of valid ports is one (1) through 65535. *

*

* TCP is the default, specified as a TCP: port pair, for example * "TCP:5000". In this case, a health check simply attempts to open a TCP * connection to the instance on the specified port. Failure to connect * within the configured timeout is considered unhealthy. *

*

* SSL is also specified as SSL: port pair, for example, SSL:5000. *

*

* For HTTP/HTTPS, you must include a ping path in the string. HTTP is * specified as a HTTP:port;/;PathToPing; grouping, for example * "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is * issued to the instance on the given port and path. Any answer other than * "200 OK" within the timeout period is considered unhealthy. *

*

* The total length of the HTTP ping target must be 1024 16-bit Unicode * characters or less. *

*/ private String target; /** *

* The approximate interval, in seconds, between health checks of an * individual instance. *

*/ private Integer interval; /** *

* The amount of time, in seconds, during which no response means a failed * health check. *

*

* This value must be less than the Interval value. *

*/ private Integer timeout; /** *

* The number of consecutive health check failures required before moving * the instance to the Unhealthy state. *

*/ private Integer unhealthyThreshold; /** *

* The number of consecutive health checks successes required before moving * the instance to the Healthy state. *

*/ private Integer healthyThreshold; /** * Default constructor for HealthCheck object. Callers should use the setter * or fluent setter (with...) methods to initialize the object after * creating it. */ public HealthCheck() { } /** * Constructs a new HealthCheck object. Callers should use the setter or * fluent setter (with...) methods to initialize any additional object * members. * * @param target * The instance being checked. The protocol is either TCP, HTTP, * HTTPS, or SSL. The range of valid ports is one (1) through * 65535.

*

* TCP is the default, specified as a TCP: port pair, for example * "TCP:5000". In this case, a health check simply attempts to open a * TCP connection to the instance on the specified port. Failure to * connect within the configured timeout is considered unhealthy. *

*

* SSL is also specified as SSL: port pair, for example, SSL:5000. *

*

* For HTTP/HTTPS, you must include a ping path in the string. HTTP * is specified as a HTTP:port;/;PathToPing; grouping, for example * "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request * is issued to the instance on the given port and path. Any answer * other than "200 OK" within the timeout period is considered * unhealthy. *

*

* The total length of the HTTP ping target must be 1024 16-bit * Unicode characters or less. * @param interval * The approximate interval, in seconds, between health checks of an * individual instance. * @param timeout * The amount of time, in seconds, during which no response means a * failed health check. *

*

* This value must be less than the Interval value. * @param unhealthyThreshold * The number of consecutive health check failures required before * moving the instance to the Unhealthy state. * @param healthyThreshold * The number of consecutive health checks successes required before * moving the instance to the Healthy state. */ public HealthCheck(String target, Integer interval, Integer timeout, Integer unhealthyThreshold, Integer healthyThreshold) { setTarget(target); setInterval(interval); setTimeout(timeout); setUnhealthyThreshold(unhealthyThreshold); setHealthyThreshold(healthyThreshold); } /** *

* The instance being checked. The protocol is either TCP, HTTP, HTTPS, or * SSL. The range of valid ports is one (1) through 65535. *

*

* TCP is the default, specified as a TCP: port pair, for example * "TCP:5000". In this case, a health check simply attempts to open a TCP * connection to the instance on the specified port. Failure to connect * within the configured timeout is considered unhealthy. *

*

* SSL is also specified as SSL: port pair, for example, SSL:5000. *

*

* For HTTP/HTTPS, you must include a ping path in the string. HTTP is * specified as a HTTP:port;/;PathToPing; grouping, for example * "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is * issued to the instance on the given port and path. Any answer other than * "200 OK" within the timeout period is considered unhealthy. *

*

* The total length of the HTTP ping target must be 1024 16-bit Unicode * characters or less. *

* * @param target * The instance being checked. The protocol is either TCP, HTTP, * HTTPS, or SSL. The range of valid ports is one (1) through * 65535.

*

* TCP is the default, specified as a TCP: port pair, for example * "TCP:5000". In this case, a health check simply attempts to open a * TCP connection to the instance on the specified port. Failure to * connect within the configured timeout is considered unhealthy. *

*

* SSL is also specified as SSL: port pair, for example, SSL:5000. *

*

* For HTTP/HTTPS, you must include a ping path in the string. HTTP * is specified as a HTTP:port;/;PathToPing; grouping, for example * "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request * is issued to the instance on the given port and path. Any answer * other than "200 OK" within the timeout period is considered * unhealthy. *

*

* The total length of the HTTP ping target must be 1024 16-bit * Unicode characters or less. */ public void setTarget(String target) { this.target = target; } /** *

* The instance being checked. The protocol is either TCP, HTTP, HTTPS, or * SSL. The range of valid ports is one (1) through 65535. *

*

* TCP is the default, specified as a TCP: port pair, for example * "TCP:5000". In this case, a health check simply attempts to open a TCP * connection to the instance on the specified port. Failure to connect * within the configured timeout is considered unhealthy. *

*

* SSL is also specified as SSL: port pair, for example, SSL:5000. *

*

* For HTTP/HTTPS, you must include a ping path in the string. HTTP is * specified as a HTTP:port;/;PathToPing; grouping, for example * "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is * issued to the instance on the given port and path. Any answer other than * "200 OK" within the timeout period is considered unhealthy. *

*

* The total length of the HTTP ping target must be 1024 16-bit Unicode * characters or less. *

* * @return The instance being checked. The protocol is either TCP, HTTP, * HTTPS, or SSL. The range of valid ports is one (1) through * 65535.

*

* TCP is the default, specified as a TCP: port pair, for example * "TCP:5000". In this case, a health check simply attempts to open * a TCP connection to the instance on the specified port. Failure * to connect within the configured timeout is considered unhealthy. *

*

* SSL is also specified as SSL: port pair, for example, SSL:5000. *

*

* For HTTP/HTTPS, you must include a ping path in the string. HTTP * is specified as a HTTP:port;/;PathToPing; grouping, for example * "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request * is issued to the instance on the given port and path. Any answer * other than "200 OK" within the timeout period is considered * unhealthy. *

*

* The total length of the HTTP ping target must be 1024 16-bit * Unicode characters or less. */ public String getTarget() { return this.target; } /** *

* The instance being checked. The protocol is either TCP, HTTP, HTTPS, or * SSL. The range of valid ports is one (1) through 65535. *

*

* TCP is the default, specified as a TCP: port pair, for example * "TCP:5000". In this case, a health check simply attempts to open a TCP * connection to the instance on the specified port. Failure to connect * within the configured timeout is considered unhealthy. *

*

* SSL is also specified as SSL: port pair, for example, SSL:5000. *

*

* For HTTP/HTTPS, you must include a ping path in the string. HTTP is * specified as a HTTP:port;/;PathToPing; grouping, for example * "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is * issued to the instance on the given port and path. Any answer other than * "200 OK" within the timeout period is considered unhealthy. *

*

* The total length of the HTTP ping target must be 1024 16-bit Unicode * characters or less. *

* * @param target * The instance being checked. The protocol is either TCP, HTTP, * HTTPS, or SSL. The range of valid ports is one (1) through * 65535.

*

* TCP is the default, specified as a TCP: port pair, for example * "TCP:5000". In this case, a health check simply attempts to open a * TCP connection to the instance on the specified port. Failure to * connect within the configured timeout is considered unhealthy. *

*

* SSL is also specified as SSL: port pair, for example, SSL:5000. *

*

* For HTTP/HTTPS, you must include a ping path in the string. HTTP * is specified as a HTTP:port;/;PathToPing; grouping, for example * "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request * is issued to the instance on the given port and path. Any answer * other than "200 OK" within the timeout period is considered * unhealthy. *

*

* The total length of the HTTP ping target must be 1024 16-bit * Unicode characters or less. * @return Returns a reference to this object so that method calls can be * chained together. */ public HealthCheck withTarget(String target) { setTarget(target); return this; } /** *

* The approximate interval, in seconds, between health checks of an * individual instance. *

* * @param interval * The approximate interval, in seconds, between health checks of an * individual instance. */ public void setInterval(Integer interval) { this.interval = interval; } /** *

* The approximate interval, in seconds, between health checks of an * individual instance. *

* * @return The approximate interval, in seconds, between health checks of an * individual instance. */ public Integer getInterval() { return this.interval; } /** *

* The approximate interval, in seconds, between health checks of an * individual instance. *

* * @param interval * The approximate interval, in seconds, between health checks of an * individual instance. * @return Returns a reference to this object so that method calls can be * chained together. */ public HealthCheck withInterval(Integer interval) { setInterval(interval); return this; } /** *

* The amount of time, in seconds, during which no response means a failed * health check. *

*

* This value must be less than the Interval value. *

* * @param timeout * The amount of time, in seconds, during which no response means a * failed health check.

*

* This value must be less than the Interval value. */ public void setTimeout(Integer timeout) { this.timeout = timeout; } /** *

* The amount of time, in seconds, during which no response means a failed * health check. *

*

* This value must be less than the Interval value. *

* * @return The amount of time, in seconds, during which no response means a * failed health check.

*

* This value must be less than the Interval value. */ public Integer getTimeout() { return this.timeout; } /** *

* The amount of time, in seconds, during which no response means a failed * health check. *

*

* This value must be less than the Interval value. *

* * @param timeout * The amount of time, in seconds, during which no response means a * failed health check.

*

* This value must be less than the Interval value. * @return Returns a reference to this object so that method calls can be * chained together. */ public HealthCheck withTimeout(Integer timeout) { setTimeout(timeout); return this; } /** *

* The number of consecutive health check failures required before moving * the instance to the Unhealthy state. *

* * @param unhealthyThreshold * The number of consecutive health check failures required before * moving the instance to the Unhealthy state. */ public void setUnhealthyThreshold(Integer unhealthyThreshold) { this.unhealthyThreshold = unhealthyThreshold; } /** *

* The number of consecutive health check failures required before moving * the instance to the Unhealthy state. *

* * @return The number of consecutive health check failures required before * moving the instance to the Unhealthy state. */ public Integer getUnhealthyThreshold() { return this.unhealthyThreshold; } /** *

* The number of consecutive health check failures required before moving * the instance to the Unhealthy state. *

* * @param unhealthyThreshold * The number of consecutive health check failures required before * moving the instance to the Unhealthy state. * @return Returns a reference to this object so that method calls can be * chained together. */ public HealthCheck withUnhealthyThreshold(Integer unhealthyThreshold) { setUnhealthyThreshold(unhealthyThreshold); return this; } /** *

* The number of consecutive health checks successes required before moving * the instance to the Healthy state. *

* * @param healthyThreshold * The number of consecutive health checks successes required before * moving the instance to the Healthy state. */ public void setHealthyThreshold(Integer healthyThreshold) { this.healthyThreshold = healthyThreshold; } /** *

* The number of consecutive health checks successes required before moving * the instance to the Healthy state. *

* * @return The number of consecutive health checks successes required before * moving the instance to the Healthy state. */ public Integer getHealthyThreshold() { return this.healthyThreshold; } /** *

* The number of consecutive health checks successes required before moving * the instance to the Healthy state. *

* * @param healthyThreshold * The number of consecutive health checks successes required before * moving the instance to the Healthy state. * @return Returns a reference to this object so that method calls can be * chained together. */ public HealthCheck withHealthyThreshold(Integer healthyThreshold) { setHealthyThreshold(healthyThreshold); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getTarget() != null) sb.append("Target: " + getTarget() + ","); if (getInterval() != null) sb.append("Interval: " + getInterval() + ","); if (getTimeout() != null) sb.append("Timeout: " + getTimeout() + ","); if (getUnhealthyThreshold() != null) sb.append("UnhealthyThreshold: " + getUnhealthyThreshold() + ","); if (getHealthyThreshold() != null) sb.append("HealthyThreshold: " + getHealthyThreshold()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof HealthCheck == false) return false; HealthCheck other = (HealthCheck) obj; if (other.getTarget() == null ^ this.getTarget() == null) return false; if (other.getTarget() != null && other.getTarget().equals(this.getTarget()) == false) return false; if (other.getInterval() == null ^ this.getInterval() == null) return false; if (other.getInterval() != null && other.getInterval().equals(this.getInterval()) == false) return false; if (other.getTimeout() == null ^ this.getTimeout() == null) return false; if (other.getTimeout() != null && other.getTimeout().equals(this.getTimeout()) == false) return false; if (other.getUnhealthyThreshold() == null ^ this.getUnhealthyThreshold() == null) return false; if (other.getUnhealthyThreshold() != null && other.getUnhealthyThreshold().equals( this.getUnhealthyThreshold()) == false) return false; if (other.getHealthyThreshold() == null ^ this.getHealthyThreshold() == null) return false; if (other.getHealthyThreshold() != null && other.getHealthyThreshold().equals( this.getHealthyThreshold()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getTarget() == null) ? 0 : getTarget().hashCode()); hashCode = prime * hashCode + ((getInterval() == null) ? 0 : getInterval().hashCode()); hashCode = prime * hashCode + ((getTimeout() == null) ? 0 : getTimeout().hashCode()); hashCode = prime * hashCode + ((getUnhealthyThreshold() == null) ? 0 : getUnhealthyThreshold().hashCode()); hashCode = prime * hashCode + ((getHealthyThreshold() == null) ? 0 : getHealthyThreshold() .hashCode()); return hashCode; } @Override public HealthCheck clone() { try { return (HealthCheck) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException( "Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy