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

Class Host

  • @ApiType("SoftLayer_Network_LoadBalancer_Global_Host")
public class Host
extends Entity
    The SoftLayer_Network_LoadBalancer_Global_Host data type represents a single host that belongs to a global load balancer account's load balancing pool.

    The destination IP address of a host must be one that belongs to your SoftLayer customer account, or to a datacenter load balancer virtual ip that belongs to your SoftLayer customer account. The destination IP address and port of a global load balancer host is a required field and must exist during creation and can not be removed. The acceptable values for the health check type are 'none', 'http', and 'tcp'. The status property is updated in 5 minute intervals and the hits property is updated in 10 minute intervals.

    The order of the host is only important if you are using the 'failover' load balance method, and the weight is only important if you are using the 'weighted round robin' load balance method.
    See Also:
    SoftLayer_Network_LoadBalancer_Global_Host

    • Field Detail

      • loadBalancerAccount

        @ApiProperty
protected Account loadBalancerAccount
        The global load balancer account a host belongs to.

      • destinationIp

        @ApiProperty(canBeNullOrNotSet=true)
protected String destinationIp
        The IP address of the host that will be returned by the global load balancers in response to a dns request.

      • destinationIpSpecified

        protected boolean destinationIpSpecified

      • destinationPortSpecified

        protected boolean destinationPortSpecified

      • enabledSpecified

        protected boolean enabledSpecified

      • healthCheckSpecified

        protected boolean healthCheckSpecified

      • hitsSpecified

        protected boolean hitsSpecified

      • idSpecified

        protected boolean idSpecified

      • loadBalanceOrder

        @ApiProperty(canBeNullOrNotSet=true)
protected Long loadBalanceOrder
        The order of this host within the load balance pool. This is only significant if the load balance method is set to failover.

      • loadBalanceOrderSpecified

        protected boolean loadBalanceOrderSpecified

      • locationSpecified

        protected boolean locationSpecified

      • status

        @ApiProperty(canBeNullOrNotSet=true)
protected String status
        The health status of a host. The status can be either 'UP', 'DOWN', or null which could mean that the health check type is set to 'none' or an update to the ip, port, or health check type was recently done and the host is waiting for the new status.

      • statusSpecified

        protected boolean statusSpecified

      • weight

        @ApiProperty(canBeNullOrNotSet=true)
protected Long weight
        The load balance weight of a host. The total weight of all hosts in the load balancing pool must not exceed 100.

      • weightSpecified

        protected boolean weightSpecified

    • Constructor Detail

      • Host

        public Host()

    • Method Detail

      • getLoadBalancerAccount

        public Account getLoadBalancerAccount()

      • setLoadBalancerAccount

        public void setLoadBalancerAccount​(Account loadBalancerAccount)

      • getDestinationIp

        public String getDestinationIp()

      • setDestinationIp

        public void setDestinationIp​(String destinationIp)

      • isDestinationIpSpecified

        public boolean isDestinationIpSpecified()

      • unsetDestinationIp

        public void unsetDestinationIp()

      • getDestinationPort

        public Long getDestinationPort()

      • setDestinationPort

        public void setDestinationPort​(Long destinationPort)

      • isDestinationPortSpecified

        public boolean isDestinationPortSpecified()

      • unsetDestinationPort

        public void unsetDestinationPort()

      • getEnabled

        public Long getEnabled()

      • setEnabled

        public void setEnabled​(Long 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()

      • setHits

        public void setHits​(BigDecimal hits)

      • isHitsSpecified

        public boolean isHitsSpecified()

      • unsetHits

        public void unsetHits()

      • getId

        public Long getId()

      • setId

        public void setId​(Long id)

      • isIdSpecified

        public boolean isIdSpecified()

      • unsetId

        public void unsetId()

      • getLoadBalanceOrder

        public Long getLoadBalanceOrder()

      • setLoadBalanceOrder

        public void setLoadBalanceOrder​(Long loadBalanceOrder)

      • isLoadBalanceOrderSpecified

        public boolean isLoadBalanceOrderSpecified()

      • unsetLoadBalanceOrder

        public void unsetLoadBalanceOrder()

      • getLocation

        public String getLocation()

      • setLocation

        public void setLocation​(String location)

      • isLocationSpecified

        public boolean isLocationSpecified()

      • unsetLocation

        public void unsetLocation()

      • getStatus

        public String getStatus()

      • setStatus

        public void setStatus​(String status)

      • isStatusSpecified

        public boolean isStatusSpecified()

      • unsetStatus

        public void unsetStatus()

      • getWeight

        public Long getWeight()

      • setWeight

        public void setWeight​(Long weight)

      • isWeightSpecified

        public boolean isWeightSpecified()

      • unsetWeight

        public void unsetWeight()