Interface Network
-
- All Superinterfaces:
AdminAttributes
,org.opendaylight.yangtools.yang.binding.Augmentable<Network>
,BaseAttributes
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<Networks>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,IdAttributes
,org.opendaylight.yangtools.yang.binding.Identifiable<NetworkKey>
@Generated("mdsal-binding-generator") public interface Network extends org.opendaylight.yangtools.yang.binding.ChildOf<Networks>, org.opendaylight.yangtools.yang.binding.Augmentable<Network>, BaseAttributes, AdminAttributes, org.opendaylight.yangtools.yang.binding.Identifiable<NetworkKey>
A network is a virtual isolated layer-2 broadcast domain which is typically reserved to the tenant who created it, unless the network has been explicitly configured to be shared. Tenants can create multiple networks, until they reach the thresholds specified by per-tenant Quotas. The network is the principal entity for the Neutron API. Ports and Subnets must always be associated with a network.This class represents the following YANG schema fragment defined in module neutron-networks
list network { key uuid; leaf shared { type boolean; default false; } leaf vlan-transparent { type boolean; default false; } uses attrs:base-attributes; uses attrs:admin-attributes; }
The schema path to identify an instance is neutron-networks/networks-attributes/networks/networkTo create instances of this class use
NetworkBuilder
.- See Also:
NetworkBuilder
,NetworkKey
-
-
Field Summary
Fields Modifier and Type Field Description static @NonNull org.opendaylight.yangtools.yang.common.QName
QNAME
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description static boolean
bindingEquals(@NonNull Network thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull Network obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull Network obj)
Default implementation ofObject.toString()
contract for this interface.Boolean
getShared()
Return shared, ornull
if it is not present.Boolean
getVlanTransparent()
Return vlanTransparent, ornull
if it is not present.default Class<Network>
implementedInterface()
default Boolean
isShared()
Deprecated, for removal: This API element is subject to removal in a future version.default Boolean
isVlanTransparent()
Deprecated, for removal: This API element is subject to removal in a future version.NetworkKey
key()
-
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.AdminAttributes
getAdminStateUp, getStatus, isAdminStateUp
-
Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable
augmentation, augmentations
-
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.BaseAttributes
getName
-
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
getProjectId, getRevisionNumber, getTenantId, getUuid
-
-
-
-
Method Detail
-
implementedInterface
default Class<Network> implementedInterface()
- Specified by:
implementedInterface
in interfaceAdminAttributes
- Specified by:
implementedInterface
in interfaceBaseAttributes
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
- Specified by:
implementedInterface
in interfaceIdAttributes
-
bindingHashCode
static int bindingHashCode(@NonNull Network obj)
Default implementation ofObject.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:
NullPointerException
- ifobj
is null
-
bindingEquals
static boolean bindingEquals(@NonNull Network thisObj, Object obj)
Default implementation ofObject.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 invocationobj
- Object acting as argument to equals invocation- Returns:
- True if thisObj and obj are considered equal
- Throws:
NullPointerException
- ifthisObj
is null
-
bindingToString
static String bindingToString(@NonNull Network obj)
Default implementation ofObject.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:
NullPointerException
- ifobj
is null
-
getShared
Boolean getShared()
Return shared, ornull
if it is not present.Indicates whether this network or subnet is shared across all tenants. By default, only administrative users can change this value.
- Returns:
java.lang.Boolean
shared, ornull
if it is not present.
-
isShared
@Deprecated(forRemoval=true) default Boolean isShared()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getVlanTransparent
Boolean getVlanTransparent()
Return vlanTransparent, ornull
if it is not present.The state of the network, which is VLAN transparent (true) or not VLAN transparent (false)
- Returns:
java.lang.Boolean
vlanTransparent, ornull
if it is not present.
-
isVlanTransparent
@Deprecated(forRemoval=true) default Boolean isVlanTransparent()
Deprecated, for removal: This API element is subject to removal in a future version.
-
key
NetworkKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<NetworkKey>
-
-