Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.vpnmaps

Interface VpnMap

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<VpnMap>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<VpnMaps>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<VpnMapKey>
    @Generated("mdsal-binding-generator")
public interface VpnMap
extends org.opendaylight.yangtools.yang.binding.ChildOf<VpnMaps>, org.opendaylight.yangtools.yang.binding.Augmentable<VpnMap>, org.opendaylight.yangtools.yang.binding.Identifiable<VpnMapKey>

    This class represents the following YANG schema fragment defined in module neutronvpn 

     list vpnMap {
   key vpn-id;
   leaf vpn-id {
     type yang:uuid;
   }
   leaf name {
     type string;
   }
   leaf tenant-id {
     type yang:uuid;
   }
   list router-ids {
     key router-id;
     leaf router-id {
       type yang:uuid;
     }
   }
   leaf-list network_ids {
     type yang:uuid;
   }
 }
    The schema path to identify an instance is neutronvpn/vpnMaps/vpnMap

    To create instances of this class use VpnMapBuilder.

    See Also:
    VpnMapBuilder, VpnMapKey

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      static boolean bindingEquals​(@NonNull VpnMap thisObj, java.lang.Object obj)
      Default implementation of Object.equals(Object) contract for this interface.
      static int bindingHashCode​(@NonNull VpnMap obj)
      Default implementation of Object.hashCode() contract for this interface.
      static java.lang.String bindingToString​(@NonNull VpnMap obj)
      Default implementation of Object.toString() contract for this interface.
      java.lang.String getName()
      Return name, or null if it is not present.
      @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getNetworkIds()
      Return networkIds, or null if it is not present.
      @Nullable java.util.Map<RouterIdsKey,​RouterIds> getRouterIds()
      Return routerIds, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()
      Return tenantId, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getVpnId()
      Return vpnId, or null if it is not present.
      default java.lang.Class<VpnMap> implementedInterface()  
      VpnMapKey key()  
      default @NonNull java.util.Map<RouterIdsKey,​RouterIds> nonnullRouterIds()
      Return routerIds, or an empty list if it is not present.

      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation, augmentations

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default java.lang.Class<VpnMap> 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 VpnMap 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 VpnMap 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 VpnMap 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

      • getVpnId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getVpnId()
        Return vpnId, or null if it is not present. 
             
         vpn-id
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid vpnId, or null if it is not present.

      • getName

        java.lang.String getName()
        Return name, or null if it is not present. 
             
         vpn name
        Returns:
        java.lang.String name, or null if it is not present.

      • getTenantId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()
        Return tenantId, or null if it is not present. 
             
         The UUID of the tenant that will own the subnet.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid tenantId, or null if it is not present.

      • getRouterIds

        @Nullable java.util.Map<RouterIdsKey,​RouterIds> getRouterIds()
        Return routerIds, or null if it is not present.
        Returns:
        java.util.Map routerIds, or null if it is not present.

      • nonnullRouterIds

        default @NonNull java.util.Map<RouterIdsKey,​RouterIds> nonnullRouterIds()
        Return routerIds, or an empty list if it is not present.
        Returns:
        java.util.Map routerIds, or an empty list if it is not present.

      • getNetworkIds

        @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getNetworkIds()
        Return networkIds, or null if it is not present. 
             
         UUID representing the network
        Returns:
        java.util.List networkIds, or null if it is not present.

      • key

        VpnMapKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<VpnMapKey>