Interface ProtocolsConfig
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator") public interface ProtocolsConfig extends org.opendaylight.yangtools.yang.binding.DataObject
Configuration parameters relating to a generic protocol instance within a network instanceThis class represents the following YANG schema fragment defined in module openconfig-network-instance
grouping protocols-config { leaf identifier { type identityref { base install-protocol-type; } } leaf name { type string; } leaf enabled { type boolean; } leaf target-table { type string; } }
The schema path to identify an instance is openconfig-network-instanceprotocols-config
-
-
Field Summary
Fields Modifier and Type Field Description static @NonNull org.opendaylight.yangtools.yang.common.QName
QNAME
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Boolean
getEnabled()
Return enabled, ornull
if it is not present.Class<? extends InstallProtocolType>
getIdentifier()
Return identifier, ornull
if it is not present.String
getName()
Return name, ornull
if it is not present.String
getTargetTable()
Return targetTable, ornull
if it is not present.Class<? extends ProtocolsConfig>
implementedInterface()
default @NonNull Boolean
requireEnabled()
Return enabled, guaranteed to be non-null.default @NonNull Class<? extends InstallProtocolType>
requireIdentifier()
Return identifier, guaranteed to be non-null.default @NonNull String
requireName()
Return name, guaranteed to be non-null.default @NonNull String
requireTargetTable()
Return targetTable, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
Class<? extends ProtocolsConfig> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
getIdentifier
Class<? extends InstallProtocolType> getIdentifier()
Return identifier, ornull
if it is not present.The protocol identifier for the instance
- Returns:
Class<? extends InstallProtocolType>
identifier, ornull
if it is not present.
-
requireIdentifier
default @NonNull Class<? extends InstallProtocolType> requireIdentifier()
Return identifier, guaranteed to be non-null.The protocol identifier for the instance
- Returns:
Class<? extends InstallProtocolType>
identifier, guaranteed to be non-null.- Throws:
NoSuchElementException
- if identifier is not present
-
getName
String getName()
Return name, ornull
if it is not present.A unique name for the protocol instance
- Returns:
String
name, ornull
if it is not present.
-
requireName
default @NonNull String requireName()
Return name, guaranteed to be non-null.A unique name for the protocol instance
- Returns:
String
name, guaranteed to be non-null.- Throws:
NoSuchElementException
- if name is not present
-
getEnabled
Boolean getEnabled()
Return enabled, ornull
if it is not present.A boolean value indicating whether the local protocol instance is enabled.
- Returns:
Boolean
enabled, ornull
if it is not present.
-
requireEnabled
default @NonNull Boolean requireEnabled()
Return enabled, guaranteed to be non-null.A boolean value indicating whether the local protocol instance is enabled.
- Returns:
Boolean
enabled, guaranteed to be non-null.- Throws:
NoSuchElementException
- if enabled is not present
-
getTargetTable
String getTargetTable()
Return targetTable, ornull
if it is not present.The table (RIB, FIB, or LFIB) that the protocol should populate its entries in.
- Returns:
String
targetTable, ornull
if it is not present.
-
requireTargetTable
default @NonNull String requireTargetTable()
Return targetTable, guaranteed to be non-null.The table (RIB, FIB, or LFIB) that the protocol should populate its entries in.
- Returns:
String
targetTable, guaranteed to be non-null.- Throws:
NoSuchElementException
- if targetTable is not present
-
-