org.openstack4j.model.network.ext

Interface HealthMonitor

All Superinterfaces:

Buildable<HealthMonitorBuilder>, ModelEntity, Serializable

All Known Implementing Classes:

NeutronHealthMonitor

public interface HealthMonitor
extends ModelEntity, Buildable<HealthMonitorBuilder>

A healthMonitor of a Lbaas pool

Author:

liujunpeng

Nested Class Summary

Nested classes/interfaces inherited from interface org.openstack4j.common.Buildable

Buildable.Builder<T extends Buildable.Builder<T,M>,M extends Buildable<?>>

Method Summary

Modifier and Type	Method and Description
Integer	getDelay()
String	getExpectedCodes() Optional.
String	getHttpMethod() Optional.
String	getId()
Integer	getMaxRetries()
String	getStatus()
String	getTenantId()
Integer	getTimeout()
String	getType()
String	getUrlPath() Optional.
boolean	isAdminStateUp() Optional.

Methods inherited from interface org.openstack4j.common.Buildable

toBuilder

Method Detail

getId

String getId()

Returns:

id the healthMonitor identifier

getTenantId

String getTenantId()

Returns:

tenantId Owner of the VIP. Only an administrative user can specify a tenant ID other than its own.

getType

String getType()

Returns:

type The type of probe sent by the load balancer to verify the member state, which is PING, TCP, HTTP, or HTTPS.

getDelay

Integer getDelay()

Returns:

delay The time, in seconds, between sending probes to members.

getTimeout

Integer getTimeout()

Returns:

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.

getMaxRetries

Integer getMaxRetries()

Returns:

maxRetries Number of allowed connection failures before changing the status of the member to INACTIVE. A valid value is from 1 to 10.

getHttpMethod

String getHttpMethod()

Optional.

Returns:

httpMethod The HTTP method that the monitor uses for requests.

getUrlPath

String getUrlPath()

Optional.

Returns:

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 (/).

getExpectedCodes

String getExpectedCodes()

Optional.

Returns:

expectedCodes Expected HTTP codes for a passing HTTP(S) monitor.

isAdminStateUp

boolean isAdminStateUp()

Optional.

Returns:

adminstateup The administrative state of the health monitor, which is up (true) or down (false).

getStatus

String getStatus()

Returns:

status The status of the health monitor. Indicates whether the health monitor is operational.