com.jakewharton.pingdom.services
Class SummaryAverageService.GetBuilder

java.lang.Object
  com.jakewharton.apibuilder.ApiBuilder
      com.jakewharton.pingdom.PingdomApiBuilder<SummaryAverage>
          com.jakewharton.pingdom.services.SummaryAverageService.GetBuilder

Enclosing class:

SummaryAverageService

public static final class SummaryAverageService.GetBuilder
extends PingdomApiBuilder<SummaryAverage>

Request builder for SummaryAverageService.get(int).

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

SummaryAverageService.GetBuilder	byCountry(boolean byCountry) Split response times into country groups.
SummaryAverageService.GetBuilder	byProbe(boolean byProbe) Split response times into probe groups
protected com.google.gson.JsonElement	execute() Execute the remote API method and return the JSON object result.
SummaryAverageService.GetBuilder	from(Date from) Start time of period.
SummaryAverageService.GetBuilder	includeUptime(boolean includeUptime) Include uptime information.
SummaryAverageService.GetBuilder	probes(List<Integer> probes) Filter to only use results from a list of probes.
SummaryAverageService.GetBuilder	to(Date to) End time of period.

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<SummaryAverage>

Returns:

JSON object instance.

from

public SummaryAverageService.GetBuilder from(Date from)

Start time of period.

Parameters:

from - Value.

Returns:

Builder instance.

to

public SummaryAverageService.GetBuilder to(Date to)

End time of period.

Parameters:

to - Value.

Returns:

Builder instance.

probes

public SummaryAverageService.GetBuilder probes(List<Integer> probes)

Filter to only use results from a list of probes.

Parameters:

probes - List of probe IDs.

Returns:

Builder instance.

includeUptime

public SummaryAverageService.GetBuilder includeUptime(boolean includeUptime)

Include uptime information.

Parameters:

includeUptime - Value.

Returns:

Builder instance.

byCountry

public SummaryAverageService.GetBuilder byCountry(boolean byCountry)

Split response times into country groups.

Parameters:

byCountry - Value.

Returns:

Builder instance.

byProbe

public SummaryAverageService.GetBuilder byProbe(boolean byProbe)

Split response times into probe groups

Parameters:

byProbe - Value.

Returns:

Builder instance.