com.jakewharton.pingdom.services
Class SettingsService.ModifyBuilder

java.lang.Object
  com.jakewharton.apibuilder.ApiBuilder
      com.jakewharton.pingdom.PingdomApiBuilder<Message>
          com.jakewharton.pingdom.services.SettingsService.ModifyBuilder

Enclosing class:

SettingsService

public static final class SettingsService.ModifyBuilder
extends PingdomApiBuilder<Message>

Request builder for SettingsService.modify().

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

SettingsService.ModifyBuilder	address(String address) Address line 1.
SettingsService.ModifyBuilder	address2(String address2) Address line 2.
SettingsService.ModifyBuilder	autoLogout(boolean autoLogout) Enable auto-logout.
SettingsService.ModifyBuilder	cellCountryCode(String cellCountryCode) Cellphone country code.
SettingsService.ModifyBuilder	cellCountryIso(String cellCountryIso) Cellphone country ISO code.
SettingsService.ModifyBuilder	cellPhone(String cellPhone) Cellphone (without country code).
SettingsService.ModifyBuilder	company(String company) Company.
SettingsService.ModifyBuilder	dateTimeFormatId(int dateTimeFormatId) Date/time format identifier.
SettingsService.ModifyBuilder	email(String email) Email.
SettingsService.ModifyBuilder	firstName(String firstName) First name.
SettingsService.ModifyBuilder	lastName(String lastName) Last name.
SettingsService.ModifyBuilder	location(String location) City / location.
SettingsService.ModifyBuilder	numberFormatId(int numberFormatId) Number format identifier.
SettingsService.ModifyBuilder	phone(String phone) Phone (without country code).
SettingsService.ModifyBuilder	phoneCountryCode(String phoneCountryCode) Phone country code.
SettingsService.ModifyBuilder	phoneCountryIso(String phoneCountryIso) Phone country ISO code.
SettingsService.ModifyBuilder	publicReportBackgroundColor(String publicReportBackgroundColor) Public reports, background color.
SettingsService.ModifyBuilder	publicReportCustomDesign(boolean publicReportCustomDesign) Use custom design for public reports.
SettingsService.ModifyBuilder	publicReportCustomDomain(String publicReportsCustomDomain) Public reports, custom domain.
SettingsService.ModifyBuilder	publicReportLogoUrl(String publicReportLogoUrl) Public reports, URL to custom logotype.
SettingsService.ModifyBuilder	publicReportMonths(PublicReportMonths publicReportsMonths) Public reports, number of months to show.
SettingsService.ModifyBuilder	publicReportShowOverview(boolean publicReportsShowOverview) Public reports, enable overview.
SettingsService.ModifyBuilder	publicReportTextColor(String publicReportTextColor) Public reports, custom text color.
SettingsService.ModifyBuilder	regionId(int regionId) Region identifier.
SettingsService.ModifyBuilder	state(String state) State, province, or equivalent.
SettingsService.ModifyBuilder	timeZoneId(int timeZoneId) Time zone identifier.
SettingsService.ModifyBuilder	zip(String zip) Zip, postal code, or equivalent.

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

firstName

public SettingsService.ModifyBuilder firstName(String firstName)

First name.

Parameters:

firstName - Value.

Returns:

Builder instance.

lastName

public SettingsService.ModifyBuilder lastName(String lastName)

Last name.

Parameters:

lastName - Value.

Returns:

Builder instance.

company

public SettingsService.ModifyBuilder company(String company)

Company.

Parameters:

company - Value.

Returns:

Builder instance.

email

public SettingsService.ModifyBuilder email(String email)

Email.

NOTE: Your email is used for authentication purposes such as using this API or logging into the Pingdom Panel.

Parameters:

email - Value.

Returns:

Builder instance.

cellPhone

public SettingsService.ModifyBuilder cellPhone(String cellPhone)

Cellphone (without country code).

(Requires cellCountryCode(String) and cellCountryIso(String))

Parameters:

cellPhone - Value.

Returns:

Builder instance.

cellCountryCode

public SettingsService.ModifyBuilder cellCountryCode(String cellCountryCode)

Cellphone country code.

Parameters:

cellCountryCode - Value (example: 1 (USA) or 46 (Sweden)).

Returns:

Builder instance.

cellCountryIso

public SettingsService.ModifyBuilder cellCountryIso(String cellCountryIso)

Cellphone country ISO code.

Parameters:

cellCountryIso - Value (example: US (USA) or SE (Sweden)).

Returns:

Builder instance.

phone

public SettingsService.ModifyBuilder phone(String phone)

Phone (without country code).

(Requires phoneCountryCode(String) and phoneCountryIso(String))

Parameters:

phone - Value.

Returns:

Builder instance.

phoneCountryCode

public SettingsService.ModifyBuilder phoneCountryCode(String phoneCountryCode)

Phone country code.

Parameters:

phoneCountryCode - Value (example: 1 (USA) or 46 (Sweden)).

Returns:

Builder instance.

phoneCountryIso

public SettingsService.ModifyBuilder phoneCountryIso(String phoneCountryIso)

Phone country ISO code.

Parameters:

phoneCountryIso - Value (example: US (USA) or SE (Sweden)).

Returns:

Builder instance.

address

public SettingsService.ModifyBuilder address(String address)

Address line 1.

Parameters:

address - Value.

Returns:

Builder instance.

address2

public SettingsService.ModifyBuilder address2(String address2)

Address line 2.

Parameters:

address2 - Value.

Returns:

Builder instance.

zip

public SettingsService.ModifyBuilder zip(String zip)

Zip, postal code, or equivalent.

Parameters:

zip - Value.

Returns:

Builder instance.

location

public SettingsService.ModifyBuilder location(String location)

City / location.

Parameters:

location - Value.

Returns:

Builder instance.

state

public SettingsService.ModifyBuilder state(String state)

State, province, or equivalent.

Parameters:

state - Value.

Returns:

Builder instance.

autoLogout

public SettingsService.ModifyBuilder autoLogout(boolean autoLogout)

Enable auto-logout.

Parameters:

autoLogout - Value.

Returns:

Builder instance.

regionId

public SettingsService.ModifyBuilder regionId(int regionId)

Region identifier.

Parameters:

regionId - Value.

Returns:

Builder instance.

See Also:

Reference.getRegions()

timeZoneId

public SettingsService.ModifyBuilder timeZoneId(int timeZoneId)

Time zone identifier.

Parameters:

timeZoneId - Value.

Returns:

Builder instance.

See Also:

Reference.getTimeZones()

dateTimeFormatId

public SettingsService.ModifyBuilder dateTimeFormatId(int dateTimeFormatId)

Date/time format identifier.

Parameters:

dateTimeFormatId - Value.

Returns:

Builder instance.

See Also:

Reference.getDateTimeFormats()

numberFormatId

public SettingsService.ModifyBuilder numberFormatId(int numberFormatId)

Number format identifier.

Parameters:

numberFormatId - Value.

Returns:

Builder instance.

See Also:

Reference.getNumberFormats()

publicReportCustomDesign

public SettingsService.ModifyBuilder publicReportCustomDesign(boolean publicReportCustomDesign)

Use custom design for public reports.

Parameters:

publicReportCustomDesign - Value.

Returns:

Builder instance.

publicReportTextColor

public SettingsService.ModifyBuilder publicReportTextColor(String publicReportTextColor)

Public reports, custom text color.

Parameters:

publicReportTextColor - Value (example: FEFFFE or 99CC00).

Returns:

Builder instance.

publicReportBackgroundColor

public SettingsService.ModifyBuilder publicReportBackgroundColor(String publicReportBackgroundColor)

Public reports, background color.

Parameters:

publicReportBackgroundColor - Value (example: FEFFFE or 99CC00).

Returns:

Builder instance.

publicReportLogoUrl

public SettingsService.ModifyBuilder publicReportLogoUrl(String publicReportLogoUrl)

Public reports, URL to custom logotype.

Parameters:

publicReportLogoUrl - Value (example: stats.pingdom.com/images/logo.png).

Returns:

Builder instance.

publicReportMonths

public SettingsService.ModifyBuilder publicReportMonths(PublicReportMonths publicReportsMonths)

Public reports, number of months to show.

Parameters:

publicReportsMonths - Value (none, all, 3).

Returns:

Builder instance.

publicReportShowOverview

public SettingsService.ModifyBuilder publicReportShowOverview(boolean publicReportsShowOverview)

Public reports, enable overview.

Parameters:

publicReportsShowOverview - Value.

Returns:

Builder instance.

publicReportCustomDomain

public SettingsService.ModifyBuilder publicReportCustomDomain(String publicReportsCustomDomain)

Public reports, custom domain.

Must be a DNS CNAME with target stats.pingdom.com.

Parameters:

publicReportsCustomDomain - Value.

Returns:

Builder instance.