Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.lbaasv2.rev150712

Interface HealthmonitorAttributes

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    Healthmonitor
    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 
      Modifier and Type Method Description
      @Nullable org.opendaylight.yangtools.yang.common.Uint32 getDelay()
      The time, in seconds, between sending probes to members.
      @Nullable String getExpectedCodes()
      Expected HTTP codes for a passing HTTP(S) monitor.
      @Nullable String getHttpMethod()
      The HTTP method that the monitor uses for requests.
      @Nullable org.opendaylight.yangtools.yang.common.Uint16 getMaxRetries()
      Number of allowed connection failures before changing the status of the member to INACTIVE.
      @Nullable List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getPools()
      List of pools associated with this healthmonitor.
      @Nullable org.opendaylight.yangtools.yang.common.Uint32 getTimeout()
      The maximum number of seconds for a monitor to wait for a connection to be established before it times out.
      @Nullable Class<? extends ProbeBase> getType()
      The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the load balancer to verify the member state.
      @Nullable String getUrlPath()
      The HTTP path of the request sent by the monitor to test the health of a member.
      Class<? extends HealthmonitorAttributes> implementedInterface()  
      @Nullable Boolean isAdminStateUp()
      The administrative state of the VPI, which is up (true) or down (false).

    • 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

        @Nullable Class<? extends ProbeBase> getType()
        The type of probe, which is PING, TCP, HTTP, or HTTPS, that is sent by the load balancer to verify the member state.
        Returns:
        java.lang.Class type, or null if not present

      • isAdminStateUp

        @Nullable Boolean isAdminStateUp()
        The administrative state of the VPI, which is up (true) or down (false).
        Returns:
        java.lang.Boolean adminStateUp, or null if not present

      • getDelay

        @Nullable org.opendaylight.yangtools.yang.common.Uint32 getDelay()
        The time, in seconds, between sending probes to members.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 delay, or null if not present

      • getTimeout

        @Nullable org.opendaylight.yangtools.yang.common.Uint32 getTimeout()
        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:
        org.opendaylight.yangtools.yang.common.Uint32 timeout, or null if not present

      • getMaxRetries

        @Nullable org.opendaylight.yangtools.yang.common.Uint16 getMaxRetries()
        Number of allowed connection failures before changing the status of the member to INACTIVE.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 maxRetries, or null if not present

      • getHttpMethod

        @Nullable String getHttpMethod()
        The HTTP method that the monitor uses for requests.
        Returns:
        java.lang.String httpMethod, or null if not present

      • getUrlPath

        @Nullable String getUrlPath()
        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:
        java.lang.String urlPath, or null if not present

      • getExpectedCodes

        @Nullable String getExpectedCodes()
        Expected HTTP codes for a passing HTTP(S) monitor.
        Returns:
        java.lang.String expectedCodes, or null if not present

      • getPools

        @Nullable List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getPools()
        List of pools associated with this healthmonitor.
        Returns:
        java.util.List pools, or null if not present