Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.sfc.rev160511.sfc.attributes

Interface PortChains

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<PortChains>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<SfcAttributes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface PortChains
extends org.opendaylight.yangtools.yang.binding.ChildOf<SfcAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<PortChains>
    List of Service Function Paths (Port Chain) created by OpenStack SFC

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

     container port-chains {
   list port-chain {
     key uuid;
     uses attrs:base-attributes;
     uses port-chain-attributes;
   }
 }
    The schema path to identify an instance is neutron-sfc/sfc-attributes/port-chains

    To create instances of this class use PortChainsBuilder.

    See Also:
    PortChainsBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<PortChains> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull PortChains obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull PortChains thisObj,
                             Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull PortChains obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • getPortChain

        @Nullable Map<PortChainKey,​PortChain> getPortChain()
        Return portChain, or null if it is not present. 
             
         A Port Chain (Service Function Path) consists of (1) a set of Neutron ports, to
         define the sequence of service functions and (2)a set of flow classifiers, to
         specify the classified traffic flows to enter the chain. (1) is defined using
         the port pair groups. If a chain consists of a sequence of different types of
         Service Functions, then the chain will have multiple 'port-pair-group's. There
         must be at least one 'port-pair-group' in the Port Chain. Each port chain can be
         associated with multiple flow classifiers
        Returns:
        java.util.Map portChain, or null if it is not present.

      • nonnullPortChain

        default @NonNull Map<PortChainKey,​PortChain> nonnullPortChain()
        Return portChain, or an empty list if it is not present.
        Returns:
        java.util.Map portChain, or an empty list if it is not present.