org.openstack4j.model.network.ext.HealthMonitor Maven / Gradle / Ivy
package org.openstack4j.model.network.ext;
import org.openstack4j.common.Buildable;
import org.openstack4j.model.ModelEntity;
import org.openstack4j.model.network.ext.builder.HealthMonitorBuilder;
/**
* A healthMonitor of a Lbaas pool
*
* @author liujunpeng
*
*/
public interface HealthMonitor extends ModelEntity,
Buildable {
/**
*
* @return id the healthMonitor identifier
*/
public String getId();
/**
*
* @return tenantId Owner of the VIP. Only an administrative user can
* specify a tenant ID other than its own.
*/
public String getTenantId();
/**
*
* @return type The type of probe sent by the load balancer to verify the
* member state, which is PING, TCP, HTTP, or HTTPS.
*/
public HealthMonitorType getType();
/**
*
* @return delay The time, in seconds, between sending probes to members.
*/
public Integer getDelay();
/**
* @return timeout The maximum number of seconds for a monitor to wait for a
* connection to be established before it times out. This value must
* be less than the delay value.
*/
public Integer getTimeout();
/**
*
* @return maxRetries Number of allowed connection failures before changing
* the status of the member to INACTIVE. A valid value is from 1 to
* 10.
*/
public Integer getMaxRetries();
/**
* Optional.
*
* @return httpMethod The HTTP method that the monitor uses for requests.
*/
public String getHttpMethod();
/**
* Optional.
*
* @return urlPath The HTTP path of the request sent by the monitor to test
* the health of a member. Must be a string beginning with a forward
* slash (/).
*/
public String getUrlPath();
/**
* Optional.
*
* @return expectedCodes Expected HTTP codes for a passing HTTP(S) monitor.
*/
public String getExpectedCodes();
/**
* Optional.
*
* @return adminstateup The administrative state of the health monitor,
* which is up (true) or down (false).
*/
public boolean isAdminStateUp();
/**
* @return status The status of the health monitor. Indicates whether the
* health monitor is operational.
*/
public String getStatus();
}