Interface PmsiTunnel

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<PmsiTunnel>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PmsiTunnel>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

    @Generated("mdsal-binding-generator")
    public interface PmsiTunnel
    extends org.opendaylight.yangtools.yang.binding.ChildOf<PmsiTunnel>, org.opendaylight.yangtools.yang.binding.Augmentable<PmsiTunnel>
    P-Multicast Service Interface Tunnel (PMSI Tunnel) attribute

    This class represents the following YANG schema fragment defined in module pmsi-tunnel

     container pmsi-tunnel {
       presence "PMSI Attribute";
       leaf leaf-information-required {
         type boolean;
       }
       leaf mpls-label {
         type netc:mpls-label;
       }
       choice tunnel-identifier {
         case rsvp-te-p2mp-lsp {
           container rsvp-te-p2mp-lsp {
             leaf p2mp-id {
               type uint32;
             }
             leaf tunnel-id {
               type uint16;
             }
             leaf extended-tunnel-id {
               type inet:ip-address-no-zone;
             }
           }
         }
         case mldp-p2mp-lsp {
           container mldp-p2mp-lsp {
             leaf address-family {
               type identityref {
                 base address-family;
               }
             }
             leaf root-node-address {
               type inet:ip-address-no-zone;
             }
             list opaque-value {
               uses opaque;
             }
           }
         }
         case pim-ssm-tree {
           container pim-ssm-tree {
             uses p-address-p-multicast-group;
           }
         }
         case pim-sm-tree {
           container pim-sm-tree {
             uses p-address-p-multicast-group;
           }
         }
         case bidir-pim-tree {
           container bidir-pim-tree {
             uses p-address-p-multicast-group;
           }
         }
         case ingress-replication {
           container ingress-replication {
             leaf receiving-endpoint-address {
               type inet:ip-address-no-zone;
             }
           }
         }
         case mldp-mp2mp-lsp {
           container mldp-mp2mp-lsp {
             uses opaque;
           }
         }
       }
     }
     

    To create instances of this class use PmsiTunnelBuilder.

    See Also:
    PmsiTunnelBuilder
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.
    • Method Detail

      • implementedInterface

        default Class<PmsiTunnel> 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 PmsiTunnel 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 PmsiTunnel 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 PmsiTunnel 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
      • getLeafInformationRequired

        Boolean getLeafInformationRequired()
        Return leafInformationRequired, or null if it is not present.
        Returns:
        Boolean leafInformationRequired, or null if it is not present.
      • requireLeafInformationRequired

        default @NonNull Boolean requireLeafInformationRequired()
        Return leafInformationRequired, guaranteed to be non-null.
        Returns:
        Boolean leafInformationRequired, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if leafInformationRequired is not present
      • getMplsLabel

        MplsLabel getMplsLabel()
        Return mplsLabel, or null if it is not present.
        Returns:
        MplsLabel mplsLabel, or null if it is not present.
      • requireMplsLabel

        default @NonNull MplsLabel requireMplsLabel()
        Return mplsLabel, guaranteed to be non-null.
        Returns:
        MplsLabel mplsLabel, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if mplsLabel is not present
      • getTunnelIdentifier

        TunnelIdentifier getTunnelIdentifier()
        Return tunnelIdentifier, or null if it is not present.
        Returns:
        TunnelIdentifier tunnelIdentifier, or null if it is not present.