Package com.softlayer.api.service.network.loadbalancer

Class LoadBalancerService

java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.network.loadbalancer.LoadBalancerService
@ApiType("SoftLayer_Network_LoadBalancer_Service")
public class LoadBalancerService
extends Entity
The SoftLayer_Network_LoadBalancer_Service data type contains all the information relating to a specific service (destination) on a particular load balancer.

Information retained on the object itself is the the source and destination of the service, routing type, weight, and whether or not the service is currently enabled.
See Also:
SoftLayer_Network_LoadBalancer_Service

  • Field Details

    • vip

      @ApiProperty protected VirtualIpAddress vip
      The load balancer that this service belongs to.

    • connectionLimit

      @ApiProperty(canBeNullOrNotSet=true) protected Long connectionLimit
      Connection limit on this service.

    • connectionLimitSpecified

      protected boolean connectionLimitSpecified

    • createDate

      @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar createDate
      Creation Date of this service

    • createDateSpecified

      protected boolean createDateSpecified

    • destinationIpAddress

      @ApiProperty(canBeNullOrNotSet=true) protected String destinationIpAddress
      The IP Address of the real server you wish to direct traffic to. Your account must own this IP

    • destinationIpAddressSpecified

      protected boolean destinationIpAddressSpecified

    • destinationPort

      @ApiProperty(canBeNullOrNotSet=true) protected Long destinationPort
      The port on the real server to direct the traffic. This can be different than the source port. If you wish to obfuscate your HTTP traffic, you can accept requests on port 80 on the load balancer, then redirect them to port 932 on your real server.

    • destinationPortSpecified

      protected boolean destinationPortSpecified

    • enabled

      @ApiProperty(canBeNullOrNotSet=true) protected Boolean enabled
      A flag (either true or false) that determines if this particular service should be enabled on the load balancer. Set to false to bring the server out of rotation without losing your configuration

    • enabledSpecified

      protected boolean enabledSpecified

    • healthCheck

      @ApiProperty(canBeNullOrNotSet=true) protected String healthCheck
      The health check type for this service. If one is supplied, the load balancer will occasionally ping your server to determine if it is still up. Servers that are down are removed from the queue and will not be used to handle requests until their status returns to "up". The value of the health check is determined directly by what option you have selected for the routing type.

      {|
      |-
      ! Type
      ! Valid Health Checks
      |-
      | HTTP
      | HTTP, TCP, ICMP
      |-
      | TCP
      | HTTP, TCP, ICMP
      |-
      | FTP
      | TCP, ICMP
      |-
      | DNS
      | DNS, ICMP
      |-
      | UDP
      | None
      |}

    • healthCheckSpecified

      protected boolean healthCheckSpecified

    • healthCheckURL

      @ApiProperty(canBeNullOrNotSet=true) protected String healthCheckURL
      The URL provided here (starting with /) is what the load balancer will request in order to perform a custom HTTP health check. You must specify either "GET /location/of/file.html" or "HEAD /location/of/file.php"

    • healthCheckURLSpecified

      protected boolean healthCheckURLSpecified

    • healthResponse

      @ApiProperty(canBeNullOrNotSet=true) protected String healthResponse
      The expected response from the custom HTTP health check. If the requested page contains this response, the check succeeds.

    • healthResponseSpecified

      protected boolean healthResponseSpecified

    • id

      @ApiProperty(canBeNullOrNotSet=true) protected Long id
      Unique ID for this object, used for the getObject method, and must be set if you are editing this object.

    • idSpecified

      protected boolean idSpecified

    • modifyDate

      @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar modifyDate
      Last modification date of this service

    • modifyDateSpecified

      protected boolean modifyDateSpecified

    • name

      @ApiProperty(canBeNullOrNotSet=true) protected String name
      Name of the load balancer service

    • nameSpecified

      protected boolean nameSpecified

    • notes

      @ApiProperty(canBeNullOrNotSet=true) protected String notes
      Holds whether this server is up or down. Does not affect load balancer configuration at all, just for the customer's informational purposes

    • notesSpecified

      protected boolean notesSpecified

    • peakConnections

      @ApiProperty(canBeNullOrNotSet=true) protected Long peakConnections
      Peak historical connections since the creation of this service. Is reset any time you make a configuration change

    • peakConnectionsSpecified

      protected boolean peakConnectionsSpecified

    • sourcePort

      @ApiProperty(canBeNullOrNotSet=true) protected Long sourcePort
      The port on the load balancer that this service maps to. This is the port for incoming traffic, it needs to be shared with other services to form a group.

    • sourcePortSpecified

      protected boolean sourcePortSpecified

    • type

      @ApiProperty(canBeNullOrNotSet=true) protected String type
      The connection type of this service. Valid values are HTTP, FTP, TCP, UDP, and DNS. The value of this variable affects available values of healthCheck, listed in that variable's description

    • typeSpecified

      protected boolean typeSpecified

    • vipId

      @ApiProperty(canBeNullOrNotSet=true) protected Long vipId
      Unique ID for this object's parent. Probably not useful in the API, as this object will always be a child of a VirtualIpAddress anyway.

    • vipIdSpecified

      protected boolean vipIdSpecified

    • weight

      @ApiProperty(canBeNullOrNotSet=true) protected Long weight
      Weight affects the choices the load balancer makes between your services. The weight of each service is expressed as a percentage of the TOTAL CONNECTION LIMIT on the virtual IP Address. All services draw from the same pool of connections, so if you expect to have 4 times as much HTTP traffic as HTTPS, your weights for the above example routes would be 40%, 40%, 10%, 10% respectively. The weights should add up to 100% If you go over 100%, an exception will be thrown. Weights must be whole numbers, no fractions or decimals are accepted.

    • weightSpecified

      protected boolean weightSpecified

  • Constructor Details

    • LoadBalancerService

      public LoadBalancerService()

  • Method Details

    • getVip

      public VirtualIpAddress getVip()

    • setVip

      public void setVip​(VirtualIpAddress vip)

    • getConnectionLimit

      public Long getConnectionLimit()

    • setConnectionLimit

      public void setConnectionLimit​(Long connectionLimit)

    • isConnectionLimitSpecified

      public boolean isConnectionLimitSpecified()

    • unsetConnectionLimit

      public void unsetConnectionLimit()

    • getCreateDate

      public GregorianCalendar getCreateDate()

    • setCreateDate

      public void setCreateDate​(GregorianCalendar createDate)

    • isCreateDateSpecified

      public boolean isCreateDateSpecified()

    • unsetCreateDate

      public void unsetCreateDate()

    • getDestinationIpAddress

      public String getDestinationIpAddress()

    • setDestinationIpAddress

      public void setDestinationIpAddress​(String destinationIpAddress)

    • isDestinationIpAddressSpecified

      public boolean isDestinationIpAddressSpecified()

    • unsetDestinationIpAddress

      public void unsetDestinationIpAddress()

    • getDestinationPort

      public Long getDestinationPort()

    • setDestinationPort

      public void setDestinationPort​(Long destinationPort)

    • isDestinationPortSpecified

      public boolean isDestinationPortSpecified()

    • unsetDestinationPort

      public void unsetDestinationPort()

    • getEnabled

      public Boolean getEnabled()

    • setEnabled

      public void setEnabled​(Boolean enabled)

    • isEnabledSpecified

      public boolean isEnabledSpecified()

    • unsetEnabled

      public void unsetEnabled()

    • getHealthCheck

      public String getHealthCheck()

    • setHealthCheck

      public void setHealthCheck​(String healthCheck)

    • isHealthCheckSpecified

      public boolean isHealthCheckSpecified()

    • unsetHealthCheck

      public void unsetHealthCheck()

    • getHealthCheckURL

      public String getHealthCheckURL()

    • setHealthCheckURL

      public void setHealthCheckURL​(String healthCheckURL)

    • isHealthCheckURLSpecified

      public boolean isHealthCheckURLSpecified()

    • unsetHealthCheckURL

      public void unsetHealthCheckURL()

    • getHealthResponse

      public String getHealthResponse()

    • setHealthResponse

      public void setHealthResponse​(String healthResponse)

    • isHealthResponseSpecified

      public boolean isHealthResponseSpecified()

    • unsetHealthResponse

      public void unsetHealthResponse()

    • 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()

    • getName

      public String getName()

    • setName

      public void setName​(String name)

    • isNameSpecified

      public boolean isNameSpecified()

    • unsetName

      public void unsetName()

    • getNotes

      public String getNotes()

    • setNotes

      public void setNotes​(String notes)

    • isNotesSpecified

      public boolean isNotesSpecified()

    • unsetNotes

      public void unsetNotes()

    • getPeakConnections

      public Long getPeakConnections()

    • setPeakConnections

      public void setPeakConnections​(Long peakConnections)

    • isPeakConnectionsSpecified

      public boolean isPeakConnectionsSpecified()

    • unsetPeakConnections

      public void unsetPeakConnections()

    • getSourcePort

      public Long getSourcePort()

    • setSourcePort

      public void setSourcePort​(Long sourcePort)

    • isSourcePortSpecified

      public boolean isSourcePortSpecified()

    • unsetSourcePort

      public void unsetSourcePort()

    • getType

      public String getType()

    • setType

      public void setType​(String type)

    • isTypeSpecified

      public boolean isTypeSpecified()

    • unsetType

      public void unsetType()

    • getVipId

      public Long getVipId()

    • setVipId

      public void setVipId​(Long vipId)

    • isVipIdSpecified

      public boolean isVipIdSpecified()

    • unsetVipId

      public void unsetVipId()

    • getWeight

      public Long getWeight()

    • setWeight

      public void setWeight​(Long weight)

    • isWeightSpecified

      public boolean isWeightSpecified()

    • unsetWeight

      public void unsetWeight()

    • asService

      public LoadBalancerService.Service asService​(ApiClient client)

    • service

      public static LoadBalancerService.Service service​(ApiClient client)

    • service

      public static LoadBalancerService.Service service​(ApiClient client, Long id)