Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925

Interface FlowCapablePort

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, CommonPort, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, Queues
All Known Subinterfaces:
FlowCapableNodeConnector, FlowCapableNodeConnectorUpdated, FlowCapableNodeConnectorUpdateFields, FlowNodeConnector, FlowPortStatus, Ports
@Generated("mdsal-binding-generator") public interface FlowCapablePort extends org.opendaylight.yangtools.yang.binding.DataObject, CommonPort, Queues

This class represents the following YANG schema fragment defined in module opendaylight-port-types 

 grouping flow-capable-port {
   uses common-port;
   leaf name {
     type string;
   }
   container state {
     uses port-state;
   }
   leaf current-feature {
     type port-features;
   }
   leaf supported {
     type port-features;
   }
   leaf peer-features {
     type port-features;
   }
   leaf current-speed {
     type uint32;
     units kbps;
   }
   leaf maximum-speed {
     type uint32;
     units kbps;
   }
   uses queues;
 }

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

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

    • getName

      String getName()
      Return name, or null if it is not present. 
           
         Human readable name of the port
      Returns:
      String name, or null if it is not present.

    • requireName

      default @NonNull String requireName()
      Return name, guaranteed to be non-null. 
           
         Human readable name of the port
      Returns:
      String name, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if name is not present

    • getState

      State getState()
      Return state, or null if it is not present. 
           
         Description of state of port
      Returns:
      State state, or null if it is not present.

    • getCurrentFeature

      PortFeatures getCurrentFeature()
      Return currentFeature, or null if it is not present. 
           
         Bit map of OFPPF-* flags
      Returns:
      PortFeatures currentFeature, or null if it is not present.

    • requireCurrentFeature

      default @NonNull PortFeatures requireCurrentFeature()
      Return currentFeature, guaranteed to be non-null. 
           
         Bit map of OFPPF-* flags
      Returns:
      PortFeatures currentFeature, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if currentFeature is not present

    • getSupported

      PortFeatures getSupported()
      Return supported, or null if it is not present. 
           
         Features supported by the port
      Returns:
      PortFeatures supported, or null if it is not present.

    • requireSupported

      default @NonNull PortFeatures requireSupported()
      Return supported, guaranteed to be non-null. 
           
         Features supported by the port
      Returns:
      PortFeatures supported, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if supported is not present

    • getPeerFeatures

      PortFeatures getPeerFeatures()
      Return peerFeatures, or null if it is not present. 
           
         Features advertised by peer
      Returns:
      PortFeatures peerFeatures, or null if it is not present.

    • requirePeerFeatures

      default @NonNull PortFeatures requirePeerFeatures()
      Return peerFeatures, guaranteed to be non-null. 
           
         Features advertised by peer
      Returns:
      PortFeatures peerFeatures, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if peerFeatures is not present

    • getCurrentSpeed

      org.opendaylight.yangtools.yang.common.Uint32 getCurrentSpeed()
      Return currentSpeed, or null if it is not present. 
           
         Current port bit rate in kbps
      Returns:
      Uint32 currentSpeed, or null if it is not present.

    • requireCurrentSpeed

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireCurrentSpeed()
      Return currentSpeed, guaranteed to be non-null. 
           
         Current port bit rate in kbps
      Returns:
      Uint32 currentSpeed, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if currentSpeed is not present

    • getMaximumSpeed

      org.opendaylight.yangtools.yang.common.Uint32 getMaximumSpeed()
      Return maximumSpeed, or null if it is not present. 
           
         Max port bit rate in kbps
      Returns:
      Uint32 maximumSpeed, or null if it is not present.

    • requireMaximumSpeed

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireMaximumSpeed()
      Return maximumSpeed, guaranteed to be non-null. 
           
         Max port bit rate in kbps
      Returns:
      Uint32 maximumSpeed, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if maximumSpeed is not present