Interface PolicyDefinitions

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<PolicyDefinitions>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<RoutingPolicy>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

    @Generated("mdsal-binding-generator")
    public interface PolicyDefinitions
    extends org.opendaylight.yangtools.yang.binding.ChildOf<RoutingPolicy>, org.opendaylight.yangtools.yang.binding.Augmentable<PolicyDefinitions>
    Enclosing container for the list of top-level policy definitions

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

     container policy-definitions {
       list policy-definition {
         key name;
         leaf name {
           type string;
         }
         container statements {
           list statement {
             key name;
             ordered-by user;
             leaf name {
               type string;
             }
             container conditions {
               leaf call-policy {
                 type leafref {
                   path /rpol:routing-policy/rpol:policy-definitions/rpol:policy-definition/rpol:name;
                 }
               }
               uses generic-conditions;
               uses igp-conditions;
             }
             container actions {
               uses generic-actions;
               uses igp-actions;
             }
           }
         }
       }
     }
     
    The schema path to identify an instance is openconfig-routing-policyrouting-policy-toprouting-policypolicy-definitions

    To create instances of this class use PolicyDefinitionsBuilder.

    See Also:
    PolicyDefinitionsBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

        default Class<PolicyDefinitions> 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 PolicyDefinitions 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 PolicyDefinitions 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 PolicyDefinitions 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
      • getPolicyDefinition

        @Nullable Map<PolicyDefinitionKey,​PolicyDefinition> getPolicyDefinition()
        Return policyDefinition, or null if it is not present.
             
                 List of top-level policy definitions, keyed by unique name. These policy
                 definitions are expected to be referenced (by name) in policy chains specified
                 in import or export configuration statements.
             
         
        Returns:
        Map<PolicyDefinitionKey, PolicyDefinition> policyDefinition, or null if it is not present.
      • nonnullPolicyDefinition

        default @NonNull Map<PolicyDefinitionKey,​PolicyDefinition> nonnullPolicyDefinition()
        Return policyDefinition, or an empty list if it is not present.
        Returns:
        Map<PolicyDefinitionKey, PolicyDefinition> policyDefinition, or an empty list if it is not present.