Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.policy.definitions.policy.definition.statements.statement.actions.bgp.actions

Interface SetCommunity

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<SetCommunity>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, 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 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;
   }
 }

To create instances of this class use SetCommunityBuilder.

See Also:

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

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

    • bindingHashCode

      static int bindingHashCode(@NonNull SetCommunity obj)
      Default implementation of Object.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 - if obj is null

    • bindingEquals

      static boolean bindingEquals(@NonNull SetCommunity thisObj, Object obj)
      Default implementation of Object.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 invocation
      obj - Object acting as argument to equals invocation
      Returns:
      True if thisObj and obj are considered equal
      Throws:
      NullPointerException - if thisObj is null

    • bindingToString

      static String bindingToString(@NonNull SetCommunity obj)
      Default implementation of Object.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 - if obj is null

    • getSetCommunityMethod

      SetCommunityMethod getSetCommunityMethod()
      Return setCommunityMethod, or null if it is not present. 
           
         Option to set communities using an inline list or reference to an existing
         defined set.
      Returns:
      SetCommunityMethod setCommunityMethod, or null if it is not present.

    • getOptions

      BgpSetCommunityOptionType getOptions()
      Return options, or null 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:
      BgpSetCommunityOptionType options, or null if it is not present.

    • requireOptions

      default @NonNull BgpSetCommunityOptionType requireOptions()
      Return options, guaranteed to be non-null. 
           
         Options for modifying the 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