Interface SetExtCommunity
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<SetExtCommunity>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<BgpActions>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator") public interface SetExtCommunity extends org.opendaylight.yangtools.yang.binding.ChildOf<BgpActions>, org.opendaylight.yangtools.yang.binding.Augmentable<SetExtCommunity>
Action to set the extended community attributes of the route, along with to modify how the community is modifiedThis class represents the following YANG schema fragment defined in module openconfig-bgp-policy
container set-ext-community { presence "node is present in the config data when set-community action is used"; choice set-ext-community-method { case inline { list ext-community-member { uses bgp-t:extended-community; } } case reference { leaf ext-community-set-ref { type leafref { path /rpol:routing-policy/rpol:defined-sets/bgp-pol:bgp-defined-sets/bgp-pol:ext-community-sets/bgp-pol:ext-community-set/bgp-pol:ext-community-set-name; } } } } leaf options { type bgp-set-community-option-type; } }
The schema path to identify an instance is openconfig-bgp-policyrouting-policypolicy-definitionspolicy-definitionstatementsstatementactions(http://openconfig.net/yang/bgp-policy?revision=2015-10-09)bgp-actionsset-ext-communityTo create instances of this class use
SetExtCommunityBuilder
.- See Also:
SetExtCommunityBuilder
-
-
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 SetExtCommunity thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull SetExtCommunity obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull SetExtCommunity obj)
Default implementation ofObject.toString()
contract for this interface.BgpSetCommunityOptionType
getOptions()
Return options, ornull
if it is not present.SetExtCommunityMethod
getSetExtCommunityMethod()
Return setExtCommunityMethod, ornull
if it is not present.default Class<SetExtCommunity>
implementedInterface()
default @NonNull BgpSetCommunityOptionType
requireOptions()
Return options, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
default Class<SetExtCommunity> 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 SetExtCommunity 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 SetExtCommunity 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 SetExtCommunity 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
-
getSetExtCommunityMethod
SetExtCommunityMethod getSetExtCommunityMethod()
Return setExtCommunityMethod, ornull
if it is not present.Option to set communities using an inline list or reference to an existing defined set.
- Returns:
SetExtCommunityMethod
setExtCommunityMethod, ornull
if it is not present.
-
getOptions
BgpSetCommunityOptionType getOptions()
Return options, ornull
if it is not present.options for modifying the extended community attribute with the specified values. These options apply to both methods of setting the community attribute.
- Returns:
BgpSetCommunityOptionType
options, ornull
if it is not present.
-
requireOptions
default @NonNull BgpSetCommunityOptionType requireOptions()
Return options, guaranteed to be non-null.options for modifying the extended community attribute with the specified values. These options apply to both methods of setting the community attribute.
- Returns:
BgpSetCommunityOptionType
options, guaranteed to be non-null.- Throws:
NoSuchElementException
- if options is not present
-
-