Interface ElanInstances

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

    @Generated("mdsal-binding-generator")
    public interface ElanInstances
    extends org.opendaylight.yangtools.yang.binding.ChildOf<ElanData>, org.opendaylight.yangtools.yang.binding.Augmentable<ElanInstances>
    elan instances configuration parameters. Elan instances support both the VLAN and VNI based elans.

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

     container elan-instances {
       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

    To create instances of this class use ElanInstancesBuilder.

    See Also:
    ElanInstancesBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<ElanInstances> 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 ElanInstances 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 ElanInstances 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 ElanInstances 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
      • getElanInstance

        @Nullable java.util.Map<ElanInstanceKey,​ElanInstance> getElanInstance()
        Return elanInstance, or null if it is not present.
             
                 Specifies the name of the elan instance. It is a string of 1 to 31
                 case-sensitive characters.
             
         
        Returns:
        java.util.Map elanInstance, or null if it is not present.
      • nonnullElanInstance

        default @NonNull java.util.Map<ElanInstanceKey,​ElanInstance> nonnullElanInstance()
        Return elanInstance, or an empty list if it is not present.
        Returns:
        java.util.Map elanInstance, or an empty list if it is not present.