org.openstack4j.model.octavia

Interface HealthMonitorV2

All Superinterfaces:

Buildable<HealthMonitorV2Builder>, ModelEntity, Serializable

All Known Implementing Classes:

OctaviaHealthMonitorV2

public interface HealthMonitorV2
extends ModelEntity, Buildable<HealthMonitorV2Builder>

A healthMonitor of a Lbaas V2 pool

Author:

wei

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()
Integer	getMaxRetriesDown()
List<ListItem>	getPools() The pools that this health monitor will monitor.
String	getProjectId()
Integer	getTimeout()
HealthMonitorType	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

getProjectId

String getProjectId()

Returns:

the ID of the project/tenant that owns the resource

getType

HealthMonitorType getType()

Returns:

type The type of probe sent by the load balancer to verify the member state, which is 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.

getMaxRetriesDown

Integer getMaxRetriesDown()

Returns:

maxRetriesDown 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). Default true.

getPools

List<ListItem> getPools()

The pools that this health monitor will monitor.

Returns:

pools