Interface VpnInstances

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

    @Generated("mdsal-binding-generator")
    public interface VpnInstances
    extends org.opendaylight.yangtools.yang.binding.ChildOf<L3vpnInstancesInterfacesData>, org.opendaylight.yangtools.yang.binding.Augmentable<VpnInstances>

    This class represents the following YANG schema fragment defined in module l3vpn-instances-interfaces

     container vpn-instances {
       list vpn-instance {
         key vpn-instance-name;
         leaf vpn-instance-name {
           type string;
         }
         leaf-list route-distinguisher {
           type string {
             length 3..21;
           }
         }
         container vpnTargets {
           list vpnTarget {
             key vrfRTValue;
             leaf vrfRTValue {
               type string {
                 length 3..21;
               }
             }
             leaf vrfRTType {
               type enumeration {
                 enum export_extcommunity {
                   value 0;
                 }
                 enum import_extcommunity {
                   value 1;
                 }
                 enum both {
                   value 2;
                 }
               }
             }
           }
         }
         leaf l2vpn {
           type boolean;
           default false;
         }
         leaf bgpvpn-type {
           type enumeration {
             enum InternetBGPVPN {
               value 0;
             }
             enum BGPVPN {
               value 1;
             }
             enum InternalVPN {
               value 2;
             }
           }
           default BGPVPN;
         }
         leaf ip-address-family-configured {
           type enumeration {
             enum undefined {
               value 0;
             }
             enum ipv4 {
               value 4;
             }
             enum ipv6 {
               value 6;
             }
             enum ipv4-and-ipv6 {
               value 10;
             }
           }
           default undefined;
         }
         leaf l3vni {
           type uint32;
         }
       }
     }
     
    The schema path to identify an instance is l3vpn-instances-interfaces/vpn-instances

    To create instances of this class use VpnInstancesBuilder.

    See Also:
    VpnInstancesBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<VpnInstances> 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 VpnInstances 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:
        java.lang.NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull VpnInstances thisObj,
                                     java.lang.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:
        java.lang.NullPointerException - if thisObj is null
      • bindingToString

        static java.lang.String bindingToString​(@NonNull VpnInstances 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:
        java.lang.NullPointerException - if obj is null
      • getVpnInstance

        @Nullable java.util.Map<VpnInstanceKey,​VpnInstance> getVpnInstance()
        Return vpnInstance, or null if it is not present.
        Returns:
        java.util.Map vpnInstance, or null if it is not present.
      • nonnullVpnInstance

        default @NonNull java.util.Map<VpnInstanceKey,​VpnInstance> nonnullVpnInstance()
        Return vpnInstance, or an empty list if it is not present.
        Returns:
        java.util.Map vpnInstance, or an empty list if it is not present.