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

Interface ChainParameters

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<ChainParameters>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PortChainAttributes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<ChainParametersKey>
    @Generated("mdsal-binding-generator")
public interface ChainParameters
extends org.opendaylight.yangtools.yang.binding.ChildOf<PortChainAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<ChainParameters>, org.opendaylight.yangtools.yang.binding.Identifiable<ChainParametersKey>
    List of additional parameters related to the SF chain. Current only one parameter 'correlation' is defined. The 'correlation' parameter is used to specify the type of chain correlation mechanism. This parameter allows correlation mechanism to be selected. This is currently set to 'mpls' as a default correlation mechanism because that's the only mechanism OpenStack SFC API's supports. If this parameter is not specified, it will default to 'mpls'

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

     list chain-parameters {
   key chain-parameter;
   leaf chain-parameter {
     type string;
     default correlation;
   }
   leaf chain-parameter-value {
     type string;
     default mpls;
   }
 }
    The schema path to identify an instance is neutron-sfc/port-chain-attributes/chain-parameters

    To create instances of this class use ChainParametersBuilder.

    See Also:
    ChainParametersBuilder, ChainParametersKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<ChainParameters> 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 ChainParameters 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 ChainParameters 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 ChainParameters 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

      • getChainParameter

        String getChainParameter()
        Return chainParameter, or null if it is not present. 
             
         SF Chain parameter attribute name
        Returns:
        String chainParameter, or null if it is not present.

      • requireChainParameter

        default @NonNull String requireChainParameter()
        Return chainParameter, guaranteed to be non-null. 
             
         SF Chain parameter attribute name
        Returns:
        String chainParameter, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if chainParameter is not present

      • getChainParameterValue

        String getChainParameterValue()
        Return chainParameterValue, or null if it is not present. 
             
         SF Chain parameter's value
        Returns:
        String chainParameterValue, or null if it is not present.

      • requireChainParameterValue

        default @NonNull String requireChainParameterValue()
        Return chainParameterValue, guaranteed to be non-null. 
             
         SF Chain parameter's value
        Returns:
        String chainParameterValue, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if chainParameterValue is not present