com.softlayer.api.service.network.component.firewall.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
The newest version!
package com.softlayer.api.service.network.component.firewall;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.network.component.Firewall;

/**
 * A SoftLayer_Network_Component_Firewall_Rule object type represents a currently running firewall rule and contains relative information. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates. 
 *
 * @see SoftLayer_Network_Component_Firewall_Rule
 */
@ApiType("SoftLayer_Network_Component_Firewall_Rule")
public class Rule extends Entity {

    /**
     * The network component firewall that this rule belongs to.
     */
    @ApiProperty
    protected Firewall networkComponentFirewall;

    public Firewall getNetworkComponentFirewall() {
        return networkComponentFirewall;
    }

    public void setNetworkComponentFirewall(Firewall networkComponentFirewall) {
        this.networkComponentFirewall = networkComponentFirewall;
    }

    /**
     * The action that the 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 CIDR is used for determining rule application. This value will
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long destinationIpCidr;

    public Long getDestinationIpCidr() {
        return destinationIpCidr;
    }

    public void setDestinationIpCidr(Long destinationIpCidr) {
        destinationIpCidrSpecified = true;
        this.destinationIpCidr = destinationIpCidr;
    }

    protected boolean destinationIpCidrSpecified;

    public boolean isDestinationIpCidrSpecified() {
        return destinationIpCidrSpecified;
    }

    public void unsetDestinationIpCidr() {
        destinationIpCidr = null;
        destinationIpCidrSpecified = 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 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 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 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 CIDR is used for determining rule application. This value will
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long sourceIpCidr;

    public Long getSourceIpCidr() {
        return sourceIpCidr;
    }

    public void setSourceIpCidr(Long sourceIpCidr) {
        sourceIpCidrSpecified = true;
        this.sourceIpCidr = sourceIpCidr;
    }

    protected boolean sourceIpCidrSpecified;

    public boolean isSourceIpCidrSpecified() {
        return sourceIpCidrSpecified;
    }

    public void unsetSourceIpCidr() {
        sourceIpCidr = null;
        sourceIpCidrSpecified = 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;
    }

    /**
     * Current status of the network component firewall.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String status;

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        statusSpecified = true;
        this.status = status;
    }

    protected boolean statusSpecified;

    public boolean isStatusSpecified() {
        return statusSpecified;
    }

    public void unsetStatus() {
        status = null;
        statusSpecified = false;
    }

    /**
     * Whether this rule is an IPv4 rule or an IPv6 rule. If
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long version;

    public Long getVersion() {
        return version;
    }

    public void setVersion(Long version) {
        versionSpecified = true;
        this.version = version;
    }

    protected boolean versionSpecified;

    public boolean isVersionSpecified() {
        return versionSpecified;
    }

    public void unsetVersion() {
        version = null;
        versionSpecified = false;
    }

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

        public com.softlayer.api.service.network.component.Firewall.Mask networkComponentFirewall() {
            return withSubMask("networkComponentFirewall", com.softlayer.api.service.network.component.Firewall.Mask.class);
        }

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

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

        public Mask destinationIpCidr() {
            withLocalProperty("destinationIpCidr");
            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 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 sourceIpCidr() {
            withLocalProperty("sourceIpCidr");
            return this;
        }

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

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

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

    }

}