Interface PortPairAttributes

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    PortPair

    @Generated("mdsal-binding-generator")
    public interface PortPairAttributes
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Grouping of port pair attributes

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

     grouping port-pair-attributes {
       leaf ingress {
         type yang:uuid;
       }
       leaf egress {
         type yang:uuid;
       }
       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
    • Field Detail

      • QNAME

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

      • implementedInterface

        Class<? extends PortPairAttributes> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • getIngress

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getIngress()
        Return ingress, or null if it is not present.
             
                 Ingress neutron port ID of the Service Function
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid ingress, or null if it is not present.
      • getEgress

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getEgress()
        Return egress, or null if it is not present.
             
                 Egress neutron port ID of the Service Function
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid egress, or null if it is not present.
      • getServiceFunctionParameters

        @Nullable Map<ServiceFunctionParametersKey,​ServiceFunctionParameters> getServiceFunctionParameters()
        Return serviceFunctionParameters, or null if it is not present.
             
                 Service Function specific parameters. These parameters are generally used to
                 pass the SF specific parameter information to the data path. Currently OpenStack
                 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.
             
         
        Returns:
        java.util.Map serviceFunctionParameters, or null if it is not present.
      • nonnullServiceFunctionParameters

        default @NonNull Map<ServiceFunctionParametersKey,​ServiceFunctionParameters> nonnullServiceFunctionParameters()
        Return serviceFunctionParameters, or an empty list if it is not present.
        Returns:
        java.util.Map serviceFunctionParameters, or an empty list if it is not present.