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:
        java.lang.Boolean shared, or null if it is not present.
      • isShared

        @Deprecated(forRemoval=true)
        default Boolean isShared()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getEnabled

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

        @Deprecated(forRemoval=true)
        default Boolean isEnabled()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • 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:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid firewallPolicyId, or null if it is not present.
      • getProtocol

        FirewallRuleAttributes.Protocol getProtocol()
        Return protocol, or null if it is not present.
             
                 the protocol this rule applies to
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.fwaas.rev150712.FirewallRuleAttributes.Protocol protocol, or null if it 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:
        java.lang.Class ipVersion, or null if it is not present.
      • getSourceIpAddr

        IpPrefixOrAddress getSourceIpAddr()
        Return sourceIpAddr, or null if it is not present.
             
                 the source ip address for this rule
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress sourceIpAddr, or null if it is not present.
      • getDestinationIpAddr

        IpPrefixOrAddress getDestinationIpAddr()
        Return destinationIpAddr, or null if it is not present.
             
                 the destination ip address for this rule
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.types.rev160517.IpPrefixOrAddress destinationIpAddr, or null if it 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:
        org.opendaylight.yangtools.yang.common.Uint16 sourcePortRangeMin, or null if it 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:
        org.opendaylight.yangtools.yang.common.Uint16 sourcePortRangeMax, or null if it 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:
        org.opendaylight.yangtools.yang.common.Uint16 destinationPortRangeMin, or null if it 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:
        org.opendaylight.yangtools.yang.common.Uint16 destinationPortRangeMax, or null if it is not present.
      • getPosition

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

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