Interface TransportZone

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<TransportZone>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<TransportZones>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<TransportZoneKey>

    @Generated("mdsal-binding-generator")
    public interface TransportZone
    extends org.opendaylight.yangtools.yang.binding.ChildOf<TransportZones>, org.opendaylight.yangtools.yang.binding.Augmentable<TransportZone>, org.opendaylight.yangtools.yang.binding.Identifiable<TransportZoneKey>

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

     list transport-zone {
       ordered-by user;
       key zone-name;
       leaf zone-name {
         type string;
       }
       leaf tunnel-type {
         type identityref {
           base tunnel-type-base;
         }
       }
       list vteps {
         key dpn-id;
         leaf dpn-id {
           type uint64;
         }
         leaf ip-address {
           type inet:ip-address;
         }
         leaf option-of-tunnel {
           type boolean;
           default false;
         }
         leaf option-tunnel-tos {
           type string {
             length 1..8;
           }
         }
       }
       list device-vteps {
         key "node-id ip-address";
         leaf topology-id {
           type string;
         }
         leaf node-id {
           type string;
         }
         leaf ip-address {
           type inet:ip-address;
         }
       }
     }
     
    The schema path to identify an instance is itm/transport-zones/transport-zone

    To create instances of this class use TransportZoneBuilder.

    See Also:
    TransportZoneBuilder, TransportZoneKey
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<TransportZone> 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 TransportZone 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 TransportZone 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 TransportZone 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
      • getZoneName

        java.lang.String getZoneName()
        Return zoneName, or null if it is not present.
        Returns:
        java.lang.String zoneName, or null if it is not present.
      • getTunnelType

        java.lang.Class<? extends TunnelTypeBase> getTunnelType()
        Return tunnelType, or null if it is not present.
        Returns:
        java.lang.Class tunnelType, or null if it is not present.
      • getVteps

        @Nullable java.util.Map<VtepsKey,​Vteps> getVteps()
        Return vteps, or null if it is not present.
        Returns:
        java.util.Map vteps, or null if it is not present.
      • nonnullVteps

        default @NonNull java.util.Map<VtepsKey,​Vteps> nonnullVteps()
        Return vteps, or an empty list if it is not present.
        Returns:
        java.util.Map vteps, or an empty list if it is not present.
      • getDeviceVteps

        @Nullable java.util.Map<DeviceVtepsKey,​DeviceVteps> getDeviceVteps()
        Return deviceVteps, or null if it is not present.
        Returns:
        java.util.Map deviceVteps, or null if it is not present.
      • nonnullDeviceVteps

        default @NonNull java.util.Map<DeviceVtepsKey,​DeviceVteps> nonnullDeviceVteps()
        Return deviceVteps, or an empty list if it is not present.
        Returns:
        java.util.Map deviceVteps, or an empty list if it is not present.