com.jakewharton.pingdom.services
Class ResultsService.GetBuilder

java.lang.Object
  com.jakewharton.apibuilder.ApiBuilder
      com.jakewharton.pingdom.PingdomApiBuilder<RawResults>
          com.jakewharton.pingdom.services.ResultsService.GetBuilder

Enclosing class:

ResultsService

public static final class ResultsService.GetBuilder
extends PingdomApiBuilder<RawResults>

Request builder for ResultsService.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

ResultsService.GetBuilder	from(Date from) Start of period.
ResultsService.GetBuilder	includeAnalysis(boolean includeAnalysis) Attach available error analysis identifiers to corresponding results.
ResultsService.GetBuilder	limit(int limit) Number of results to show (Will be set to 100 if the provided value is greater than 100).
ResultsService.GetBuilder	offset(int offset) Number of results to skip (max value is 43200).
ResultsService.GetBuilder	probes(List<Integer> probes) Filter to only show results from a list of probes.
ResultsService.GetBuilder	status(List<StateStatus> statuses) Filter to only show results with specified statuses.
ResultsService.GetBuilder	to(Date to) End of period.

Methods inherited from class com.jakewharton.pingdom.PingdomApiBuilder

execute, 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

to

public ResultsService.GetBuilder to(Date to)

End of period.

Parameters:

to - Value.

Returns:

Builder instance.

from

public ResultsService.GetBuilder from(Date from)

Start of period.

Parameters:

from - Value.

Returns:

Builder instance.

probes

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

Filter to only show results from a list of probes.

Parameters:

probes - List of probe IDs.

Returns:

Builder instance.

status

public ResultsService.GetBuilder status(List<StateStatus> statuses)

Filter to only show results with specified statuses.

Parameters:

statuses - List of statuses.

Returns:

Builder instance.

limit

public ResultsService.GetBuilder limit(int limit)

Number of results to show (Will be set to 100 if the provided value is greater than 100).

Parameters:

limit - Value.

Returns:

Builder instance.

offset

public ResultsService.GetBuilder offset(int offset)

Number of results to skip (max value is 43200).

Parameters:

offset - Value.

Returns:

Builder instance.

includeAnalysis

public ResultsService.GetBuilder includeAnalysis(boolean includeAnalysis)

Attach available error analysis identifiers to corresponding results.

Parameters:

includeAnalysis - Value.

Returns:

Builder instance.