Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.instances

Interface ElanInstance

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<ElanInstance>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<ElanInstances>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<ElanInstanceKey>
    @Generated("mdsal-binding-generator")
public interface ElanInstance
extends org.opendaylight.yangtools.yang.binding.ChildOf<ElanInstances>, org.opendaylight.yangtools.yang.binding.Augmentable<ElanInstance>, org.opendaylight.yangtools.yang.binding.Identifiable<ElanInstanceKey>
    Specifies the name of the elan instance. It is a string of 1 to 31 case-sensitive characters.

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

     list elan-instance {
   key elan-instance-name;
   leaf elan-instance-name {
     type string;
   }
   leaf elan-tag {
     type uint32;
   }
   leaf segment-type {
     type identityref {
       base segment-type-base;
     }
   }
   leaf segmentation-id {
     type uint32;
   }
   leaf physical-network-name {
     type string;
   }
   leaf external {
     type boolean;
     default false;
   }
   leaf mac-timeout {
     type uint32 {
       range 0..65535;
     }
   }
   leaf description {
     type string {
       length 1..254;
     }
   }
   list elan-segments {
     key segmentation-index;
     leaf segmentation-index {
       type uint32;
     }
     leaf physical-network-name {
       type string;
     }
     leaf segment-type {
       type identityref {
         base segment-type-base;
       }
     }
     leaf segmentation-id {
       type uint32;
     }
   }
   list external-teps {
     key tep-ip;
     leaf tep-ip {
       type inet:ip-address;
     }
     leaf nodeid {
       type string;
     }
   }
 }
    The schema path to identify an instance is elan/elan-instances/elan-instance

    To create instances of this class use ElanInstanceBuilder.

    See Also:
    ElanInstanceBuilder, ElanInstanceKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • getElanInstanceName

        java.lang.String getElanInstanceName()
        Return elanInstanceName, or null if it is not present. 
             
         The name of the elan-instance.
        Returns:
        java.lang.String elanInstanceName, or null if it is not present.

      • getElanTag

        org.opendaylight.yangtools.yang.common.Uint32 getElanTag()
        Return elanTag, or null if it is not present. 
             
         ELAN unique identifier which is unique across all the tenants. This will be
         created internally and if provided, the value will be discarded.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 elanTag, or null if it is not present.

      • getSegmentType

        java.lang.Class<? extends SegmentTypeBase> getSegmentType()
        Return segmentType, or null if it is not present. 
             
         Optional. Network segment type. It's mandatory when there are external devices
         participating in the ELAN
        Returns:
        java.lang.Class segmentType, or null if it is not present.

      • getSegmentationId

        org.opendaylight.yangtools.yang.common.Uint32 getSegmentationId()
        Return segmentationId, or null if it is not present. 
             
         Optional. Isolated segment on the physical network. For example, if segment-type
         is vlan, this ID is a vlan identifier. If segment-type is vxlan, this ID is a
         vni
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 segmentationId, or null if it is not present.

      • getPhysicalNetworkName

        java.lang.String getPhysicalNetworkName()
        Return physicalNetworkName, or null if it is not present. 
             
         Optional. The name of the physical network attached to the ELAN.
        Returns:
        java.lang.String physicalNetworkName, or null if it is not present.

      • getExternal

        java.lang.Boolean getExternal()
        Return external, or null if it is not present. 
             
         indicates whether this is an external network
        Returns:
        java.lang.Boolean external, or null if it is not present.

      • isExternal

        @Deprecated(forRemoval=true)
default java.lang.Boolean isExternal()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getMacTimeout

        org.opendaylight.yangtools.yang.common.Uint32 getMacTimeout()
        Return macTimeout, or null if it is not present. 
             
         MAC Table entry ageing time in seconds. A value of 0 will indicate that the MAC
         will never expire.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 macTimeout, or null if it is not present.

      • getDescription

        java.lang.String getDescription()
        Return description, or null if it is not present. 
             
         A textual description of elan instance, the elan instance description helps
         users memorize the elan instance.
        Returns:
        java.lang.String description, or null if it is not present.

      • getElanSegments

        @Nullable java.util.Map<ElanSegmentsKey,​ElanSegments> getElanSegments()
        Return elanSegments, or null if it is not present. 
             
         List of provider network(s) associated with this ELAN.
        Returns:
        java.util.Map elanSegments, or null if it is not present.

      • nonnullElanSegments

        default @NonNull java.util.Map<ElanSegmentsKey,​ElanSegments> nonnullElanSegments()
        Return elanSegments, or an empty list if it is not present.
        Returns:
        java.util.Map elanSegments, or an empty list if it is not present.

      • getExternalTeps

        @Nullable java.util.Map<ExternalTepsKey,​ExternalTeps> getExternalTeps()
        Return externalTeps, or null if it is not present. 
             
         Optional. The external tep ips of the nodes where this elan is present
        Returns:
        java.util.Map externalTeps, or null if it is not present.

      • nonnullExternalTeps

        default @NonNull java.util.Map<ExternalTepsKey,​ExternalTeps> nonnullExternalTeps()
        Return externalTeps, or an empty list if it is not present.
        Returns:
        java.util.Map externalTeps, or an empty list if it is not present.