Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data

Interface VpnInterfaceOpDataEntry

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<VpnInterfaceOpDataEntry>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<VpnInterfaceOpData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<VpnInterfaceOpDataEntryKey>
    @Generated("mdsal-binding-generator")
public interface VpnInterfaceOpDataEntry
extends org.opendaylight.yangtools.yang.binding.ChildOf<VpnInterfaceOpData>, org.opendaylight.yangtools.yang.binding.Augmentable<VpnInterfaceOpDataEntry>, org.opendaylight.yangtools.yang.binding.Identifiable<VpnInterfaceOpDataEntryKey>

    This class represents the following YANG schema fragment defined in module odl-l3vpn 

     list vpn-interface-op-data-entry {
   key "name vpn-instance-name";
   leaf name {
     type string;
   }
   leaf vpn-instance-name {
     type string {
       length 1..40;
     }
   }
   leaf dpn-id {
     type uint64;
   }
   leaf router-interface {
     type boolean;
   }
   leaf gateway-mac-address {
     type string;
   }
   leaf gateway-ip-address {
     type string;
   }
   leaf lport-tag {
     type uint32;
   }
   leaf vpn-interface-state {
     type enumeration {
       enum active {
         value 0;
       }
       enum inactive {
         value 1;
       }
     }
     default active;
   }
 }
    The schema path to identify an instance is odl-l3vpn/vpn-interface-op-data/vpn-interface-op-data-entry

    To create instances of this class use VpnInterfaceOpDataEntryBuilder.

    See Also:
    VpnInterfaceOpDataEntryBuilder, VpnInterfaceOpDataEntryKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • getName

        java.lang.String getName()
        Return name, or null if it is not present.
        Returns:
        java.lang.String name, or null if it is not present.

      • getVpnInstanceName

        java.lang.String getVpnInstanceName()
        Return vpnInstanceName, or null if it is not present.
        Returns:
        java.lang.String vpnInstanceName, or null if it is not present.

      • getDpnId

        org.opendaylight.yangtools.yang.common.Uint64 getDpnId()
        Return dpnId, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint64 dpnId, or null if it is not present.

      • getRouterInterface

        java.lang.Boolean getRouterInterface()
        Return routerInterface, or null if it is not present.
        Returns:
        java.lang.Boolean routerInterface, or null if it is not present.

      • isRouterInterface

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

      • getGatewayMacAddress

        java.lang.String getGatewayMacAddress()
        Return gatewayMacAddress, or null if it is not present.
        Returns:
        java.lang.String gatewayMacAddress, or null if it is not present.

      • getGatewayIpAddress

        java.lang.String getGatewayIpAddress()
        Return gatewayIpAddress, or null if it is not present.
        Returns:
        java.lang.String gatewayIpAddress, or null if it is not present.

      • getLportTag

        org.opendaylight.yangtools.yang.common.Uint32 getLportTag()
        Return lportTag, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 lportTag, or null if it is not present.

      • getVpnInterfaceState

        VpnInterfaceOpDataEntry.VpnInterfaceState getVpnInterfaceState()
        Return vpnInterfaceState, or null if it is not present. 
             
         This flag indicates the state of this interface in the VPN identified by
         vpn-name. ACTIVE state indicates that this vpn-interface is currently associated
         to vpn-name available as one of the keys. INACTIVE state indicates that this
         vpn-interface has already been dis-associated from vpn-name available as one of
         the keys.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn._interface.op.data.VpnInterfaceOpDataEntry.VpnInterfaceState vpnInterfaceState, or null if it is not present.