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

Class Result

java.lang.Object

com.softlayer.api.Type

com.softlayer.api.service.Entity

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

@ApiType("SoftLayer_Network_Monitor_Version1_Query_Result")
public class Result
extends Entity

The monitoring result object is used to show the status of the actions taken by the monitoring system.

In general, only the responseStatus variable is needed, as it holds the information on the status of the service.

See Also:

SoftLayer_Network_Monitor_Version1_Query_Result

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Result.Mask

Field Summary

Fields

Modifier and Type	Field	Description
protected GregorianCalendar	finishTime	The timestamp of when this monitor was co
protected boolean	finishTimeSpecified
protected Host	queryHost	References the queryHost that this response relates to.
protected Long	responseStatus	The response status for this server.
protected boolean	responseStatusSpecified
protected BigDecimal	responseTime	The length of time it took the server to respond
protected boolean	responseTimeSpecified

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor	Description
Result()

Method Summary

Modifier and Type	Method	Description
GregorianCalendar	getFinishTime()
Host	getQueryHost()
Long	getResponseStatus()
BigDecimal	getResponseTime()
boolean	isFinishTimeSpecified()
boolean	isResponseStatusSpecified()
boolean	isResponseTimeSpecified()
void	setFinishTime(GregorianCalendar finishTime)
void	setQueryHost(Host queryHost)
void	setResponseStatus(Long responseStatus)
void	setResponseTime(BigDecimal responseTime)
void	unsetFinishTime()
void	unsetResponseStatus()
void	unsetResponseTime()

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 Detail

queryHost

@ApiProperty
protected Host queryHost

References the queryHost that this response relates to.

finishTime

@ApiProperty(canBeNullOrNotSet=true)
protected GregorianCalendar finishTime

The timestamp of when this monitor was co

finishTimeSpecified

protected boolean finishTimeSpecified

responseStatus

@ApiProperty(canBeNullOrNotSet=true)
protected Long responseStatus

The response status for this server. The response status meanings are: 0: Down/Critical: Server is down and/or has passed the critical response threshold (extremely long ping response, abnormal behavior, etc.) 1: Warning - Server may be recovering from a previous down state, or may have taken too long to respond 2: Up 3: Not used 4: Unknown - An unknown error has occurred. If the problem persists, contact support. 5: Unknown - An unknown error has occurred. If the problem persists, contact support.

responseStatusSpecified

protected boolean responseStatusSpecified

responseTime

@ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal responseTime

The length of time it took the server to respond

responseTimeSpecified

protected boolean responseTimeSpecified

Constructor Detail

Result

public Result()

Method Detail

getQueryHost

public Host getQueryHost()

setQueryHost

public void setQueryHost(Host queryHost)

getFinishTime

public GregorianCalendar getFinishTime()

setFinishTime

public void setFinishTime(GregorianCalendar finishTime)

isFinishTimeSpecified

public boolean isFinishTimeSpecified()

unsetFinishTime

public void unsetFinishTime()

getResponseStatus

public Long getResponseStatus()

setResponseStatus

public void setResponseStatus(Long responseStatus)

isResponseStatusSpecified

public boolean isResponseStatusSpecified()

unsetResponseStatus

public void unsetResponseStatus()

getResponseTime

public BigDecimal getResponseTime()

setResponseTime

public void setResponseTime(BigDecimal responseTime)

isResponseTimeSpecified

public boolean isResponseTimeSpecified()

unsetResponseTime

public void unsetResponseTime()