Interface PortGrouping
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
- All Known Subinterfaces:
PhyPort
,Ports
,PortStatus
,PortStatusMessage
@Generated("mdsal-binding-generator")
public interface PortGrouping
extends org.opendaylight.yangtools.yang.binding.DataObject
This class represents the following YANG schema fragment defined in module openflow-protocol
grouping port-grouping { leaf port-no { type uint32; } leaf hw-addr { type yang:mac-address; } leaf name { type string; } leaf config { type oft:port-config; } leaf state { type oft:port-state; } leaf current-features { type oft:port-features; } leaf advertised-features { type oft:port-features; } leaf supported-features { type oft:port-features; } leaf peer-features { type oft:port-features; } leaf curr-speed { type uint32; units kbps; } leaf max-speed { type uint32; units kbps; } leaf config-v10 { type oft:port-config-v10; } leaf state-v10 { type oft:port-state-v10; } leaf current-features-v10 { type oft:port-features-v10; } leaf advertised-features-v10 { type oft:port-features-v10; } leaf supported-features-v10 { type oft:port-features-v10; } leaf peer-features-v10 { type oft:port-features-v10; } }
-
Field Summary
Modifier and TypeFieldDescriptionstatic final @NonNull org.opendaylight.yangtools.yang.common.QName
YANG identifier of the statement represented by this class. -
Method Summary
Modifier and TypeMethodDescriptionReturn advertisedFeatures, ornull
if it is not present.Return advertisedFeaturesV10, ornull
if it is not present.Return config, ornull
if it is not present.Return configV10, ornull
if it is not present.Return currentFeatures, ornull
if it is not present.Return currentFeaturesV10, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
Return currSpeed, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
Return hwAddr, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
Return maxSpeed, ornull
if it is not present.getName()
Return name, ornull
if it is not present.Return peerFeatures, ornull
if it is not present.Return peerFeaturesV10, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
Return portNo, ornull
if it is not present.getState()
Return state, ornull
if it is not present.Return stateV10, ornull
if it is not present.Return supportedFeatures, ornull
if it is not present.Return supportedFeaturesV10, ornull
if it is not present.Class<? extends PortGrouping>
default @NonNull PortFeatures
Return advertisedFeatures, guaranteed to be non-null.default @NonNull PortFeaturesV10
Return advertisedFeaturesV10, guaranteed to be non-null.default @NonNull PortConfig
Return config, guaranteed to be non-null.default @NonNull PortConfigV10
Return configV10, guaranteed to be non-null.default @NonNull PortFeatures
Return currentFeatures, guaranteed to be non-null.default @NonNull PortFeaturesV10
Return currentFeaturesV10, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint32
Return currSpeed, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
Return hwAddr, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint32
Return maxSpeed, guaranteed to be non-null.default @NonNull String
Return name, guaranteed to be non-null.default @NonNull PortFeatures
Return peerFeatures, guaranteed to be non-null.default @NonNull PortFeaturesV10
Return peerFeaturesV10, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint32
Return portNo, guaranteed to be non-null.default @NonNull PortState
Return state, guaranteed to be non-null.default @NonNull PortStateV10
Return stateV10, guaranteed to be non-null.default @NonNull PortFeatures
Return supportedFeatures, guaranteed to be non-null.default @NonNull PortFeaturesV10
Return supportedFeaturesV10, guaranteed to be non-null.
-
Field Details
-
QNAME
static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAMEYANG identifier of the statement represented by this class.
-
-
Method Details
-
implementedInterface
Class<? extends PortGrouping> implementedInterface()- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
getPortNo
org.opendaylight.yangtools.yang.common.Uint32 getPortNo()Return portNo, ornull
if it is not present.- Returns:
Uint32
portNo, ornull
if it is not present.
-
requirePortNo
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requirePortNo()Return portNo, guaranteed to be non-null.- Returns:
Uint32
portNo, guaranteed to be non-null.- Throws:
NoSuchElementException
- if portNo is not present
-
getHwAddr
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getHwAddr()Return hwAddr, ornull
if it is not present.- Returns:
MacAddress
hwAddr, ornull
if it is not present.
-
requireHwAddr
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress requireHwAddr()Return hwAddr, guaranteed to be non-null.- Returns:
MacAddress
hwAddr, guaranteed to be non-null.- Throws:
NoSuchElementException
- if hwAddr is not present
-
getName
String getName()Return name, ornull
if it is not present.- Returns:
String
name, ornull
if it is not present.
-
requireName
Return name, guaranteed to be non-null.- Returns:
String
name, guaranteed to be non-null.- Throws:
NoSuchElementException
- if name is not present
-
getConfig
PortConfig getConfig()Return config, ornull
if it is not present.Bitmap of OFPPC_* flags.
- Returns:
PortConfig
config, ornull
if it is not present.
-
requireConfig
Return config, guaranteed to be non-null.Bitmap of OFPPC_* flags.
- Returns:
PortConfig
config, guaranteed to be non-null.- Throws:
NoSuchElementException
- if config is not present
-
getState
PortState getState()Return state, ornull
if it is not present.Bitmap of OFPPS_* flags.
- Returns:
PortState
state, ornull
if it is not present.
-
requireState
Return state, guaranteed to be non-null.Bitmap of OFPPS_* flags.
- Returns:
PortState
state, guaranteed to be non-null.- Throws:
NoSuchElementException
- if state is not present
-
getCurrentFeatures
PortFeatures getCurrentFeatures()Return currentFeatures, ornull
if it is not present.Current features.
- Returns:
PortFeatures
currentFeatures, ornull
if it is not present.
-
requireCurrentFeatures
Return currentFeatures, guaranteed to be non-null.Current features.
- Returns:
PortFeatures
currentFeatures, guaranteed to be non-null.- Throws:
NoSuchElementException
- if currentFeatures is not present
-
getAdvertisedFeatures
PortFeatures getAdvertisedFeatures()Return advertisedFeatures, ornull
if it is not present.Features being advertised by the port.
- Returns:
PortFeatures
advertisedFeatures, ornull
if it is not present.
-
requireAdvertisedFeatures
Return advertisedFeatures, guaranteed to be non-null.Features being advertised by the port.
- Returns:
PortFeatures
advertisedFeatures, guaranteed to be non-null.- Throws:
NoSuchElementException
- if advertisedFeatures is not present
-
getSupportedFeatures
PortFeatures getSupportedFeatures()Return supportedFeatures, ornull
if it is not present.Features supported by the port.
- Returns:
PortFeatures
supportedFeatures, ornull
if it is not present.
-
requireSupportedFeatures
Return supportedFeatures, guaranteed to be non-null.Features supported by the port.
- Returns:
PortFeatures
supportedFeatures, guaranteed to be non-null.- Throws:
NoSuchElementException
- if supportedFeatures is not present
-
getPeerFeatures
PortFeatures getPeerFeatures()Return peerFeatures, ornull
if it is not present.Features advertised by peer.
- Returns:
PortFeatures
peerFeatures, ornull
if it is not present.
-
requirePeerFeatures
Return peerFeatures, guaranteed to be non-null.Features advertised by peer.
- Returns:
PortFeatures
peerFeatures, guaranteed to be non-null.- Throws:
NoSuchElementException
- if peerFeatures is not present
-
getCurrSpeed
org.opendaylight.yangtools.yang.common.Uint32 getCurrSpeed()Return currSpeed, ornull
if it is not present.Current port bitrate in kbps.
- Returns:
Uint32
currSpeed, ornull
if it is not present.
-
requireCurrSpeed
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireCurrSpeed()Return currSpeed, guaranteed to be non-null.Current port bitrate in kbps.
- Returns:
Uint32
currSpeed, guaranteed to be non-null.- Throws:
NoSuchElementException
- if currSpeed is not present
-
getMaxSpeed
org.opendaylight.yangtools.yang.common.Uint32 getMaxSpeed()Return maxSpeed, ornull
if it is not present.Max port bitrate in kbps
- Returns:
Uint32
maxSpeed, ornull
if it is not present.
-
requireMaxSpeed
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireMaxSpeed()Return maxSpeed, guaranteed to be non-null.Max port bitrate in kbps
- Returns:
Uint32
maxSpeed, guaranteed to be non-null.- Throws:
NoSuchElementException
- if maxSpeed is not present
-
getConfigV10
PortConfigV10 getConfigV10()Return configV10, ornull
if it is not present.- Returns:
PortConfigV10
configV10, ornull
if it is not present.
-
requireConfigV10
Return configV10, guaranteed to be non-null.- Returns:
PortConfigV10
configV10, guaranteed to be non-null.- Throws:
NoSuchElementException
- if configV10 is not present
-
getStateV10
PortStateV10 getStateV10()Return stateV10, ornull
if it is not present.- Returns:
PortStateV10
stateV10, ornull
if it is not present.
-
requireStateV10
Return stateV10, guaranteed to be non-null.- Returns:
PortStateV10
stateV10, guaranteed to be non-null.- Throws:
NoSuchElementException
- if stateV10 is not present
-
getCurrentFeaturesV10
PortFeaturesV10 getCurrentFeaturesV10()Return currentFeaturesV10, ornull
if it is not present.Current features.
- Returns:
PortFeaturesV10
currentFeaturesV10, ornull
if it is not present.
-
requireCurrentFeaturesV10
Return currentFeaturesV10, guaranteed to be non-null.Current features.
- Returns:
PortFeaturesV10
currentFeaturesV10, guaranteed to be non-null.- Throws:
NoSuchElementException
- if currentFeaturesV10 is not present
-
getAdvertisedFeaturesV10
PortFeaturesV10 getAdvertisedFeaturesV10()Return advertisedFeaturesV10, ornull
if it is not present.Features being advertised by the port.
- Returns:
PortFeaturesV10
advertisedFeaturesV10, ornull
if it is not present.
-
requireAdvertisedFeaturesV10
Return advertisedFeaturesV10, guaranteed to be non-null.Features being advertised by the port.
- Returns:
PortFeaturesV10
advertisedFeaturesV10, guaranteed to be non-null.- Throws:
NoSuchElementException
- if advertisedFeaturesV10 is not present
-
getSupportedFeaturesV10
PortFeaturesV10 getSupportedFeaturesV10()Return supportedFeaturesV10, ornull
if it is not present.Features supported by the port.
- Returns:
PortFeaturesV10
supportedFeaturesV10, ornull
if it is not present.
-
requireSupportedFeaturesV10
Return supportedFeaturesV10, guaranteed to be non-null.Features supported by the port.
- Returns:
PortFeaturesV10
supportedFeaturesV10, guaranteed to be non-null.- Throws:
NoSuchElementException
- if supportedFeaturesV10 is not present
-
getPeerFeaturesV10
PortFeaturesV10 getPeerFeaturesV10()Return peerFeaturesV10, ornull
if it is not present.Features advertised by peer.
- Returns:
PortFeaturesV10
peerFeaturesV10, ornull
if it is not present.
-
requirePeerFeaturesV10
Return peerFeaturesV10, guaranteed to be non-null.Features advertised by peer.
- Returns:
PortFeaturesV10
peerFeaturesV10, guaranteed to be non-null.- Throws:
NoSuchElementException
- if peerFeaturesV10 is not present
-