Interface ApplyPolicyConfig

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    Config, State

    @Generated("mdsal-binding-generator")
    public interface ApplyPolicyConfig
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Configuration data for routing policies

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

     grouping apply-policy-config {
       leaf-list import-policy {
         type leafref {
           path /rpol:routing-policy/rpol:policy-definitions/rpol:policy-definition/rpol:name;
         }
         ordered-by user;
       }
       leaf default-import-policy {
         type default-policy-type;
         default REJECT-ROUTE;
       }
       leaf-list export-policy {
         type leafref {
           path /rpol:routing-policy/rpol:policy-definitions/rpol:policy-definition/rpol:name;
         }
         ordered-by user;
       }
       leaf default-export-policy {
         type default-policy-type;
         default REJECT-ROUTE;
       }
     }
     
    The schema path to identify an instance is openconfig-routing-policyapply-policy-config
    • Field Detail

      • QNAME

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

      • implementedInterface

        Class<? extends ApplyPolicyConfig> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • getImportPolicy

        @Nullable List<String> getImportPolicy()
        Return importPolicy, or null if it is not present.
             
                 list of policy names in sequence to be applied on receiving a routing update in
                 the current context, e.g., for the current peer group, neighbor, address family,
                 etc.
             
         
        Returns:
        List<String> importPolicy, or null if it is not present.
      • requireImportPolicy

        default @NonNull List<String> requireImportPolicy()
        Return importPolicy, guaranteed to be non-null.
             
                 list of policy names in sequence to be applied on receiving a routing update in
                 the current context, e.g., for the current peer group, neighbor, address family,
                 etc.
             
         
        Returns:
        List<String> importPolicy, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if importPolicy is not present
      • getDefaultImportPolicy

        DefaultPolicyType getDefaultImportPolicy()
        Return defaultImportPolicy, or null if it is not present.
             
                 explicitly set a default policy if no policy definition in the import policy
                 chain is satisfied.
             
         
        Returns:
        DefaultPolicyType defaultImportPolicy, or null if it is not present.
      • requireDefaultImportPolicy

        default @NonNull DefaultPolicyType requireDefaultImportPolicy()
        Return defaultImportPolicy, guaranteed to be non-null.
             
                 explicitly set a default policy if no policy definition in the import policy
                 chain is satisfied.
             
         
        Returns:
        DefaultPolicyType defaultImportPolicy, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if defaultImportPolicy is not present
      • getExportPolicy

        @Nullable List<String> getExportPolicy()
        Return exportPolicy, or null if it is not present.
             
                 list of policy names in sequence to be applied on sending a routing update in
                 the current context, e.g., for the current peer group, neighbor, address family,
                 etc.
             
         
        Returns:
        List<String> exportPolicy, or null if it is not present.
      • requireExportPolicy

        default @NonNull List<String> requireExportPolicy()
        Return exportPolicy, guaranteed to be non-null.
             
                 list of policy names in sequence to be applied on sending a routing update in
                 the current context, e.g., for the current peer group, neighbor, address family,
                 etc.
             
         
        Returns:
        List<String> exportPolicy, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if exportPolicy is not present
      • getDefaultExportPolicy

        DefaultPolicyType getDefaultExportPolicy()
        Return defaultExportPolicy, or null if it is not present.
             
                 explicitly set a default policy if no policy definition in the export policy
                 chain is satisfied.
             
         
        Returns:
        DefaultPolicyType defaultExportPolicy, or null if it is not present.
      • requireDefaultExportPolicy

        default @NonNull DefaultPolicyType requireDefaultExportPolicy()
        Return defaultExportPolicy, guaranteed to be non-null.
             
                 explicitly set a default policy if no policy definition in the export policy
                 chain is satisfied.
             
         
        Returns:
        DefaultPolicyType defaultExportPolicy, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if defaultExportPolicy is not present