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

    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 modified

    This 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-community

    To create instances of this class use SetCommunityBuilder.

    See Also:
    SetCommunityBuilder
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • implementedInterface

        default Class<SetCommunity> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • getSetCommunityMethod

        @Nullable SetCommunityMethod getSetCommunityMethod()
        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, or null if not present
      • getOptions

        @Nullable BgpSetCommunityOptionType getOptions()
        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, or null if not present