com.amazonaws.services.elasticloadbalancing.model.HealthCheck Maven / Gradle / Ivy
/*
* Copyright 2010-2011 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;
/**
*
* The HealthCheck data type.
*
*/
public class HealthCheck {
/**
* Specifies the instance being checked. The protocol is either TCP or
* HTTP. 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 healthcheck simply attempts to open a TCP
* connection to the instance on the specified port. Failure to connect
* within the configured timeout is considered unhealthy.
For HTTP,
* the situation is different. 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 needs to be 1024 16-bit
* Unicode characters or less.
*/
private String target;
/**
* Specifies the approximate interval, in seconds, between health checks
* of an individual instance.
*
* Constraints:
* Range: 1 - 300
*/
private Integer interval;
/**
* Specifies the amount of time, in seconds, during which no response
* means a failed health probe. This value must be less than the
* Interval value.
*
* Constraints:
* Range: 1 - 300
*/
private Integer timeout;
/**
* Specifies the number of consecutive health probe failures required
* before moving the instance to the Unhealthy state.
*
* Constraints:
* Range: 2 - 10
*/
private Integer unhealthyThreshold;
/**
* Specifies the number of consecutive health probe successes required
* before moving the instance to the Healthy state.
*
* Constraints:
* Range: 2 - 10
*/
private Integer healthyThreshold;
/**
* Default constructor for a new HealthCheck object. Callers should use the
* setter or fluent setter (with...) methods to initialize this 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 Specifies the instance being checked. The protocol is
* either TCP or HTTP. 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 healthcheck simply attempts to open
* a TCP connection to the instance on the specified port. Failure to
* connect within the configured timeout is considered unhealthy.
For
* HTTP, the situation is different. 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 needs to be 1024 16-bit
* Unicode characters or less.
* @param interval Specifies the approximate interval, in seconds,
* between health checks of an individual instance.
* @param timeout Specifies the amount of time, in seconds, during which
* no response means a failed health probe. This value must be
* less than the Interval value.
* @param unhealthyThreshold Specifies the number of consecutive health
* probe failures required before moving the instance to the
* Unhealthy state.
* @param healthyThreshold Specifies the number of consecutive health
* probe successes required before moving the instance to the
* Healthy state.
*/
public HealthCheck(String target, Integer interval, Integer timeout, Integer unhealthyThreshold, Integer healthyThreshold) {
this.target = target;
this.interval = interval;
this.timeout = timeout;
this.unhealthyThreshold = unhealthyThreshold;
this.healthyThreshold = healthyThreshold;
}
/**
* Specifies the instance being checked. The protocol is either TCP or
* HTTP. 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 healthcheck simply attempts to open a TCP
* connection to the instance on the specified port. Failure to connect
* within the configured timeout is considered unhealthy.
For HTTP,
* the situation is different. 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 needs to be 1024 16-bit
* Unicode characters or less.
*
* @return Specifies the instance being checked. The protocol is either TCP or
* HTTP. 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 healthcheck simply attempts to open a TCP
* connection to the instance on the specified port. Failure to connect
* within the configured timeout is considered unhealthy.
For HTTP,
* the situation is different. 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 needs to be 1024 16-bit
* Unicode characters or less.
*/
public String getTarget() {
return target;
}
/**
* Specifies the instance being checked. The protocol is either TCP or
* HTTP. 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 healthcheck simply attempts to open a TCP
* connection to the instance on the specified port. Failure to connect
* within the configured timeout is considered unhealthy.
For HTTP,
* the situation is different. 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 needs to be 1024 16-bit
* Unicode characters or less.
*
* @param target Specifies the instance being checked. The protocol is either TCP or
* HTTP. 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 healthcheck simply attempts to open a TCP
* connection to the instance on the specified port. Failure to connect
* within the configured timeout is considered unhealthy.
For HTTP,
* the situation is different. 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 needs to be 1024 16-bit
* Unicode characters or less.
*/
public void setTarget(String target) {
this.target = target;
}
/**
* Specifies the instance being checked. The protocol is either TCP or
* HTTP. 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 healthcheck simply attempts to open a TCP
* connection to the instance on the specified port. Failure to connect
* within the configured timeout is considered unhealthy.
For HTTP,
* the situation is different. 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 needs to be 1024 16-bit
* Unicode characters or less.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param target Specifies the instance being checked. The protocol is either TCP or
* HTTP. 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 healthcheck simply attempts to open a TCP
* connection to the instance on the specified port. Failure to connect
* within the configured timeout is considered unhealthy.
For HTTP,
* the situation is different. 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 needs to be 1024 16-bit
* Unicode characters or less.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public HealthCheck withTarget(String target) {
this.target = target;
return this;
}
/**
* Specifies the approximate interval, in seconds, between health checks
* of an individual instance.
*
* Constraints:
* Range: 1 - 300
*
* @return Specifies the approximate interval, in seconds, between health checks
* of an individual instance.
*/
public Integer getInterval() {
return interval;
}
/**
* Specifies the approximate interval, in seconds, between health checks
* of an individual instance.
*
* Constraints:
* Range: 1 - 300
*
* @param interval Specifies the approximate interval, in seconds, between health checks
* of an individual instance.
*/
public void setInterval(Integer interval) {
this.interval = interval;
}
/**
* Specifies the approximate interval, in seconds, between health checks
* of an individual instance.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 1 - 300
*
* @param interval Specifies the approximate interval, in seconds, between health checks
* of an individual instance.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public HealthCheck withInterval(Integer interval) {
this.interval = interval;
return this;
}
/**
* Specifies the amount of time, in seconds, during which no response
* means a failed health probe. This value must be less than the
* Interval value.
*
* Constraints:
* Range: 1 - 300
*
* @return Specifies the amount of time, in seconds, during which no response
* means a failed health probe. This value must be less than the
* Interval value.
*/
public Integer getTimeout() {
return timeout;
}
/**
* Specifies the amount of time, in seconds, during which no response
* means a failed health probe. This value must be less than the
* Interval value.
*
* Constraints:
* Range: 1 - 300
*
* @param timeout Specifies the amount of time, in seconds, during which no response
* means a failed health probe. This value must be less than the
* Interval value.
*/
public void setTimeout(Integer timeout) {
this.timeout = timeout;
}
/**
* Specifies the amount of time, in seconds, during which no response
* means a failed health probe. This value must be less than the
* Interval value.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 1 - 300
*
* @param timeout Specifies the amount of time, in seconds, during which no response
* means a failed health probe. This value must be less than the
* Interval value.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public HealthCheck withTimeout(Integer timeout) {
this.timeout = timeout;
return this;
}
/**
* Specifies the number of consecutive health probe failures required
* before moving the instance to the Unhealthy state.
*
* Constraints:
* Range: 2 - 10
*
* @return Specifies the number of consecutive health probe failures required
* before moving the instance to the Unhealthy state.
*/
public Integer getUnhealthyThreshold() {
return unhealthyThreshold;
}
/**
* Specifies the number of consecutive health probe failures required
* before moving the instance to the Unhealthy state.
*
* Constraints:
* Range: 2 - 10
*
* @param unhealthyThreshold Specifies the number of consecutive health probe failures required
* before moving the instance to the Unhealthy state.
*/
public void setUnhealthyThreshold(Integer unhealthyThreshold) {
this.unhealthyThreshold = unhealthyThreshold;
}
/**
* Specifies the number of consecutive health probe failures required
* before moving the instance to the Unhealthy state.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 2 - 10
*
* @param unhealthyThreshold Specifies the number of consecutive health probe failures required
* before moving the instance to the Unhealthy state.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public HealthCheck withUnhealthyThreshold(Integer unhealthyThreshold) {
this.unhealthyThreshold = unhealthyThreshold;
return this;
}
/**
* Specifies the number of consecutive health probe successes required
* before moving the instance to the Healthy state.
*
* Constraints:
* Range: 2 - 10
*
* @return Specifies the number of consecutive health probe successes required
* before moving the instance to the Healthy state.
*/
public Integer getHealthyThreshold() {
return healthyThreshold;
}
/**
* Specifies the number of consecutive health probe successes required
* before moving the instance to the Healthy state.
*
* Constraints:
* Range: 2 - 10
*
* @param healthyThreshold Specifies the number of consecutive health probe successes required
* before moving the instance to the Healthy state.
*/
public void setHealthyThreshold(Integer healthyThreshold) {
this.healthyThreshold = healthyThreshold;
}
/**
* Specifies the number of consecutive health probe successes required
* before moving the instance to the Healthy state.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 2 - 10
*
* @param healthyThreshold Specifies the number of consecutive health probe successes required
* before moving the instance to the Healthy state.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public HealthCheck withHealthyThreshold(Integer healthyThreshold) {
this.healthyThreshold = 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("{");
sb.append("Target: " + target + ", ");
sb.append("Interval: " + interval + ", ");
sb.append("Timeout: " + timeout + ", ");
sb.append("UnhealthyThreshold: " + unhealthyThreshold + ", ");
sb.append("HealthyThreshold: " + healthyThreshold + ", ");
sb.append("}");
return sb.toString();
}
}