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

Interface ServiceFunctionParameters

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<ServiceFunctionParameters>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PortPairAttributes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<ServiceFunctionParametersKey>
    @Generated("mdsal-binding-generator")
public interface ServiceFunctionParameters
extends org.opendaylight.yangtools.yang.binding.ChildOf<PortPairAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<ServiceFunctionParameters>, org.opendaylight.yangtools.yang.binding.Identifiable<ServiceFunctionParametersKey>
    Service Function specific parameters. These parameters are generally used to pass the SF specific parameter information to the data path. Currently SFC defined only one parameter - 'correlation'. The 'correlation' parameter is used to specify the type of chain correlation mechanism supported by a specific SF. This is needed by the data plane switch to determine how to associate a packet with a chain. Currently there is no default mechanism defined by OpenStack SFC API.

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

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

    To create instances of this class use ServiceFunctionParametersBuilder.

    See Also:
    ServiceFunctionParametersBuilder, ServiceFunctionParametersKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • getServiceFunctionParameter

        String getServiceFunctionParameter()
        Return serviceFunctionParameter, or null if it is not present. 
             
         Name of parameter defined for service function
        Returns:
        java.lang.String serviceFunctionParameter, or null if it is not present.

      • getServiceFunctionParameterValue

        String getServiceFunctionParameterValue()
        Return serviceFunctionParameterValue, or null if it is not present. 
             
         Value of the service function parameter
        Returns:
        java.lang.String serviceFunctionParameterValue, or null if it is not present.