org.openstack4j.openstack.networking.domain.ext

Class NeutronHealthMonitor

java.lang.Object

org.openstack4j.openstack.networking.domain.ext.NeutronHealthMonitor

All Implemented Interfaces:

Serializable, Buildable<HealthMonitorBuilder>, ModelEntity, HealthMonitor

public class NeutronHealthMonitor
extends Object
implements HealthMonitor

A health monitor entity

Author:

liujunpeng

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NeutronHealthMonitor.HealthMonitorConcretebuilder
static class	NeutronHealthMonitor.HealthMonitors

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

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

Constructor Summary

Constructors

Constructor and Description
NeutronHealthMonitor()

Method Summary

Modifier and Type	Method and Description
static HealthMonitorBuilder	builder()
Integer	getDelay()
String	getExpectedCodes() Optional.
String	getHttpMethod() Optional.
String	getId()
Integer	getMaxRetries()
String	getStatus()
String	getTenantId()
Integer	getTimeout()
HealthMonitorType	getType()
String	getUrlPath() Optional.
boolean	isAdminStateUp() Optional.
HealthMonitorBuilder	toBuilder() wrap this healthMonitor to a builder
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NeutronHealthMonitor

public NeutronHealthMonitor()

Method Detail

toBuilder

public HealthMonitorBuilder toBuilder()

wrap this healthMonitor to a builder

Specified by:

toBuilder in interface Buildable<HealthMonitorBuilder>

Returns:

HealthMonitorBuilder

builder

public static HealthMonitorBuilder builder()

Returns:

HealthMonitorBuilder

getId

public String getId()

Specified by:

getId in interface HealthMonitor

Returns:

id the healthMonitor identifier

getTenantId

public String getTenantId()

Specified by:

getTenantId in interface HealthMonitor

Returns:

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

getType

public HealthMonitorType getType()

Specified by:

getType in interface HealthMonitor

Returns:

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

getDelay

public Integer getDelay()

Specified by:

getDelay in interface HealthMonitor

Returns:

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

getTimeout

public Integer getTimeout()

Specified by:

getTimeout in interface HealthMonitor

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

public Integer getMaxRetries()

Specified by:

getMaxRetries in interface HealthMonitor

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

public String getHttpMethod()

Optional.

Specified by:

getHttpMethod in interface HealthMonitor

Returns:

httpMethod The HTTP method that the monitor uses for requests.

getUrlPath

public String getUrlPath()

Optional.

Specified by:

getUrlPath in interface HealthMonitor

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

public String getExpectedCodes()

Optional.

Specified by:

getExpectedCodes in interface HealthMonitor

Returns:

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

isAdminStateUp

public boolean isAdminStateUp()

Optional.

Specified by:

isAdminStateUp in interface HealthMonitor

Returns:

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

getStatus

public String getStatus()

Specified by:

getStatus in interface HealthMonitor

Returns:

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

toString

public String toString()

Overrides:

toString in class Object