Interface StateTunnelList

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<StateTunnelList>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<TunnelsState>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<StateTunnelListKey>

    @Generated("mdsal-binding-generator")
    public interface StateTunnelList
    extends org.opendaylight.yangtools.yang.binding.ChildOf<TunnelsState>, org.opendaylight.yangtools.yang.binding.Augmentable<StateTunnelList>, org.opendaylight.yangtools.yang.binding.Identifiable<StateTunnelListKey>

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

     list state-tunnel-list {
       key tunnel-interface-name;
       leaf tunnel-interface-name {
         type string;
       }
       leaf tunnel-state {
         type boolean;
         config false;
         status deprecated;
       }
       leaf oper-state {
         type tunnel-oper-status;
       }
       container src-info {
         uses tep-info-attributes;
       }
       container dst-info {
         uses tep-info-attributes;
       }
       leaf transport-type {
         type identityref {
           base tunnel-type-base;
         }
       }
       leaf port-number {
         type string;
       }
       leaf if-index {
         type uint16;
       }
     }
     
    The schema path to identify an instance is itm-state/tunnels_state/state-tunnel-list

    To create instances of this class use StateTunnelListBuilder.

    See Also:
    StateTunnelListBuilder, StateTunnelListKey
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<StateTunnelList> 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 StateTunnelList 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 StateTunnelList 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 StateTunnelList 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
      • getTunnelInterfaceName

        java.lang.String getTunnelInterfaceName()
        Return tunnelInterfaceName, or null if it is not present.
        Returns:
        java.lang.String tunnelInterfaceName, or null if it is not present.
      • getTunnelState

        @Deprecated
        java.lang.Boolean getTunnelState()
        Deprecated.
        Return tunnelState, or null if it is not present.
        Returns:
        java.lang.Boolean tunnelState, or null if it is not present.
      • isTunnelState

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

        TunnelOperStatus getOperState()
        Return operState, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.TunnelOperStatus operState, or null if it is not present.
      • getSrcInfo

        SrcInfo getSrcInfo()
        Return srcInfo, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.state.tunnel.list.SrcInfo srcInfo, or null if it is not present.
      • getDstInfo

        DstInfo getDstInfo()
        Return dstInfo, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnels_state.state.tunnel.list.DstInfo dstInfo, or null if it is not present.
      • getTransportType

        java.lang.Class<? extends TunnelTypeBase> getTransportType()
        Return transportType, or null if it is not present.
        Returns:
        java.lang.Class transportType, or null if it is not present.
      • getPortNumber

        java.lang.String getPortNumber()
        Return portNumber, or null if it is not present.
        Returns:
        java.lang.String portNumber, or null if it is not present.
      • getIfIndex

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