com.softlayer.api.service.network.lbaas.HealthMonitor

@ApiType("SoftLayer_Network_LBaaS_HealthMonitor")
public class HealthMonitor
extends Entity

The SoftLayer_Network_LBaaS_HealthMonitor type presents a structure containing attributes of a health monitor object associated with load balancer instance. Note that the relationship between backend (pool) and health monitor is N-to-1, especially that the pools object associated with a health monitor must have the same pair of protocol and port. Example: frontend FA: http, 80 - backend BA: tcp, 3456 - healthmonitor HM_tcp3456 frontend FB: https, 443 - backend BB: tcp, 3456 - healthmonitor HM_tcp3456 In above example both backends BA and BB share the same healthmonitor HM_tcp3456

See Also:: SoftLayer_Network_LBaaS_HealthMonitor

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class HealthMonitor.Mask

static interface HealthMonitor.Service

static interface HealthMonitor.ServiceAsync

Field Summary

Fields
Modifier and Type	Field	Description
`protected GregorianCalendar`	`createDate`	Create date of the health monitor instance
`protected boolean`	`createDateSpecified`
`protected Long`	`id`	Health monitor's identifier
`protected boolean`	`idSpecified`
`protected Long`	`interval`	Interval in seconds to perform health check
`protected boolean`	`intervalSpecified`
`protected Long`	`maxRetries`	Maximum number of health check retries in case of failure
`protected boolean`	`maxRetriesSpecified`
`protected GregorianCalendar`	`modifyDate`	Modify date of the health monitor instance
`protected boolean`	`modifyDateSpecified`
`protected String`	`monitorType`	Type of health check, valid values are "TCP", "HTTP" and "HTTPS"
`protected boolean`	`monitorTypeSpecified`
`protected String`	`provisioningStatus`	Provisioning status of the health monitor, supported values are "CREATE_PENDING",
`protected boolean`	`provisioningStatusSpecified`
`protected Long`	`timeout`	Timeout in seconds to wait for health checks response
`protected boolean`	`timeoutSpecified`
`protected String`	`urlPath`	If monitorType is "HTTP" this specifies the whole URL path
`protected boolean`	`urlPathSpecified`
`protected String`	`uuid`	Health monitor's UUID
`protected boolean`	`uuidSpecified`

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

HealthMonitor()

Method Summary

Modifier and Type	Method	Description
`HealthMonitor.Service`	`asService(ApiClient client)`
`GregorianCalendar`	`getCreateDate()`
`Long`	`getId()`
`Long`	`getInterval()`
`Long`	`getMaxRetries()`
`GregorianCalendar`	`getModifyDate()`
`String`	`getMonitorType()`
`String`	`getProvisioningStatus()`
`Long`	`getTimeout()`
`String`	`getUrlPath()`
`String`	`getUuid()`
`boolean`	`isCreateDateSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isIntervalSpecified()`
`boolean`	`isMaxRetriesSpecified()`
`boolean`	`isModifyDateSpecified()`
`boolean`	`isMonitorTypeSpecified()`
`boolean`	`isProvisioningStatusSpecified()`
`boolean`	`isTimeoutSpecified()`
`boolean`	`isUrlPathSpecified()`
`boolean`	`isUuidSpecified()`
`static HealthMonitor.Service`	`service(ApiClient client)`
`static HealthMonitor.Service`	`service(ApiClient client, Long id)`
`void`	`setCreateDate(GregorianCalendar createDate)`
`void`	`setId(Long id)`
`void`	`setInterval(Long interval)`
`void`	`setMaxRetries(Long maxRetries)`
`void`	`setModifyDate(GregorianCalendar modifyDate)`
`void`	`setMonitorType(String monitorType)`
`void`	`setProvisioningStatus(String provisioningStatus)`
`void`	`setTimeout(Long timeout)`
`void`	`setUrlPath(String urlPath)`
`void`	`setUuid(String uuid)`
`void`	`unsetCreateDate()`
`void`	`unsetId()`
`void`	`unsetInterval()`
`void`	`unsetMaxRetries()`
`void`	`unsetModifyDate()`
`void`	`unsetMonitorType()`
`void`	`unsetProvisioningStatus()`
`void`	`unsetTimeout()`
`void`	`unsetUrlPath()`
`void`	`unsetUuid()`

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- createDate
  
  @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar createDate
  
  Create date of the health monitor instance
- createDateSpecified
  
  protected boolean createDateSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  Health monitor's identifier
- idSpecified
  
  protected boolean idSpecified
- interval
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long interval
  
  Interval in seconds to perform health check
- intervalSpecified
  
  protected boolean intervalSpecified
- maxRetries
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long maxRetries
  
  Maximum number of health check retries in case of failure
- maxRetriesSpecified
  
  protected boolean maxRetriesSpecified
- modifyDate
  
  @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar modifyDate
  
  Modify date of the health monitor instance
- modifyDateSpecified
  
  protected boolean modifyDateSpecified
- monitorType
  
  @ApiProperty(canBeNullOrNotSet=true) protected String monitorType
  
  Type of health check, valid values are "TCP", "HTTP" and "HTTPS"
- monitorTypeSpecified
  
  protected boolean monitorTypeSpecified
- provisioningStatus
  
  @ApiProperty(canBeNullOrNotSet=true) protected String provisioningStatus
  
  Provisioning status of the health monitor, supported values are "CREATE_PENDING",
- provisioningStatusSpecified
  
  protected boolean provisioningStatusSpecified
- timeout
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long timeout
  
  Timeout in seconds to wait for health checks response
- timeoutSpecified
  
  protected boolean timeoutSpecified
- urlPath
  
  @ApiProperty(canBeNullOrNotSet=true) protected String urlPath
  
  If monitorType is "HTTP" this specifies the whole URL path
- urlPathSpecified
  
  protected boolean urlPathSpecified
- uuid
  
  @ApiProperty(canBeNullOrNotSet=true) protected String uuid
  
  Health monitor's UUID
- uuidSpecified
  
  protected boolean uuidSpecified
Constructor Details
- HealthMonitor
  
  public HealthMonitor()
Method Details
- getCreateDate
  
  public GregorianCalendar getCreateDate()
- setCreateDate
  
  public void setCreateDate(GregorianCalendar createDate)
- isCreateDateSpecified
  
  public boolean isCreateDateSpecified()
- unsetCreateDate
  
  public void unsetCreateDate()
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- isIdSpecified
  
  public boolean isIdSpecified()
- unsetId
  
  public void unsetId()
- getInterval
  
  public Long getInterval()
- setInterval
  
  public void setInterval(Long interval)
- isIntervalSpecified
  
  public boolean isIntervalSpecified()
- unsetInterval
  
  public void unsetInterval()
- getMaxRetries
  
  public Long getMaxRetries()
- setMaxRetries
  
  public void setMaxRetries(Long maxRetries)
- isMaxRetriesSpecified
  
  public boolean isMaxRetriesSpecified()
- unsetMaxRetries
  
  public void unsetMaxRetries()
- getModifyDate
  
  public GregorianCalendar getModifyDate()
- setModifyDate
  
  public void setModifyDate(GregorianCalendar modifyDate)
- isModifyDateSpecified
  
  public boolean isModifyDateSpecified()
- unsetModifyDate
  
  public void unsetModifyDate()
- getMonitorType
  
  public String getMonitorType()
- setMonitorType
  
  public void setMonitorType(String monitorType)
- isMonitorTypeSpecified
  
  public boolean isMonitorTypeSpecified()
- unsetMonitorType
  
  public void unsetMonitorType()
- getProvisioningStatus
  
  public String getProvisioningStatus()
- setProvisioningStatus
  
  public void setProvisioningStatus(String provisioningStatus)
- isProvisioningStatusSpecified
  
  public boolean isProvisioningStatusSpecified()
- unsetProvisioningStatus
  
  public void unsetProvisioningStatus()
- getTimeout
  
  public Long getTimeout()
- setTimeout
  
  public void setTimeout(Long timeout)
- isTimeoutSpecified
  
  public boolean isTimeoutSpecified()
- unsetTimeout
  
  public void unsetTimeout()
- getUrlPath
  
  public String getUrlPath()
- setUrlPath
  
  public void setUrlPath(String urlPath)
- isUrlPathSpecified
  
  public boolean isUrlPathSpecified()
- unsetUrlPath
  
  public void unsetUrlPath()
- getUuid
  
  public String getUuid()
- setUuid
  
  public void setUuid(String uuid)
- isUuidSpecified
  
  public boolean isUuidSpecified()
- unsetUuid
  
  public void unsetUuid()
- asService
  
  public HealthMonitor.Service asService(ApiClient client)
- service
  
  public static HealthMonitor.Service service(ApiClient client)
- service
  
  public static HealthMonitor.Service service(ApiClient client, Long id)

Modifier and Type	Class	Description
`static class`	`HealthMonitor.Mask`
`static interface`	`HealthMonitor.Service`
`static interface`	`HealthMonitor.ServiceAsync`

Class HealthMonitor

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details