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

Interface PoolAttributes

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    Pool
    @Generated("mdsal-binding-generator")
public interface PoolAttributes
extends org.opendaylight.yangtools.yang.binding.DataObject

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

     grouping pool-attributes {
   leaf admin-state-up {
     type boolean;
   }
   leaf protocol {
     type identityref {
       base protocol-base;
     }
   }
   leaf lb-algorithm {
     type string;
   }
   leaf healthmonitor-id {
     type yang:uuid;
   }
   leaf-list listeners {
     type yang:uuid;
   }
   container session-persistence {
     leaf cookie-name {
       type string;
     }
     leaf type {
       type string;
     }
   }
 }
    The schema path to identify an instance is neutron-lbaasv2/pool-attributes

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        Class<? extends PoolAttributes> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • getAdminStateUp

        Boolean getAdminStateUp()
        Return adminStateUp, or null if it is not present. 
             
         The administrative state of the pool, 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 pool, which is up (true) or down (false).
        Returns:
        Boolean adminStateUp, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if adminStateUp is not present

      • getProtocol

        Class<? extends ProtocolBase> getProtocol()
        Return protocol, or null if it is not present. 
             
         The protocol the front end listens for.
        Returns:
        Class<? extends ProtocolBase> protocol, or null if it is not present.

      • requireProtocol

        default @NonNull Class<? extends ProtocolBase> requireProtocol()
        Return protocol, guaranteed to be non-null. 
             
         The protocol the front end listens for.
        Returns:
        Class<? extends ProtocolBase> protocol, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if protocol is not present

      • getLbAlgorithm

        String getLbAlgorithm()
        Return lbAlgorithm, or null if it is not present. 
             
         The load-balancer algorithm, which is round-robin, least-connections, and so on.
         This value, which must be supported, is dependent on the load-balancer provider.
         Round-robin must be supported.
        Returns:
        String lbAlgorithm, or null if it is not present.

      • requireLbAlgorithm

        default @NonNull String requireLbAlgorithm()
        Return lbAlgorithm, guaranteed to be non-null. 
             
         The load-balancer algorithm, which is round-robin, least-connections, and so on.
         This value, which must be supported, is dependent on the load-balancer provider.
         Round-robin must be supported.
        Returns:
        String lbAlgorithm, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if lbAlgorithm is not present

      • getHealthmonitorId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getHealthmonitorId()
        Return healthmonitorId, or null if it is not present. 
             
         The healthmonitor associated with this pool.
        Returns:
        Uuid healthmonitorId, or null if it is not present.

      • requireHealthmonitorId

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireHealthmonitorId()
        Return healthmonitorId, guaranteed to be non-null. 
             
         The healthmonitor associated with this pool.
        Returns:
        Uuid healthmonitorId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if healthmonitorId is not present

      • getListeners

        @Nullable List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getListeners()
        Return listeners, or null if it is not present. 
             
         List of listeners that belong to the pool.
        Returns:
        List<Uuid> listeners, or null if it is not present.

      • requireListeners

        default @NonNull List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> requireListeners()
        Return listeners, guaranteed to be non-null. 
             
         List of listeners that belong to the pool.
        Returns:
        List<Uuid> listeners, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if listeners is not present

      • getSessionPersistence

        SessionPersistence getSessionPersistence()
        Return sessionPersistence, or null if it is not present. 
             
         The session persistence algorithm. This algorithm is a dictionary with type and
         cookie_name keys.
        Returns:
        SessionPersistence sessionPersistence, or null if it is not present.