Interface ItmConfig

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

    @Generated("mdsal-binding-generator")
    public interface ItmConfig
    extends org.opendaylight.yangtools.yang.binding.ChildOf<ItmConfigData>, org.opendaylight.yangtools.yang.binding.Augmentable<ItmConfig>

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

     container itm-config {
       leaf def-tz-enabled {
         type boolean;
         default false;
       }
       leaf def-tz-tunnel-type {
         type string;
         default vxlan;
       }
       list tunnel-aggregation {
         key tunnel-type;
         leaf tunnel-type {
           type string;
         }
         leaf enabled {
           type boolean;
           default false;
         }
       }
       leaf default-tunnel-tos {
         type string {
           length 1..8;
         }
         default 0;
       }
       leaf gpe-extension-enabled {
         type boolean;
         default false;
       }
       leaf use-of-tunnels {
         type boolean;
         default false;
       }
       leaf vlan-id {
         type uint16 {
           range 0..4094;
         }
       }
       leaf portname {
         type string;
       }
       leaf batch-interval {
         type uint16;
       }
       leaf batch-size {
         type uint16;
       }
     }
     
    The schema path to identify an instance is itm-config/itm-config

    To create instances of this class use ItmConfigBuilder.

    See Also:
    ItmConfigBuilder
    • Field Summary

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

      • QNAME

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

      • implementedInterface

        default java.lang.Class<ItmConfig> 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 ItmConfig 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 ItmConfig 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 ItmConfig 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
      • getDefTzEnabled

        java.lang.Boolean getDefTzEnabled()
        Return defTzEnabled, or null if it is not present.
        Returns:
        java.lang.Boolean defTzEnabled, or null if it is not present.
      • isDefTzEnabled

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

        java.lang.String getDefTzTunnelType()
        Return defTzTunnelType, or null if it is not present.
        Returns:
        java.lang.String defTzTunnelType, or null if it is not present.
      • getTunnelAggregation

        @Nullable java.util.Map<TunnelAggregationKey,​TunnelAggregation> getTunnelAggregation()
        Return tunnelAggregation, or null if it is not present.
        Returns:
        java.util.Map tunnelAggregation, or null if it is not present.
      • nonnullTunnelAggregation

        default @NonNull java.util.Map<TunnelAggregationKey,​TunnelAggregation> nonnullTunnelAggregation()
        Return tunnelAggregation, or an empty list if it is not present.
        Returns:
        java.util.Map tunnelAggregation, or an empty list if it is not present.
      • getDefaultTunnelTos

        java.lang.String getDefaultTunnelTos()
        Return defaultTunnelTos, or null if it is not present.
             
                 Default value of ToS bits to be set on the encapsulating packet. The value of
                 'inherit' will copy the DSCP value from inner IPv4 or IPv6 packets. When ToS is
                 given as a numberic value, the least significant two bits will be ignored.
             
         
        Returns:
        java.lang.String defaultTunnelTos, or null if it is not present.
      • getGpeExtensionEnabled

        java.lang.Boolean getGpeExtensionEnabled()
        Return gpeExtensionEnabled, or null if it is not present.
             
                 Enable the GPE extension for VXLAN tunnel interfaces configured through ITM.
             
         
        Returns:
        java.lang.Boolean gpeExtensionEnabled, or null if it is not present.
      • isGpeExtensionEnabled

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

        java.lang.Boolean getUseOfTunnels()
        Return useOfTunnels, or null if it is not present.
             
                 Enable OF tunnels on ITM Direct Tunnel.
             
         
        Returns:
        java.lang.Boolean useOfTunnels, or null if it is not present.
      • isUseOfTunnels

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

        org.opendaylight.yangtools.yang.common.Uint16 getVlanId()
        Return vlanId, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 vlanId, or null if it is not present.
      • getPortname

        java.lang.String getPortname()
        Return portname, or null if it is not present.
        Returns:
        java.lang.String portname, or null if it is not present.
      • getBatchInterval

        org.opendaylight.yangtools.yang.common.Uint16 getBatchInterval()
        Return batchInterval, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 batchInterval, or null if it is not present.
      • getBatchSize

        org.opendaylight.yangtools.yang.common.Uint16 getBatchSize()
        Return batchSize, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 batchSize, or null if it is not present.