Package com.softlayer.api.service.network.securitygroup

Class Rule

java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.network.securitygroup.Rule
@ApiType("SoftLayer_Network_SecurityGroup_Rule")
public class Rule
extends Entity
The SoftLayer_Network_SecurityGroup_Rule data type contains general information for a single rule that belongs to a [[SoftLayer_Network_SecurityGroup|security group]]. By default, all traffic (both inbound and
 outbound) to a virtual server instance is blocked. Security group rules are permissive, and define the allowed incoming (ingress) and outgoing (egress) traffic to both the public and private interfaces of a
 virtual server instance. The order of rules within a security group does not matter and priority always falls to the least restrictive rule.
See Also:
SoftLayer_Network_SecurityGroup_Rule

  • Field Details

    • remoteGroup

      @ApiProperty protected SecurityGroup remoteGroup
      The remote security group allowed as part of this rule.

    • securityGroup

      @ApiProperty protected SecurityGroup securityGroup
      The security group of this rule.

    • createDate

      @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar createDate
      The createDate field for a rule. It is essentially the date and time that the security group rule was created.

    • createDateSpecified

      protected boolean createDateSpecified

    • direction

      @ApiProperty(canBeNullOrNotSet=true) protected String direction
      The direction of traffic (ingress or egress).

    • directionSpecified

      protected boolean directionSpecified

    • ethertype

      @ApiProperty(canBeNullOrNotSet=true) protected String ethertype
      IPv4 or IPv6. If the remoteIp or ethertype properties are not specified, the default is IPv4. Otherwise ethertype will default based on the format of the specified remoteIp.

    • ethertypeSpecified

      protected boolean ethertypeSpecified

    • id

      @ApiProperty(canBeNullOrNotSet=true) protected Long id
      The unique ID for a rule.

    • idSpecified

      protected boolean idSpecified

    • modifyDate

      @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar modifyDate
      The modifyDate field for a rule. It is essentially the date and time that the security group rule was last changed.

    • modifyDateSpecified

      protected boolean modifyDateSpecified

    • portRangeMax

      @ApiProperty(canBeNullOrNotSet=true) protected Long portRangeMax
      The end of the port range for allowed traffic. When the protocol is icmp, this value specifies the icmp code to permit. When icmp code is specified, icmp type is required. When the protocol is vrrp, ports cannot be specified.

    • portRangeMaxSpecified

      protected boolean portRangeMaxSpecified

    • portRangeMin

      @ApiProperty(canBeNullOrNotSet=true) protected Long portRangeMin
      The start of the port range for allowed traffic. When the protocol is icmp, this value specifies the icmp type to permit.

    • portRangeMinSpecified

      protected boolean portRangeMinSpecified

    • protocol

      @ApiProperty(canBeNullOrNotSet=true) protected String protocol
      The protocol of packets (icmp, tcp, udp, or vrrp).

    • protocolSpecified

      protected boolean protocolSpecified

    • remoteGroupId

      @ApiProperty(canBeNullOrNotSet=true) protected Long remoteGroupId
      The ID of the remote security group allowed as part of the rule. This property is mutually exclusive with the remoteIp property.

    • remoteGroupIdSpecified

      protected boolean remoteGroupIdSpecified

    • remoteIp

      @ApiProperty(canBeNullOrNotSet=true) protected String remoteIp
      CIDR or IP address for allowed connections. This property is mutually exclusive with the remoteGroupId property. When the protocol is vrrp, ports cannot be specified.

    • remoteIpSpecified

      protected boolean remoteIpSpecified

    • securityGroupId

      @ApiProperty(canBeNullOrNotSet=true) protected Long securityGroupId
      The ID of the security group that owns the rule.

    • securityGroupIdSpecified

      protected boolean securityGroupIdSpecified

  • Constructor Details

    • Rule

      public Rule()

  • Method Details

    • getRemoteGroup

      public SecurityGroup getRemoteGroup()

    • setRemoteGroup

      public void setRemoteGroup​(SecurityGroup remoteGroup)

    • getSecurityGroup

      public SecurityGroup getSecurityGroup()

    • setSecurityGroup

      public void setSecurityGroup​(SecurityGroup securityGroup)

    • getCreateDate

      public GregorianCalendar getCreateDate()

    • setCreateDate

      public void setCreateDate​(GregorianCalendar createDate)

    • isCreateDateSpecified

      public boolean isCreateDateSpecified()

    • unsetCreateDate

      public void unsetCreateDate()

    • getDirection

      public String getDirection()

    • setDirection

      public void setDirection​(String direction)

    • isDirectionSpecified

      public boolean isDirectionSpecified()

    • unsetDirection

      public void unsetDirection()

    • getEthertype

      public String getEthertype()

    • setEthertype

      public void setEthertype​(String ethertype)

    • isEthertypeSpecified

      public boolean isEthertypeSpecified()

    • unsetEthertype

      public void unsetEthertype()

    • getId

      public Long getId()

    • setId

      public void setId​(Long id)

    • isIdSpecified

      public boolean isIdSpecified()

    • unsetId

      public void unsetId()

    • getModifyDate

      public GregorianCalendar getModifyDate()

    • setModifyDate

      public void setModifyDate​(GregorianCalendar modifyDate)

    • isModifyDateSpecified

      public boolean isModifyDateSpecified()

    • unsetModifyDate

      public void unsetModifyDate()

    • getPortRangeMax

      public Long getPortRangeMax()

    • setPortRangeMax

      public void setPortRangeMax​(Long portRangeMax)

    • isPortRangeMaxSpecified

      public boolean isPortRangeMaxSpecified()

    • unsetPortRangeMax

      public void unsetPortRangeMax()

    • getPortRangeMin

      public Long getPortRangeMin()

    • setPortRangeMin

      public void setPortRangeMin​(Long portRangeMin)

    • isPortRangeMinSpecified

      public boolean isPortRangeMinSpecified()

    • unsetPortRangeMin

      public void unsetPortRangeMin()

    • getProtocol

      public String getProtocol()

    • setProtocol

      public void setProtocol​(String protocol)

    • isProtocolSpecified

      public boolean isProtocolSpecified()

    • unsetProtocol

      public void unsetProtocol()

    • getRemoteGroupId

      public Long getRemoteGroupId()

    • setRemoteGroupId

      public void setRemoteGroupId​(Long remoteGroupId)

    • isRemoteGroupIdSpecified

      public boolean isRemoteGroupIdSpecified()

    • unsetRemoteGroupId

      public void unsetRemoteGroupId()

    • getRemoteIp

      public String getRemoteIp()

    • setRemoteIp

      public void setRemoteIp​(String remoteIp)

    • isRemoteIpSpecified

      public boolean isRemoteIpSpecified()

    • unsetRemoteIp

      public void unsetRemoteIp()

    • getSecurityGroupId

      public Long getSecurityGroupId()

    • setSecurityGroupId

      public void setSecurityGroupId​(Long securityGroupId)

    • isSecurityGroupIdSpecified

      public boolean isSecurityGroupIdSpecified()

    • unsetSecurityGroupId

      public void unsetSecurityGroupId()