Interface ChainParameters
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<ChainParameters>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<PortChainAttributes>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<ChainParametersKey>
@Generated("mdsal-binding-generator") public interface ChainParameters extends org.opendaylight.yangtools.yang.binding.ChildOf<PortChainAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<ChainParameters>, org.opendaylight.yangtools.yang.binding.Identifiable<ChainParametersKey>
List of additional parameters related to the SF chain. Current only one parameter 'correlation' is defined. The 'correlation' parameter is used to specify the type of chain correlation mechanism. This parameter allows correlation mechanism to be selected. This is currently set to 'mpls' as a default correlation mechanism because that's the only mechanism OpenStack SFC API's supports. If this parameter is not specified, it will default to 'mpls'This class represents the following YANG schema fragment defined in module neutron-sfc
list chain-parameters { key chain-parameter; leaf chain-parameter { type string; default correlation; } leaf chain-parameter-value { type string; default mpls; } }
The schema path to identify an instance is neutron-sfc/port-chain-attributes/chain-parametersTo create instances of this class use
ChainParametersBuilder
.- See Also:
ChainParametersBuilder
,ChainParametersKey
-
-
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 Modifier and Type Method Description static boolean
bindingEquals(@NonNull ChainParameters thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull ChainParameters obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull ChainParameters obj)
Default implementation ofObject.toString()
contract for this interface.String
getChainParameter()
Return chainParameter, ornull
if it is not present.String
getChainParameterValue()
Return chainParameterValue, ornull
if it is not present.default Class<ChainParameters>
implementedInterface()
ChainParametersKey
key()
default @NonNull String
requireChainParameter()
Return chainParameter, guaranteed to be non-null.default @NonNull String
requireChainParameterValue()
Return chainParameterValue, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
default Class<ChainParameters> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
bindingHashCode
static int bindingHashCode(@NonNull ChainParameters 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 ChainParameters 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 ChainParameters 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
-
key
ChainParametersKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<ChainParametersKey>
-
getChainParameter
String getChainParameter()
Return chainParameter, ornull
if it is not present.SF Chain parameter attribute name
- Returns:
String
chainParameter, ornull
if it is not present.
-
requireChainParameter
default @NonNull String requireChainParameter()
Return chainParameter, guaranteed to be non-null.SF Chain parameter attribute name
- Returns:
String
chainParameter, guaranteed to be non-null.- Throws:
NoSuchElementException
- if chainParameter is not present
-
getChainParameterValue
String getChainParameterValue()
Return chainParameterValue, ornull
if it is not present.SF Chain parameter's value
- Returns:
String
chainParameterValue, ornull
if it is not present.
-
requireChainParameterValue
default @NonNull String requireChainParameterValue()
Return chainParameterValue, guaranteed to be non-null.SF Chain parameter's value
- Returns:
String
chainParameterValue, guaranteed to be non-null.- Throws:
NoSuchElementException
- if chainParameterValue is not present
-
-