com.jakewharton.pingdom.entities
Class Check

java.lang.Object
  extended by com.jakewharton.pingdom.entities.Check
All Implemented Interfaces:
PingdomEntity, Serializable

public final class Check
extends Object
implements PingdomEntity

Represents a Pingdom check object.

See Also:
Serialized Form

Nested Class Summary
static class Check.CheckTypeBase
          An encompassing base class which allows for the deserialization of all complex check-type objects to a single native object.
static class Check.CheckTypeWrapper
          Wrapper for CheckType which allows for deserializing either the simple string type or a more complex object representation of the type with a single class.
static class Check.DnsType
          Check.CheckTypeBase wrapper which only exposes methods appropriate for a DNS check type.
static class Check.HttpCustomType
          Check.CheckTypeBase wrapper which only exposes methods appropriate for an HTTP custom check type.
static class Check.HttpType
          Check.CheckTypeBase wrapper which only exposes methods appropriate for an HTTP check type.
static class Check.ImapType
          Check.CheckTypeBase wrapper which only exposes methods appropriate for an HTTP check type.
static class Check.PingType
          Check.CheckTypeBase wrapper which only exposes methods appropriate for a ping check type.
static class Check.Pop3Type
          Check.CheckTypeBase wrapper which only exposes methods appropriate for a POP 3 check type.
static class Check.SmtpType
          Check.CheckTypeBase wrapper which only exposes methods appropriate for an SMTP check type.
static class Check.TcpType
          Check.CheckTypeBase wrapper which only exposes methods appropriate for a TCP check type.
static class Check.UdpType
          Check.CheckTypeBase wrapper which only exposes methods appropriate for a UDP check type.
 
Constructor Summary
Check()
           
 
Method Summary
 Date getCreated()
          Creating time.
 String getHostName()
          Target host.
 Integer getId()
          Check identifier.
 Date getLastErrorTime()
          Timestamp of last error (if any).
 Date getLastResponseTime()
          Response time (in milliseconds) of last test.
 Date getLastTestTime()
          Timestamp of last test (if any).
 String getName()
          Check name.
 Integer getNotifyAgainEvery()
          Notify again every n result.
 Boolean getNotifyWhenBackUp()
          Notify when back up again.
 Integer getResolution()
          How often should the check be tested? (minutes)
 Integer getSendNotificationWhenDown()
          Send notification when down n times.
 Boolean getSendToEmail()
          Send alerts as email.
 Boolean getSendToIPhone()
          Send alerts to iPhone.
 Boolean getSendToSms()
          Send alerts as SMS.
 Boolean getSendToTwitter()
          Send alerts through Twitter.
 CheckStatus getStatus()
          Current status of check.
 Check.CheckTypeWrapper getType()
          Check type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Check

public Check()
Method Detail

getId

public Integer getId()
Check identifier.

Returns:
Value.
Since:
2.0

getName

public String getName()
Check name.

Returns:
Value.
Since:
2.0

getType

public Check.CheckTypeWrapper getType()
Check type.

Returns:
Value.
Since:
2.0

getLastErrorTime

public Date getLastErrorTime()
Timestamp of last error (if any).

Returns:
Value.
Since:
2.0

getLastTestTime

public Date getLastTestTime()
Timestamp of last test (if any).

Returns:
Value.
Since:
2.0

getLastResponseTime

public Date getLastResponseTime()
Response time (in milliseconds) of last test.

Returns:
Value.
Since:
2.0

getStatus

public CheckStatus getStatus()
Current status of check.

Returns:
Value.
Since:
2.0

getResolution

public Integer getResolution()
How often should the check be tested? (minutes)

Returns:
Value.
Since:
2.0

getHostName

public String getHostName()
Target host.

Returns:
Value.
Since:
2.0

getSendToEmail

public Boolean getSendToEmail()
Send alerts as email.

Returns:
Value.
Since:
2.0

getSendToSms

public Boolean getSendToSms()
Send alerts as SMS.

Returns:
Value.
Since:
2.0

getSendToTwitter

public Boolean getSendToTwitter()
Send alerts through Twitter.

Returns:
Value.
Since:
2.0

getSendToIPhone

public Boolean getSendToIPhone()
Send alerts to iPhone.

Returns:
Value.
Since:
2.0

getSendNotificationWhenDown

public Integer getSendNotificationWhenDown()
Send notification when down n times.

Returns:
Value.
Since:
2.0

getNotifyAgainEvery

public Integer getNotifyAgainEvery()
Notify again every n result.

Returns:
Value.
Since:
2.0

getNotifyWhenBackUp

public Boolean getNotifyWhenBackUp()
Notify when back up again.

Returns:
Value.
Since:
2.0

getCreated

public Date getCreated()
Creating time.

Returns:
Value.
Since:
2.0


Copyright © 2011 Jake Wharton. All Rights Reserved.