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

Interface BgpActions

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<BgpActions>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Actions1>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface BgpActions
extends org.opendaylight.yangtools.yang.binding.ChildOf<Actions1>, org.opendaylight.yangtools.yang.binding.Augmentable<BgpActions>
    Definitions for policy action statements that change BGP-specific attributes of the route

    This class represents the following YANG schema fragment defined in module openconfig-bgp-policy 

     container bgp-actions {
   container set-as-path-prepend {
     presence
       "node is present in the config data to use the AS
        prepend action";
     leaf repeat-n {
       type uint8;
     }
   }
   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;
     }
   }
   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;
     }
   }
   leaf set-route-origin {
     type bgp-types:bgp-origin-attr-type;
   }
   leaf set-local-pref {
     type uint32;
   }
   leaf set-next-hop {
     type bgp-next-hop-type;
   }
   leaf set-med {
     type bgp-set-med-type;
   }
 }

    To create instances of this class use BgpActionsBuilder.

    See Also:
    BgpActionsBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • bindingHashCode

        static int bindingHashCode​(@NonNull BgpActions 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 BgpActions 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 BgpActions 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

      • getSetAsPathPrepend

        SetAsPathPrepend getSetAsPathPrepend()
        Return setAsPathPrepend, or null if it is not present. 
             
         action to prepend local AS number to the AS-path a specified number of times
        Returns:
        SetAsPathPrepend setAsPathPrepend, or null if it is not present.

      • getSetCommunity

        SetCommunity getSetCommunity()
        Return setCommunity, or null if it is not present. 
             
         action to set the community attributes of the route, along with options to
         modify how the community is modified
        Returns:
        SetCommunity setCommunity, or null if it is not present.

      • getSetExtCommunity

        SetExtCommunity getSetExtCommunity()
        Return setExtCommunity, or null if it is not present. 
             
         Action to set the extended community attributes of the route, along with options
         to modify how the community is modified
        Returns:
        SetExtCommunity setExtCommunity, or null if it is not present.

      • getSetRouteOrigin

        BgpOriginAttrType getSetRouteOrigin()
        Return setRouteOrigin, or null if it is not present. 
             
         set the origin attribute to the specified value
        Returns:
        BgpOriginAttrType setRouteOrigin, or null if it is not present.

      • requireSetRouteOrigin

        default @NonNull BgpOriginAttrType requireSetRouteOrigin()
        Return setRouteOrigin, guaranteed to be non-null. 
             
         set the origin attribute to the specified value
        Returns:
        BgpOriginAttrType setRouteOrigin, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if setRouteOrigin is not present

      • getSetLocalPref

        org.opendaylight.yangtools.yang.common.Uint32 getSetLocalPref()
        Return setLocalPref, or null if it is not present. 
             
         set the local pref attribute on the route update
        Returns:
        Uint32 setLocalPref, or null if it is not present.

      • requireSetLocalPref

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireSetLocalPref()
        Return setLocalPref, guaranteed to be non-null. 
             
         set the local pref attribute on the route update
        Returns:
        Uint32 setLocalPref, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if setLocalPref is not present

      • getSetNextHop

        BgpNextHopType getSetNextHop()
        Return setNextHop, or null if it is not present. 
             
         set the next-hop attribute in the route update
        Returns:
        BgpNextHopType setNextHop, or null if it is not present.

      • requireSetNextHop

        default @NonNull BgpNextHopType requireSetNextHop()
        Return setNextHop, guaranteed to be non-null. 
             
         set the next-hop attribute in the route update
        Returns:
        BgpNextHopType setNextHop, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if setNextHop is not present

      • getSetMed

        BgpSetMedType getSetMed()
        Return setMed, or null if it is not present. 
             
         set the med metric attribute in the route update
        Returns:
        BgpSetMedType setMed, or null if it is not present.

      • requireSetMed

        default @NonNull BgpSetMedType requireSetMed()
        Return setMed, guaranteed to be non-null. 
             
         set the med metric attribute in the route update
        Returns:
        BgpSetMedType setMed, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if setMed is not present