com.softlayer.api.service.network.monitor.version1.query.Host

@ApiType("SoftLayer_Network_Monitor_Version1_Query_Host")
public class Host
extends Entity

The Monitoring_Query_Host type represents a monitoring instance. It consists of a hardware ID to monitor, an IP address attached to that hardware ID, a method of monitoring, and what to do in the instance that the monitor ever fails.

See Also:: SoftLayer_Network_Monitor_Version1_Query_Host

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Host.Mask`
`static interface`	`Host.Service`	The Query_Host service is the core of the monitoring system.
`static interface`	`Host.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`arg1Value`	The argument to be used for this monitor, if necessary.
`protected boolean`	`arg1ValueSpecified`
`protected Long`	`guestId`	Virtual Guest Identification Number for the guest being monitored.
`protected boolean`	`guestIdSpecified`
`protected Hardware`	`hardware`	The hardware that is being monitored by this monitoring instance
`protected Long`	`hardwareId`	The ID of the hardware being monitored
`protected boolean`	`hardwareIdSpecified`
`protected Long`	`hostId`	Identification Number for the host being monitored.
`protected boolean`	`hostIdSpecified`
`protected Long`	`id`	The unique identifier for this object
`protected boolean`	`idSpecified`
`protected String`	`ipAddress`	The IP address to be monitored.
`protected boolean`	`ipAddressSpecified`
`protected Result`	`lastResult`	The most recent result for this particular monitoring instance.
`protected Type`	`queryType`	The type of monitoring query that is executed when this hardware is monitored.
`protected Long`	`queryTypeId`	The ID of the query type to use.
`protected boolean`	`queryTypeIdSpecified`
`protected ResponseType`	`responseAction`	The action taken when a monitor fails.
`protected Long`	`responseActionId`	The ID of the response action to take when the monitor fails
`protected boolean`	`responseActionIdSpecified`
`protected String`	`status`	The status of this monitoring instance.
`protected boolean`	`statusSpecified`
`protected Long`	`waitCycles`	The number of 5-minute cycles to wait before the "responseAction" is taken.
`protected boolean`	`waitCyclesSpecified`

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

Host()

Method Summary

Modifier and Type	Method	Description
`Host.Service`	`asService(ApiClient client)`
`String`	`getArg1Value()`
`Long`	`getGuestId()`
`Hardware`	`getHardware()`
`Long`	`getHardwareId()`
`Long`	`getHostId()`
`Long`	`getId()`
`String`	`getIpAddress()`
`Result`	`getLastResult()`
`Type`	`getQueryType()`
`Long`	`getQueryTypeId()`
`ResponseType`	`getResponseAction()`
`Long`	`getResponseActionId()`
`String`	`getStatus()`
`Long`	`getWaitCycles()`
`boolean`	`isArg1ValueSpecified()`
`boolean`	`isGuestIdSpecified()`
`boolean`	`isHardwareIdSpecified()`
`boolean`	`isHostIdSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isIpAddressSpecified()`
`boolean`	`isQueryTypeIdSpecified()`
`boolean`	`isResponseActionIdSpecified()`
`boolean`	`isStatusSpecified()`
`boolean`	`isWaitCyclesSpecified()`
`static Host.Service`	`service(ApiClient client)`
`static Host.Service`	`service(ApiClient client, Long id)`
`void`	`setArg1Value(String arg1Value)`
`void`	`setGuestId(Long guestId)`
`void`	`setHardware(Hardware hardware)`
`void`	`setHardwareId(Long hardwareId)`
`void`	`setHostId(Long hostId)`
`void`	`setId(Long id)`
`void`	`setIpAddress(String ipAddress)`
`void`	`setLastResult(Result lastResult)`
`void`	`setQueryType(Type queryType)`
`void`	`setQueryTypeId(Long queryTypeId)`
`void`	`setResponseAction(ResponseType responseAction)`
`void`	`setResponseActionId(Long responseActionId)`
`void`	`setStatus(String status)`
`void`	`setWaitCycles(Long waitCycles)`
`void`	`unsetArg1Value()`
`void`	`unsetGuestId()`
`void`	`unsetHardwareId()`
`void`	`unsetHostId()`
`void`	`unsetId()`
`void`	`unsetIpAddress()`
`void`	`unsetQueryTypeId()`
`void`	`unsetResponseActionId()`
`void`	`unsetStatus()`
`void`	`unsetWaitCycles()`

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
- hardware
  
  @ApiProperty protected Hardware hardware
  
  The hardware that is being monitored by this monitoring instance
- lastResult
  
  @ApiProperty protected Result lastResult
  
  The most recent result for this particular monitoring instance.
- queryType
  
  @ApiProperty protected Type queryType
  
  The type of monitoring query that is executed when this hardware is monitored.
- responseAction
  
  @ApiProperty protected ResponseType responseAction
  
  The action taken when a monitor fails.
- arg1Value
  
  @ApiProperty(canBeNullOrNotSet=true) protected String arg1Value
  
  The argument to be used for this monitor, if necessary. The lowest monitoring levels (like ping) ignore this setting, but higher levels like HTTP custom use it.
- arg1ValueSpecified
  
  protected boolean arg1ValueSpecified
- guestId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long guestId
  
  Virtual Guest Identification Number for the guest being monitored.
- guestIdSpecified
  
  protected boolean guestIdSpecified
- hardwareId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long hardwareId
  
  The ID of the hardware being monitored
- hardwareIdSpecified
  
  protected boolean hardwareIdSpecified
- hostId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long hostId
  
  Identification Number for the host being monitored.
- hostIdSpecified
  
  protected boolean hostIdSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  The unique identifier for this object
- idSpecified
  
  protected boolean idSpecified
- ipAddress
  
  @ApiProperty(canBeNullOrNotSet=true) protected String ipAddress
  
  The IP address to be monitored. Must be attached to the hardware on this object
- ipAddressSpecified
  
  protected boolean ipAddressSpecified
- queryTypeId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long queryTypeId
  
  The ID of the query type to use.
- queryTypeIdSpecified
  
  protected boolean queryTypeIdSpecified
- responseActionId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long responseActionId
  
  The ID of the response action to take when the monitor fails
- responseActionIdSpecified
  
  protected boolean responseActionIdSpecified
- status
  
  @ApiProperty(canBeNullOrNotSet=true) protected String status
  
  The status of this monitoring instance. Anything other than "ON" means that the monitor has been disabled
- statusSpecified
  
  protected boolean statusSpecified
- waitCycles
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long waitCycles
  
  The number of 5-minute cycles to wait before the "responseAction" is taken. If set to 0, the response action will be taken immediately
- waitCyclesSpecified
  
  protected boolean waitCyclesSpecified
Constructor Details
- Host
  
  public Host()
Method Details
- getHardware
  
  public Hardware getHardware()
- setHardware
  
  public void setHardware(Hardware hardware)
- getLastResult
  
  public Result getLastResult()
- setLastResult
  
  public void setLastResult(Result lastResult)
- getQueryType
  
  public Type getQueryType()
- setQueryType
  
  public void setQueryType(Type queryType)
- getResponseAction
  
  public ResponseType getResponseAction()
- setResponseAction
  
  public void setResponseAction(ResponseType responseAction)
- getArg1Value
  
  public String getArg1Value()
- setArg1Value
  
  public void setArg1Value(String arg1Value)
- isArg1ValueSpecified
  
  public boolean isArg1ValueSpecified()
- unsetArg1Value
  
  public void unsetArg1Value()
- getGuestId
  
  public Long getGuestId()
- setGuestId
  
  public void setGuestId(Long guestId)
- isGuestIdSpecified
  
  public boolean isGuestIdSpecified()
- unsetGuestId
  
  public void unsetGuestId()
- getHardwareId
  
  public Long getHardwareId()
- setHardwareId
  
  public void setHardwareId(Long hardwareId)
- isHardwareIdSpecified
  
  public boolean isHardwareIdSpecified()
- unsetHardwareId
  
  public void unsetHardwareId()
- getHostId
  
  public Long getHostId()
- setHostId
  
  public void setHostId(Long hostId)
- isHostIdSpecified
  
  public boolean isHostIdSpecified()
- unsetHostId
  
  public void unsetHostId()
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- isIdSpecified
  
  public boolean isIdSpecified()
- unsetId
  
  public void unsetId()
- getIpAddress
  
  public String getIpAddress()
- setIpAddress
  
  public void setIpAddress(String ipAddress)
- isIpAddressSpecified
  
  public boolean isIpAddressSpecified()
- unsetIpAddress
  
  public void unsetIpAddress()
- getQueryTypeId
  
  public Long getQueryTypeId()
- setQueryTypeId
  
  public void setQueryTypeId(Long queryTypeId)
- isQueryTypeIdSpecified
  
  public boolean isQueryTypeIdSpecified()
- unsetQueryTypeId
  
  public void unsetQueryTypeId()
- getResponseActionId
  
  public Long getResponseActionId()
- setResponseActionId
  
  public void setResponseActionId(Long responseActionId)
- isResponseActionIdSpecified
  
  public boolean isResponseActionIdSpecified()
- unsetResponseActionId
  
  public void unsetResponseActionId()
- getStatus
  
  public String getStatus()
- setStatus
  
  public void setStatus(String status)
- isStatusSpecified
  
  public boolean isStatusSpecified()
- unsetStatus
  
  public void unsetStatus()
- getWaitCycles
  
  public Long getWaitCycles()
- setWaitCycles
  
  public void setWaitCycles(Long waitCycles)
- isWaitCyclesSpecified
  
  public boolean isWaitCyclesSpecified()
- unsetWaitCycles
  
  public void unsetWaitCycles()
- asService
  
  public Host.Service asService(ApiClient client)
- service
  
  public static Host.Service service(ApiClient client)
- service
  
  public static Host.Service service(ApiClient client, Long id)

Class Host

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