com.squareup.pagerduty.incidents

Class Trigger.Builder

java.lang.Object

com.squareup.pagerduty.incidents.Trigger.Builder

Enclosing class:

Trigger

public static final class Trigger.Builder
extends Object

Fluent interface for building trigger data.

Calling withIncidentKey(java.lang.String) is required. All other data is optional.

Constructor Summary

Constructors

Constructor and Description
Builder(String description) Build data to trigger a new incident.

Method Summary

Modifier and Type	Method and Description
Trigger.Builder	addDetails(Map<String,String> details) Arbitrary name-value pairs which will be included in incident the log.
Trigger.Builder	addDetails(String name, String value) An arbitrary name-value pair which will be included in incident the log.
Trigger	build()
Trigger.Builder	client(String client) The name of the monitoring client that is triggering this event.
Trigger.Builder	clientUrl(String clientUrl) The URL of the monitoring client that is triggering this event.
Trigger.Builder	withIncidentKey(String incidentKey) Identifies the incident to which this trigger event should be applied.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String description)

Build data to trigger a new incident.

Parameters:

description - A short description of the problem that led to this trigger. This field (or a truncated version) will be used when generating phone calls, SMS messages and alert emails. It will also appear on the incidents tables in the PagerDuty UI. The maximum length is 1024 characters.

Method Detail

withIncidentKey

public Trigger.Builder withIncidentKey(String incidentKey)

Identifies the incident to which this trigger event should be applied. If there's no open (i.e. unresolved) incident with this key, a new one will be created. If there's already an open incident with a matching key, this event will be appended to that incident's log. The event key provides an easy way to "de-dup" problem reports. If this field isn't provided, PagerDuty will automatically open a new incident with a unique key.

client

public Trigger.Builder client(String client)

The name of the monitoring client that is triggering this event.

clientUrl

public Trigger.Builder clientUrl(String clientUrl)

The URL of the monitoring client that is triggering this event.

addDetails

public Trigger.Builder addDetails(String name,
                                  String value)

An arbitrary name-value pair which will be included in incident the log.

addDetails

public Trigger.Builder addDetails(Map<String,String> details)

Arbitrary name-value pairs which will be included in incident the log.

build

public Trigger build()