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

Interface FlowCapablePort

  • All Superinterfaces:
    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, NodePort, PortRemoved, 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;
 }
    The schema path to identify an instance is opendaylight-port-types/flow-capable-port

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        Class<? extends FlowCapablePort> implementedInterface()
        Specified by:
        implementedInterface in interface CommonPort
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        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:
        java.lang.String name, or null if it is not present.

      • getState

        State getState()
        Return state, or null if it is not present. 
             
         Description of state of port
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.flow.capable.port.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:
        org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortFeatures currentFeature, or null if it is not present.

      • getSupported

        PortFeatures getSupported()
        Return supported, or null if it is not present. 
             
         Features supported by the port
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortFeatures supported, or null if it is not present.

      • getPeerFeatures

        PortFeatures getPeerFeatures()
        Return peerFeatures, or null if it is not present. 
             
         Features advertised by peer
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortFeatures peerFeatures, or null if it 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:
        org.opendaylight.yangtools.yang.common.Uint32 currentSpeed, or null if it 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:
        org.opendaylight.yangtools.yang.common.Uint32 maximumSpeed, or null if it is not present.