Package org.openstack4j.openstack.octavia.domain

Class OctaviaHealthMonitorV2

java.lang.Object

org.openstack4j.openstack.octavia.domain.OctaviaHealthMonitorV2

All Implemented Interfaces:

Serializable, Buildable<HealthMonitorV2Builder>, ModelEntity, HealthMonitorV2

public class OctaviaHealthMonitorV2
extends Object
implements HealthMonitorV2

A lbaas v2 health monitor entity

Author:

wei

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OctaviaHealthMonitorV2.HealthMonitorsV2
static class	OctaviaHealthMonitorV2.HealthMonitorV2Concretebuilder

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	Description
OctaviaHealthMonitorV2()

Method Summary

Modifier and Type	Method	Description
static HealthMonitorV2Builder	builder()
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.
HealthMonitorV2Builder	toBuilder()	wrap this healthMonitorV2 to a builder
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OctaviaHealthMonitorV2

public OctaviaHealthMonitorV2()

Method Detail

builder

public static HealthMonitorV2Builder builder()

Returns:

HealthMonitorV2Builder

getId

public String getId()

Specified by:

getId in interface HealthMonitorV2

Returns:

id the healthMonitor identifier

getProjectId

public String getProjectId()

Specified by:

getProjectId in interface HealthMonitorV2

Returns:

the ID of the project/tenant that owns the resource

getType

public HealthMonitorType getType()

Specified by:

getType in interface HealthMonitorV2

Returns:

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

getDelay

public Integer getDelay()

Specified by:

getDelay in interface HealthMonitorV2

Returns:

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

getTimeout

public Integer getTimeout()

Specified by:

getTimeout in interface HealthMonitorV2

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 HealthMonitorV2

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

public Integer getMaxRetriesDown()

Specified by:

getMaxRetriesDown in interface HealthMonitorV2

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

public String getHttpMethod()

Description copied from interface: HealthMonitorV2

Optional.

Specified by:

getHttpMethod in interface HealthMonitorV2

Returns:

httpMethod The HTTP method that the monitor uses for requests.

getUrlPath

public String getUrlPath()

Description copied from interface: HealthMonitorV2

Optional.

Specified by:

getUrlPath in interface HealthMonitorV2

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

Description copied from interface: HealthMonitorV2

Optional.

Specified by:

getExpectedCodes in interface HealthMonitorV2

Returns:

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

isAdminStateUp

public boolean isAdminStateUp()

Description copied from interface: HealthMonitorV2

Optional.

Specified by:

isAdminStateUp in interface HealthMonitorV2

Returns:

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

getPools

public List<ListItem> getPools()

Description copied from interface: HealthMonitorV2

The pools that this health monitor will monitor.

Specified by:

getPools in interface HealthMonitorV2

Returns:

pools

toBuilder

public HealthMonitorV2Builder toBuilder()

wrap this healthMonitorV2 to a builder

Specified by:

toBuilder in interface Buildable<HealthMonitorV2Builder>

Returns:

HealthMonitorV2Builder

toString

public String toString()

Overrides:

toString in class Object