Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.fwaas.rev150712

Interface FirewallRuleAttributes

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    FirewallRule
    @Generated("mdsal-binding-generator")
public interface FirewallRuleAttributes
extends org.opendaylight.yangtools.yang.binding.DataObject

    This class represents the following YANG schema fragment defined in module neutron-fwaas 

     grouping firewall-rule-attributes {
   leaf shared {
     type boolean;
   }
   leaf enabled {
     type boolean;
   }
   leaf firewall-policy-id {
     type yang:uuid;
   }
   leaf protocol {
     type union {
       type uint8;
       type identityref {
         base fw-protocol-base;
       }
     }
   }
   leaf ip-version {
     type identityref {
       base ip-version-base;
     }
   }
   leaf source-ip-addr {
     type types:ip-prefix-or-address;
   }
   leaf destination-ip-addr {
     type types:ip-prefix-or-address;
   }
   leaf source-port-range-min {
     type uint16;
   }
   leaf source-port-range-max {
     type uint16;
   }
   leaf destination-port-range-min {
     type uint16;
   }
   leaf destination-port-range-max {
     type uint16;
   }
   leaf position {
     type int16;
   }
   leaf action {
     type identityref {
       base action-base;
     }
   }
 }
    The schema path to identify an instance is neutron-fwaas/firewall-rule-attributes

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • getShared

        Boolean getShared()
        Return shared, or null if it is not present. 
             
         whether the firewall rule is shared or not
        Returns:
        Boolean shared, or null if it is not present.

      • requireShared

        default @NonNull Boolean requireShared()
        Return shared, guaranteed to be non-null. 
             
         whether the firewall rule is shared or not
        Returns:
        Boolean shared, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if shared is not present

      • getEnabled

        Boolean getEnabled()
        Return enabled, or null if it is not present. 
             
         whether the firewall rule is enabled or not
        Returns:
        Boolean enabled, or null if it is not present.

      • requireEnabled

        default @NonNull Boolean requireEnabled()
        Return enabled, guaranteed to be non-null. 
             
         whether the firewall rule is enabled or not
        Returns:
        Boolean enabled, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if enabled is not present

      • getFirewallPolicyId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getFirewallPolicyId()
        Return firewallPolicyId, or null if it is not present. 
             
         the firewall policy UUID for this firewall rule
        Returns:
        Uuid firewallPolicyId, or null if it is not present.

      • requireFirewallPolicyId

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireFirewallPolicyId()
        Return firewallPolicyId, guaranteed to be non-null. 
             
         the firewall policy UUID for this firewall rule
        Returns:
        Uuid firewallPolicyId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if firewallPolicyId is not present

      • getProtocol

        FirewallRuleAttributes.Protocol getProtocol()
        Return protocol, or null if it is not present. 
             
         the protocol this rule applies to
        Returns:
        Protocol protocol, or null if it is not present.

      • requireProtocol

        default @NonNull FirewallRuleAttributes.Protocol requireProtocol()
        Return protocol, guaranteed to be non-null. 
             
         the protocol this rule applies to
        Returns:
        Protocol protocol, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if protocol is not present

      • getIpVersion

        Class<? extends IpVersionBase> getIpVersion()
        Return ipVersion, or null if it is not present. 
             
         the ip version this rule applies to
        Returns:
        Class<? extends IpVersionBase> ipVersion, or null if it is not present.

      • requireIpVersion

        default @NonNull Class<? extends IpVersionBase> requireIpVersion()
        Return ipVersion, guaranteed to be non-null. 
             
         the ip version this rule applies to
        Returns:
        Class<? extends IpVersionBase> ipVersion, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if ipVersion is not present

      • getSourceIpAddr

        IpPrefixOrAddress getSourceIpAddr()
        Return sourceIpAddr, or null if it is not present. 
             
         the source ip address for this rule
        Returns:
        IpPrefixOrAddress sourceIpAddr, or null if it is not present.

      • requireSourceIpAddr

        default @NonNull IpPrefixOrAddress requireSourceIpAddr()
        Return sourceIpAddr, guaranteed to be non-null. 
             
         the source ip address for this rule
        Returns:
        IpPrefixOrAddress sourceIpAddr, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if sourceIpAddr is not present

      • getDestinationIpAddr

        IpPrefixOrAddress getDestinationIpAddr()
        Return destinationIpAddr, or null if it is not present. 
             
         the destination ip address for this rule
        Returns:
        IpPrefixOrAddress destinationIpAddr, or null if it is not present.

      • requireDestinationIpAddr

        default @NonNull IpPrefixOrAddress requireDestinationIpAddr()
        Return destinationIpAddr, guaranteed to be non-null. 
             
         the destination ip address for this rule
        Returns:
        IpPrefixOrAddress destinationIpAddr, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if destinationIpAddr is not present

      • getSourcePortRangeMin

        org.opendaylight.yangtools.yang.common.Uint16 getSourcePortRangeMin()
        Return sourcePortRangeMin, or null if it is not present. 
             
         the source port range min for this rule
        Returns:
        Uint16 sourcePortRangeMin, or null if it is not present.

      • requireSourcePortRangeMin

        default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireSourcePortRangeMin()
        Return sourcePortRangeMin, guaranteed to be non-null. 
             
         the source port range min for this rule
        Returns:
        Uint16 sourcePortRangeMin, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if sourcePortRangeMin is not present

      • getSourcePortRangeMax

        org.opendaylight.yangtools.yang.common.Uint16 getSourcePortRangeMax()
        Return sourcePortRangeMax, or null if it is not present. 
             
         the source port range max for this rule
        Returns:
        Uint16 sourcePortRangeMax, or null if it is not present.

      • requireSourcePortRangeMax

        default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireSourcePortRangeMax()
        Return sourcePortRangeMax, guaranteed to be non-null. 
             
         the source port range max for this rule
        Returns:
        Uint16 sourcePortRangeMax, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if sourcePortRangeMax is not present

      • getDestinationPortRangeMin

        org.opendaylight.yangtools.yang.common.Uint16 getDestinationPortRangeMin()
        Return destinationPortRangeMin, or null if it is not present. 
             
         the destination port range min for this rule
        Returns:
        Uint16 destinationPortRangeMin, or null if it is not present.

      • requireDestinationPortRangeMin

        default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireDestinationPortRangeMin()
        Return destinationPortRangeMin, guaranteed to be non-null. 
             
         the destination port range min for this rule
        Returns:
        Uint16 destinationPortRangeMin, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if destinationPortRangeMin is not present

      • getDestinationPortRangeMax

        org.opendaylight.yangtools.yang.common.Uint16 getDestinationPortRangeMax()
        Return destinationPortRangeMax, or null if it is not present. 
             
         the destination port range max for this rule
        Returns:
        Uint16 destinationPortRangeMax, or null if it is not present.

      • requireDestinationPortRangeMax

        default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireDestinationPortRangeMax()
        Return destinationPortRangeMax, guaranteed to be non-null. 
             
         the destination port range max for this rule
        Returns:
        Uint16 destinationPortRangeMax, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if destinationPortRangeMax is not present

      • getPosition

        Short getPosition()
        Return position, or null if it is not present. 
             
         the priority position this rule occupies
        Returns:
        Short position, or null if it is not present.

      • requirePosition

        default @NonNull Short requirePosition()
        Return position, guaranteed to be non-null. 
             
         the priority position this rule occupies
        Returns:
        Short position, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if position is not present

      • getAction

        Class<? extends ActionBase> getAction()
        Return action, or null if it is not present. 
             
         the action fot this rule
        Returns:
        Class<? extends ActionBase> action, or null if it is not present.

      • requireAction

        default @NonNull Class<? extends ActionBase> requireAction()
        Return action, guaranteed to be non-null. 
             
         the action fot this rule
        Returns:
        Class<? extends ActionBase> action, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if action is not present