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

Interface ElanSegments

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<ElanSegments>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<ElanInstance>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<ElanSegmentsKey>
    @Generated("mdsal-binding-generator")
public interface ElanSegments
extends org.opendaylight.yangtools.yang.binding.ChildOf<ElanInstance>, org.opendaylight.yangtools.yang.binding.Augmentable<ElanSegments>, org.opendaylight.yangtools.yang.binding.Identifiable<ElanSegmentsKey>
    List of provider network(s) associated with this ELAN.

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

     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;
   }
 }
    The schema path to identify an instance is elan/elan-instances/elan-instance/elan-segments

    To create instances of this class use ElanSegmentsBuilder.

    See Also:
    ElanSegmentsBuilder, ElanSegmentsKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • getSegmentationIndex

        org.opendaylight.yangtools.yang.common.Uint32 getSegmentationIndex()
        Return segmentationIndex, or null if it is not present. 
             
         A hidden counter to act as a key, because segmentation id is not required.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 segmentationIndex, 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.

      • 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.