com.jakewharton.pingdom.services
Class ActionsService.GetBuilder

java.lang.Object
  com.jakewharton.apibuilder.ApiBuilder
      com.jakewharton.pingdom.PingdomApiBuilder<Actions>
          com.jakewharton.pingdom.services.ActionsService.GetBuilder

Enclosing class:

ActionsService

public static final class ActionsService.GetBuilder
extends PingdomApiBuilder<Actions>

Request builder for ActionsService.get().

Nested Class Summary

Nested classes/interfaces inherited from class com.jakewharton.pingdom.PingdomApiBuilder

PingdomApiBuilder.HttpMethod

Field Summary

Fields inherited from class com.jakewharton.apibuilder.ApiBuilder

API_URL_PLACEHOLDER_END, API_URL_PLACEHOLDER_START

Method Summary

ActionsService.GetBuilder	checkIds(List<Integer> checkIds) Limit results to actions generated from these checks.
ActionsService.GetBuilder	contactIds(List<Integer> contactIds) Limit results to actions sent to these contacts.
protected com.google.gson.JsonElement	execute() Execute the remote API method and return the JSON object result.
ActionsService.GetBuilder	from(Date from) Only include actions generated later than this timestamp.
ActionsService.GetBuilder	limit(int limit) Limits the number of returned results to the specified quantity.
ActionsService.GetBuilder	offset(int offset) Offset for listing.
ActionsService.GetBuilder	status(AlertStatus status) Limit results to actions with these statuses.
ActionsService.GetBuilder	to(Date to) Only include actions generated prior to this timestamp.
ActionsService.GetBuilder	via(AlertVia via) Limit results to actions with these mediums.

Methods inherited from class com.jakewharton.pingdom.PingdomApiBuilder

field, fire, parameter, parameter, parameter, parameter, postParameter, postParameter, postParameter, postParameter, postParameter

Methods inherited from class com.jakewharton.apibuilder.ApiBuilder

buildUrl, buildUrl, encodeUrl, field, field, field, field, field, hasField, hasParameter, parameter, parameter, parameter, parameter

Methods inherited from class java.lang.Object

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

Method Detail

execute

protected com.google.gson.JsonElement execute()

Description copied from class: PingdomApiBuilder

Execute the remote API method and return the JSON object result.

This method can be overridden to select a specific subset of the JSON object. The overriding implementation should still call 'super.execute()' and then perform the filtering from there.

Overrides:

execute in class PingdomApiBuilder<Actions>

Returns:

JSON object instance.

from

public ActionsService.GetBuilder from(Date from)

Only include actions generated later than this timestamp. (Optional)

Parameters:

from - Starting timestamp.

Returns:

Builder instance.

to

public ActionsService.GetBuilder to(Date to)

Only include actions generated prior to this timestamp. (Optional)

Parameters:

to - Ending timestamp.

Returns:

Builder instance.

limit

public ActionsService.GetBuilder limit(int limit)

Limits the number of returned results to the specified quantity. (Optional).

Parameters:

limit - Result limit.

Returns:

Builder instance.

offset

public ActionsService.GetBuilder offset(int offset)

Offset for listing. (Optional)

Parameters:

offset - Offset amount.

Returns:

Builder instance.

checkIds

public ActionsService.GetBuilder checkIds(List<Integer> checkIds)

Limit results to actions generated from these checks. (Optional)

Parameters:

checkIds - List of IDs.

Returns:

Builder instance.

contactIds

public ActionsService.GetBuilder contactIds(List<Integer> contactIds)

Limit results to actions sent to these contacts. (Optional)

Parameters:

contactIds - List of IDs.

Returns:

Builder instance.

status

public ActionsService.GetBuilder status(AlertStatus status)

Limit results to actions with these statuses. (Optional)

Parameters:

status - Status to limit with.

Returns:

Builder instance.

via

public ActionsService.GetBuilder via(AlertVia via)

Limit results to actions with these mediums. (Optional)

Parameters:

via - Via to limit with.

Returns:

Builder instance.