com.softlayer.api.service.network.firewall.template.Rule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.network.firewall.template;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.network.firewall.Template;

/**
 * The SoftLayer_Network_Component_Firewall_Rule type contains general information relating to a single SoftLayer firewall template rule. Use the [[SoftLayer Network Component Firewall]] service to view current rules. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request. 
 *
 * @see SoftLayer_Network_Firewall_Template_Rule
 */
@ApiType("SoftLayer_Network_Firewall_Template_Rule")
public class Rule extends Entity {

    /**
     * The firewall template that this rule is attached to.
     */
    @ApiProperty
    protected Template firewallTemplate;

    public Template getFirewallTemplate() {
        return firewallTemplate;
    }

    public void setFirewallTemplate(Template firewallTemplate) {
        this.firewallTemplate = firewallTemplate;
    }

    /**
     * The action that this template rule is to take [permit or deny].
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String action;

    public String getAction() {
        return action;
    }

    public void setAction(String action) {
        actionSpecified = true;
        this.action = action;
    }

    protected boolean actionSpecified;

    public boolean isActionSpecified() {
        return actionSpecified;
    }

    public void unsetAction() {
        action = null;
        actionSpecified = false;
    }

    /**
     * The destination IP address considered for determining rule application.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String destinationIpAddress;

    public String getDestinationIpAddress() {
        return destinationIpAddress;
    }

    public void setDestinationIpAddress(String destinationIpAddress) {
        destinationIpAddressSpecified = true;
        this.destinationIpAddress = destinationIpAddress;
    }

    protected boolean destinationIpAddressSpecified;

    public boolean isDestinationIpAddressSpecified() {
        return destinationIpAddressSpecified;
    }

    public void unsetDestinationIpAddress() {
        destinationIpAddress = null;
        destinationIpAddressSpecified = false;
    }

    /**
     * The destination IP subnet mask considered for determining rule application.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String destinationIpSubnetMask;

    public String getDestinationIpSubnetMask() {
        return destinationIpSubnetMask;
    }

    public void setDestinationIpSubnetMask(String destinationIpSubnetMask) {
        destinationIpSubnetMaskSpecified = true;
        this.destinationIpSubnetMask = destinationIpSubnetMask;
    }

    protected boolean destinationIpSubnetMaskSpecified;

    public boolean isDestinationIpSubnetMaskSpecified() {
        return destinationIpSubnetMaskSpecified;
    }

    public void unsetDestinationIpSubnetMask() {
        destinationIpSubnetMask = null;
        destinationIpSubnetMaskSpecified = false;
    }

    /**
     * The ending (upper end of range) destination port considered for determining rule application.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long destinationPortRangeEnd;

    public Long getDestinationPortRangeEnd() {
        return destinationPortRangeEnd;
    }

    public void setDestinationPortRangeEnd(Long destinationPortRangeEnd) {
        destinationPortRangeEndSpecified = true;
        this.destinationPortRangeEnd = destinationPortRangeEnd;
    }

    protected boolean destinationPortRangeEndSpecified;

    public boolean isDestinationPortRangeEndSpecified() {
        return destinationPortRangeEndSpecified;
    }

    public void unsetDestinationPortRangeEnd() {
        destinationPortRangeEnd = null;
        destinationPortRangeEndSpecified = false;
    }

    /**
     * The starting (lower end of range) destination port considered for determining rule application.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long destinationPortRangeStart;

    public Long getDestinationPortRangeStart() {
        return destinationPortRangeStart;
    }

    public void setDestinationPortRangeStart(Long destinationPortRangeStart) {
        destinationPortRangeStartSpecified = true;
        this.destinationPortRangeStart = destinationPortRangeStart;
    }

    protected boolean destinationPortRangeStartSpecified;

    public boolean isDestinationPortRangeStartSpecified() {
        return destinationPortRangeStartSpecified;
    }

    public void unsetDestinationPortRangeStart() {
        destinationPortRangeStart = null;
        destinationPortRangeStartSpecified = false;
    }

    /**
     * The unique identifier of the firewall template that a firewall template rule is associated with.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long firewallTemplateId;

    public Long getFirewallTemplateId() {
        return firewallTemplateId;
    }

    public void setFirewallTemplateId(Long firewallTemplateId) {
        firewallTemplateIdSpecified = true;
        this.firewallTemplateId = firewallTemplateId;
    }

    protected boolean firewallTemplateIdSpecified;

    public boolean isFirewallTemplateIdSpecified() {
        return firewallTemplateIdSpecified;
    }

    public void unsetFirewallTemplateId() {
        firewallTemplateId = null;
        firewallTemplateIdSpecified = false;
    }

    /**
     * A Firewall template rule's internal identifier.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * The notes field for the firewall template rule.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String notes;

    public String getNotes() {
        return notes;
    }

    public void setNotes(String notes) {
        notesSpecified = true;
        this.notes = notes;
    }

    protected boolean notesSpecified;

    public boolean isNotesSpecified() {
        return notesSpecified;
    }

    public void unsetNotes() {
        notes = null;
        notesSpecified = false;
    }

    /**
     * The numeric value describing the order in which the rule set should be applied.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long orderValue;

    public Long getOrderValue() {
        return orderValue;
    }

    public void setOrderValue(Long orderValue) {
        orderValueSpecified = true;
        this.orderValue = orderValue;
    }

    protected boolean orderValueSpecified;

    public boolean isOrderValueSpecified() {
        return orderValueSpecified;
    }

    public void unsetOrderValue() {
        orderValue = null;
        orderValueSpecified = false;
    }

    /**
     * The protocol considered for determining rule application.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String protocol;

    public String getProtocol() {
        return protocol;
    }

    public void setProtocol(String protocol) {
        protocolSpecified = true;
        this.protocol = protocol;
    }

    protected boolean protocolSpecified;

    public boolean isProtocolSpecified() {
        return protocolSpecified;
    }

    public void unsetProtocol() {
        protocol = null;
        protocolSpecified = false;
    }

    /**
     * The source IP address considered for determining rule application.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String sourceIpAddress;

    public String getSourceIpAddress() {
        return sourceIpAddress;
    }

    public void setSourceIpAddress(String sourceIpAddress) {
        sourceIpAddressSpecified = true;
        this.sourceIpAddress = sourceIpAddress;
    }

    protected boolean sourceIpAddressSpecified;

    public boolean isSourceIpAddressSpecified() {
        return sourceIpAddressSpecified;
    }

    public void unsetSourceIpAddress() {
        sourceIpAddress = null;
        sourceIpAddressSpecified = false;
    }

    /**
     * The source IP subnet mask considered for determining rule application.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String sourceIpSubnetMask;

    public String getSourceIpSubnetMask() {
        return sourceIpSubnetMask;
    }

    public void setSourceIpSubnetMask(String sourceIpSubnetMask) {
        sourceIpSubnetMaskSpecified = true;
        this.sourceIpSubnetMask = sourceIpSubnetMask;
    }

    protected boolean sourceIpSubnetMaskSpecified;

    public boolean isSourceIpSubnetMaskSpecified() {
        return sourceIpSubnetMaskSpecified;
    }

    public void unsetSourceIpSubnetMask() {
        sourceIpSubnetMask = null;
        sourceIpSubnetMaskSpecified = false;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public com.softlayer.api.service.network.firewall.Template.Mask firewallTemplate() {
            return withSubMask("firewallTemplate", com.softlayer.api.service.network.firewall.Template.Mask.class);
        }

        public Mask action() {
            withLocalProperty("action");
            return this;
        }

        public Mask destinationIpAddress() {
            withLocalProperty("destinationIpAddress");
            return this;
        }

        public Mask destinationIpSubnetMask() {
            withLocalProperty("destinationIpSubnetMask");
            return this;
        }

        public Mask destinationPortRangeEnd() {
            withLocalProperty("destinationPortRangeEnd");
            return this;
        }

        public Mask destinationPortRangeStart() {
            withLocalProperty("destinationPortRangeStart");
            return this;
        }

        public Mask firewallTemplateId() {
            withLocalProperty("firewallTemplateId");
            return this;
        }

        public Mask id() {
            withLocalProperty("id");
            return this;
        }

        public Mask notes() {
            withLocalProperty("notes");
            return this;
        }

        public Mask orderValue() {
            withLocalProperty("orderValue");
            return this;
        }

        public Mask protocol() {
            withLocalProperty("protocol");
            return this;
        }

        public Mask sourceIpAddress() {
            withLocalProperty("sourceIpAddress");
            return this;
        }

        public Mask sourceIpSubnetMask() {
            withLocalProperty("sourceIpSubnetMask");
            return this;
        }

    }

}