Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.id.to.vpn.instance

Interface VpnIds

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.Augmentable<VpnIds>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<VpnIdToVpnInstance>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<VpnIdsKey>

@Generated("mdsal-binding-generator")
public interface VpnIds
extends org.opendaylight.yangtools.yang.binding.ChildOf<VpnIdToVpnInstance>, org.opendaylight.yangtools.yang.binding.Augmentable<VpnIds>, org.opendaylight.yangtools.yang.binding.Identifiable<VpnIdsKey>

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

 list vpn-ids {
   key vpn-id;
   leaf vpn-id {
     type uint32;
   }
   leaf vpn-instance-name {
     type string;
   }
   leaf vrf-id {
     type string;
   }
   leaf external-vpn {
     type boolean;
   }
 }
 

The schema path to identify an instance is odl-l3vpn/vpn-id-to-vpn-instance/vpn-ids

To create instances of this class use VpnIdsBuilder.

See Also:

VpnIdsBuilder, VpnIdsKey

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static boolean	bindingEquals(@NonNull VpnIds thisObj, java.lang.Object obj)	Default implementation of Object.equals(Object) contract for this interface.
static int	bindingHashCode(@NonNull VpnIds obj)	Default implementation of Object.hashCode() contract for this interface.
static java.lang.String	bindingToString(@NonNull VpnIds obj)	Default implementation of Object.toString() contract for this interface.
java.lang.Boolean	getExternalVpn()	Return externalVpn, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint32	getVpnId()	Return vpnId, or null if it is not present.
java.lang.String	getVpnInstanceName()	Return vpnInstanceName, or null if it is not present.
java.lang.String	getVrfId()	Return vrfId, or null if it is not present.
default java.lang.Class<VpnIds>	implementedInterface()
default java.lang.Boolean	isExternalVpn()	Deprecated, for removal: This API element is subject to removal in a future version.
VpnIdsKey	key()

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation, augmentations

Field Detail

QNAME

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

Method Detail

implementedInterface

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

getVpnId

org.opendaylight.yangtools.yang.common.Uint32 getVpnId()

Return vpnId, or null if it is not present.

Returns:

org.opendaylight.yangtools.yang.common.Uint32 vpnId, 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.

getVrfId

java.lang.String getVrfId()

Return vrfId, or null if it is not present.

     
         The vrf-id command configures a route distinguisher (RD) for the IPv4 or IPv6
         address family of a VPN instance or vpn instance name for internal vpn case.
     
 

Returns:

java.lang.String vrfId, or null if it is not present.

getExternalVpn

java.lang.Boolean getExternalVpn()

Return externalVpn, or null if it is not present.

     
         The VPN is external?
     
 

Returns:

java.lang.Boolean externalVpn, or null if it is not present.

isExternalVpn

@Deprecated(forRemoval=true)
default java.lang.Boolean isExternalVpn()

Deprecated, for removal: This API element is subject to removal in a future version.

key

VpnIdsKey key()

Specified by:

key in interface org.opendaylight.yangtools.yang.binding.Identifiable<VpnIdsKey>