com.jakewharton.pingdom.services
Class CheckService

java.lang.Object
  com.jakewharton.apibuilder.ApiService
      com.jakewharton.pingdom.PingdomApiService
          com.jakewharton.pingdom.services.CheckService

public class CheckService
extends PingdomApiService

Represents Pingdom's remote check service.

Nested Class Summary

static class	CheckService.CreateBuilder Request builder for create(String, String, CheckType).
static class	CheckService.DeleteBuilder Request builder for delete(int).
static class	CheckService.GetBuilder Request builder for get(int).
static class	CheckService.ListBuilder Request builder for list().

Field Summary

Fields inherited from class com.jakewharton.apibuilder.ApiService

CONTENT_ENCODING

Constructor Summary

CheckService()

Method Summary

CheckService.CreateBuilder	create(String name, String host, CheckType type) Creates a new check with settings specified by provided parameters.
CheckService.DeleteBuilder	delete(int checkId) Deletes a check.
CheckService.GetBuilder	get(int checkId) Returns a detailed description of a specified check.
CheckService.ListBuilder	list() Returns a list overview of all checks.

Methods inherited from class com.jakewharton.pingdom.PingdomApiService

delete, get, post, put, setApiVersion, setAppKey, setAuthentication, unmarshall, unmarshall

Methods inherited from class com.jakewharton.apibuilder.ApiService

acceptGzip, addRequestHeader, closeConnection, closeStream, convertStreamToString, executeDelete, executeDelete, executeGet, executeGet, executeMethod, executePost, executePost, getConnectTimeout, getParametersString, getReadTimeout, getWrappedInputStream, removeRequestHeader, setConnectTimeout, setReadTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckService

public CheckService()

Method Detail

list

public CheckService.ListBuilder list()

Returns a list overview of all checks.

Returns:

Builder instance.

Since:

2.0

get

public CheckService.GetBuilder get(int checkId)

Returns a detailed description of a specified check.

Parameters:

checkId - Check ID.

Returns:

Builder instance.

Since:

2.0

create

public CheckService.CreateBuilder create(String name,
                                         String host,
                                         CheckType type)

Creates a new check with settings specified by provided parameters.

Parameters:

name - Check name.

host - Target host.

type - Type of check.

Returns:

Builder instance.

Since:

2.0

delete

public CheckService.DeleteBuilder delete(int checkId)

Deletes a check. THIS METHOD IS IRREVERSIBLE! You will lose all collected data. Be careful!

Parameters:

checkId - Check ID.

Returns:

Builder instance.

Since:

2.0