All Superinterfaces:: org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

All Known Subinterfaces:: Healthmonitor

@Generated("mdsal-binding-generator")
public interface HealthmonitorAttributes
extends org.opendaylight.yangtools.yang.binding.DataObject

This class represents the following YANG schema fragment defined in module neutron-lbaasv2

 grouping healthmonitor-attributes {
   leaf type {
     type identityref {
       base probe-base;
     }
   }
   leaf admin-state-up {
     type boolean;
     default true;
   }
   leaf delay {
     type uint32;
   }
   leaf timeout {
     type uint32;
   }
   leaf max-retries {
     type uint16 {
       range 1..10;
     }
   }
   leaf http-method {
     type string;
     default "";
   }
   leaf url-path {
     type string;
   }
   leaf expected-codes {
     type string;
     default "";
   }
   leaf-list pools {
     type yang:uuid;
   }
 }

The schema path to identify an instance is neutron-lbaasv2/healthmonitor-attributes

Field Summary

Fields
Modifier and Type Field Description

static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`Boolean`	`getAdminStateUp()`	Return adminStateUp, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint32`	`getDelay()`	Return delay, or `null` if it is not present.
`String`	`getExpectedCodes()`	Return expectedCodes, or `null` if it is not present.
`String`	`getHttpMethod()`	Return httpMethod, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint16`	`getMaxRetries()`	Return maxRetries, or `null` if it is not present.
`@Nullable List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid>`	`getPools()`	Return pools, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint32`	`getTimeout()`	Return timeout, or `null` if it is not present.
`Class<? extends ProbeBase>`	`getType()`	Return type, or `null` if it is not present.
`String`	`getUrlPath()`	Return urlPath, or `null` if it is not present.
`Class<? extends HealthmonitorAttributes>`	`implementedInterface()`
`default @NonNull Boolean`	`requireAdminStateUp()`	Return adminStateUp, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint32`	`requireDelay()`	Return delay, guaranteed to be non-null.
`default @NonNull String`	`requireExpectedCodes()`	Return expectedCodes, guaranteed to be non-null.
`default @NonNull String`	`requireHttpMethod()`	Return httpMethod, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint16`	`requireMaxRetries()`	Return maxRetries, guaranteed to be non-null.
`default @NonNull List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid>`	`requirePools()`	Return pools, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint32`	`requireTimeout()`	Return timeout, guaranteed to be non-null.
`default @NonNull Class<? extends ProbeBase>`	`requireType()`	Return type, guaranteed to be non-null.
`default @NonNull String`	`requireUrlPath()`	Return urlPath, guaranteed to be non-null.

Field Detail

QNAME

static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

Method Detail

implementedInterface
```
Class<? extends HealthmonitorAttributes> implementedInterface()
```
Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

getType

Class<? extends ProbeBase> getType()

Return type, or null if it is not present.

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

Returns:: Class<? extends ProbeBase> type, or null if it is not present.

requireType

default @NonNull Class<? extends ProbeBase> requireType()

Return type, guaranteed to be non-null.

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

Returns:: Class<? extends ProbeBase> type, guaranteed to be non-null.
Throws:: NoSuchElementException - if type is not present

getAdminStateUp

Boolean getAdminStateUp()

Return adminStateUp, or null if it is not present.

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

Returns:: Boolean adminStateUp, or null if it is not present.

requireAdminStateUp
```
default @NonNull Boolean requireAdminStateUp()
```
Return adminStateUp, guaranteed to be non-null.
```
     
         The administrative state of the VPI, which is up (true) or down (false).
     
 
```
Returns:

Boolean adminStateUp, guaranteed to be non-null.

Throws:

NoSuchElementException - if adminStateUp is not present

getDelay

org.opendaylight.yangtools.yang.common.Uint32 getDelay()

Return delay, or null if it is not present.

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

Returns:: Uint32 delay, or null if it is not present.

requireDelay

default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireDelay()

Return delay, guaranteed to be non-null.

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

Returns:: Uint32 delay, guaranteed to be non-null.
Throws:: NoSuchElementException - if delay is not present

getTimeout

org.opendaylight.yangtools.yang.common.Uint32 getTimeout()

Return timeout, or null if it is not present.

     
         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.

Returns:: Uint32 timeout, or null if it is not present.

requireTimeout

default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireTimeout()

Return timeout, guaranteed to be non-null.

     
         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.

Returns:: Uint32 timeout, guaranteed to be non-null.
Throws:: NoSuchElementException - if timeout is not present

getMaxRetries

org.opendaylight.yangtools.yang.common.Uint16 getMaxRetries()

Return maxRetries, or null if it is not present.

     
         Number of allowed connection failures before changing the status of the member
         to INACTIVE.

Returns:: Uint16 maxRetries, or null if it is not present.

requireMaxRetries

default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireMaxRetries()

Return maxRetries, guaranteed to be non-null.

     
         Number of allowed connection failures before changing the status of the member
         to INACTIVE.

Returns:: Uint16 maxRetries, guaranteed to be non-null.
Throws:: NoSuchElementException - if maxRetries is not present

getHttpMethod

String getHttpMethod()

Return httpMethod, or null if it is not present.

     
         The HTTP method that the monitor uses for requests.

Returns:: String httpMethod, or null if it is not present.

requireHttpMethod
```
default @NonNull String requireHttpMethod()
```
Return httpMethod, guaranteed to be non-null.
```
     
         The HTTP method that the monitor uses for requests.
     
 
```
Returns:

String httpMethod, guaranteed to be non-null.

Throws:

NoSuchElementException - if httpMethod is not present

getUrlPath

String getUrlPath()

Return urlPath, or null if it is not present.

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

Returns:: String urlPath, or null if it is not present.

requireUrlPath

default @NonNull String requireUrlPath()

Return urlPath, guaranteed to be non-null.

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

Returns:: String urlPath, guaranteed to be non-null.
Throws:: NoSuchElementException - if urlPath is not present

getExpectedCodes

String getExpectedCodes()

Return expectedCodes, or null if it is not present.

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

Returns:: String expectedCodes, or null if it is not present.

requireExpectedCodes
```
default @NonNull String requireExpectedCodes()
```
Return expectedCodes, guaranteed to be non-null.
```
     
         Expected HTTP codes for a passing HTTP(S) monitor.
     
 
```
Returns:

String expectedCodes, guaranteed to be non-null.

Throws:

NoSuchElementException - if expectedCodes is not present

getPools

@Nullable List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getPools()

Return pools, or null if it is not present.

     
         List of pools associated with this healthmonitor.

Returns:: List<Uuid> pools, or null if it is not present.

requirePools

default @NonNull List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> requirePools()

Return pools, guaranteed to be non-null.

     
         List of pools associated with this healthmonitor.

Returns:: List<Uuid> pools, guaranteed to be non-null.
Throws:: NoSuchElementException - if pools is not present

Interface HealthmonitorAttributes

Field Summary