com.twilio.sdk.resource.instance.monitor

Class Alert

java.lang.Object

com.twilio.sdk.resource.Resource<C>

com.twilio.sdk.resource.InstanceResource<C>

com.twilio.sdk.resource.NextGenInstanceResource<TwilioMonitorClient>

com.twilio.sdk.resource.instance.monitor.Alert

public class Alert
extends NextGenInstanceResource<TwilioMonitorClient>

The Class Notification. For more information see https://www.twilio.com/docs/api/rest/monitor-alerts

Constructor Summary

Constructors

Constructor and Description
Alert(TwilioMonitorClient client) Instantiates a new Alert resource.
Alert(TwilioMonitorClient client, Map<String,Object> properties) Instantiates a new Alert resource with properties returned from the Twilio API.
Alert(TwilioMonitorClient client, String sid) Instantiates a new Alert resource.

Method Summary

Modifier and Type	Method and Description
boolean	delete() Delete this Alert from your Twilio account's logs.
String	getAccountSid() Gets the account sid.
String	getAlertText() The text of the alert.
String	getApiVersion() The version of the Twilio API in use when this alert was generated.
Calendar	getDateCreated() The date that this resource was created.
Calendar	getDateGenerated() The date the alert was actually generated.
Calendar	getDateUpdated() The date this alert was last updated.
String	getErrorCode() A unique error code for the error condition.
String	getLogLevel() The type of alert.
String	getMoreInfo() A URL for more information about the error condition.
String	getRequestMethod() If the Alert was generated by a request Twilio made to your server, this will be the request method used when Twilio made the request to your server.
String	getRequestUrl() If the Alert was generated by a request Twilio made to your server, this will be the URL on your server that generated the alert.
String	getRequestVariables() Only available in the Alert instance resource.
String	getResourceSid() The unique ID of the resource for which the Alert was generated.
String	getResponseBody() Only available in the Alert instance resource.
String	getResponseHeaders() Only available in the Alert instance resource.
String	getSid() Unique ID for this Alert.
String	getUrl() URL of this Alert in the Twilio REST API.

Methods inherited from class com.twilio.sdk.resource.InstanceResource

getObject, getProperty, update, update

Methods inherited from class com.twilio.sdk.resource.Resource

setRequestAccountSid

Methods inherited from class java.lang.Object

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

Constructor Detail

Alert

public Alert(TwilioMonitorClient client)

Instantiates a new Alert resource.

Parameters:

client - the client

Alert

public Alert(TwilioMonitorClient client,
             String sid)

Instantiates a new Alert resource.

Parameters:

client - the client

sid - the sid

Alert

public Alert(TwilioMonitorClient client,
             Map<String,Object> properties)

Instantiates a new Alert resource with properties returned from the Twilio API.

Parameters:

client - the client

properties - the properties

Method Detail

getSid

public String getSid()

Unique ID for this Alert.

Returns:

Alert sid.

getUrl

public String getUrl()

URL of this Alert in the Twilio REST API.

Returns:

resource URL

getDateCreated

public Calendar getDateCreated()

The date that this resource was created.

Returns:

Calendar representing resource creation time

getDateGenerated

public Calendar getDateGenerated()

The date the alert was actually generated. Due to buffering, this may be slightly different than the DateCreated date.

Returns:

Calendar representing the time this Alert was generated

getDateUpdated

public Calendar getDateUpdated()

The date this alert was last updated.

Returns:

Calendar representing last update time

getAccountSid

public String getAccountSid()

Gets the account sid.

Returns:

the account sid

getResourceSid

public String getResourceSid()

The unique ID of the resource for which the Alert was generated. For instance, if your server failed to respond to an HTTP request during the flow of a particular call, this will be the ID for the call that failed. Null if the Alert was generated without respect to a particular resource.

Returns:

ID of the resource related to this Alert, or null

getApiVersion

public String getApiVersion()

The version of the Twilio API in use when this alert was generated. May be null for events that don't have a specific API version.

Returns:

Twilio API version string, or null

getLogLevel

public String getLogLevel()

The type of alert. One of "error", "warning", "notice", or "debug".

Returns:

Log level string

getErrorCode

public String getErrorCode()

A unique error code for the error condition. See twilio.com/docs/errors for a reference.

Returns:

Twilio error identifier

getMoreInfo

public String getMoreInfo()

A URL for more information about the error condition.

Returns:

Error info URL

getAlertText

public String getAlertText()

The text of the alert.

Returns:

Alert description

getRequestUrl

public String getRequestUrl()

If the Alert was generated by a request Twilio made to your server, this will be the URL on your server that generated the alert. If the Alert was generated by a request from your application to Twilio's API, this will be the URL of the resource in Twilio's API.

Returns:

URL of the failed request, or null

getRequestMethod

public String getRequestMethod()

If the Alert was generated by a request Twilio made to your server, this will be the request method used when Twilio made the request to your server. If the Alert was generated by a request from your application to Twilio's API, this will be the request method your application used in the request to the API.

Returns:

HTTP request method

getRequestVariables

public String getRequestVariables()

Only available in the Alert instance resource. If the Alert was generated by a request Twilio made to your server, this will be the Twilio-generated HTTP GET or POST variables sent to your server. If the Alert was generated by a request from your application to Twilio's API, this will be the HTTP POST or PUT variables your application sent to the REST API.

Returns:

Request variable string, or null

getResponseHeaders

public String getResponseHeaders()

Only available in the Alert instance resource. If the Alert was generated by a request Twilio made to your server, this will be the HTTP headers returned by your server. Null otherwise.

Returns:

Response headers from your application to Twilio, or null.

getResponseBody

public String getResponseBody()

Only available in the Alert instance resource. If the Alert was generated by a request Twilio made to your server, this will be the HTTP body returned by your server. Null otherwise.

Returns:

Your application's response to a Twilio request, or null.

delete

public boolean delete()
               throws TwilioRestException

Delete this Alert from your Twilio account's logs.

Returns:

true, if successful

Throws:

TwilioRestException - the twilio rest exception