Interface SetCommunity
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<SetCommunity>
,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 SetCommunity extends org.opendaylight.yangtools.yang.binding.ChildOf<BgpActions>, org.opendaylight.yangtools.yang.binding.Augmentable<SetCommunity>
action to set the community attributes of the route, along with options to modify how the community is modifiedThis class represents the following YANG schema fragment defined in module openconfig-bgp-policy
container set-community { presence "node is present in the config data when set-community action is used"; choice set-community-method { case inline { list communities { uses bgp-t:community; } } case reference { leaf community-set-ref { type leafref { path /rpol:routing-policy/rpol:defined-sets/bgp-pol:bgp-defined-sets/bgp-pol:community-sets/bgp-pol:community-set/bgp-pol:community-set-name; } } } } leaf options { type bgp-set-community-option-type; } }
The schema path to identify an instance is openconfig-bgp-policy/routing-policy/policy-definitions/policy-definition/statements/statement/actions/(http://openconfig.net/yang/bgp-policy?revision=2015-10-09)bgp-actions/set-communityTo create instances of this class use
SetCommunityBuilder
.- See Also:
SetCommunityBuilder
-
-
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 SetCommunity thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull SetCommunity obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull SetCommunity obj)
Default implementation ofObject.toString()
contract for this interface.BgpSetCommunityOptionType
getOptions()
Return options, ornull
if it is not present.SetCommunityMethod
getSetCommunityMethod()
Return setCommunityMethod, ornull
if it is not present.default Class<SetCommunity>
implementedInterface()
-
-
-
Method Detail
-
implementedInterface
default Class<SetCommunity> 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 SetCommunity 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 SetCommunity 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 SetCommunity 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
-
getSetCommunityMethod
SetCommunityMethod getSetCommunityMethod()
Return setCommunityMethod, ornull
if it is not present.Option to set communities using an inline list or reference to an existing defined set.
- Returns:
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.policy.definitions.policy.definition.statements.statement.actions.bgp.actions.set.community.SetCommunityMethod
setCommunityMethod, ornull
if it is not present.
-
getOptions
BgpSetCommunityOptionType getOptions()
Return options, ornull
if it is not present.Options for modifying the community attribute with the specified values. These options apply to both methods of setting the community attribute.
- Returns:
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.BgpSetCommunityOptionType
options, ornull
if it is not present.
-
-