Class: Twilio::REST::Monitor::V1::AlertInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/monitor/v1/alert.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ AlertInstance

Initialize the AlertInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Alert resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 230

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'alert_text' => payload['alert_text'],
        'api_version' => payload['api_version'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_generated' => Twilio.deserialize_iso8601_datetime(payload['date_generated']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'error_code' => payload['error_code'],
        'log_level' => payload['log_level'],
        'more_info' => payload['more_info'],
        'request_method' => payload['request_method'],
        'request_url' => payload['request_url'],
        'request_variables' => payload['request_variables'],
        'resource_sid' => payload['resource_sid'],
        'response_body' => payload['response_body'],
        'response_headers' => payload['response_headers'],
        'sid' => payload['sid'],
        'url' => payload['url'],
        'request_headers' => payload['request_headers'],
        'service_sid' => payload['service_sid'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Alert resource.

Returns:



274
275
276
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 274

def 
    @properties['account_sid']
end

#alert_text ⇒ String

Returns The text of the alert.

Returns:

  • (String) —

    The text of the alert.



280
281
282
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 280

def alert_text
    @properties['alert_text']
end

#api_version ⇒ String

Returns The API version used when the alert was generated. Can be empty for events that don’t have a specific API version.

Returns:

  • (String) —

    The API version used when the alert was generated. Can be empty for events that don’t have a specific API version.



286
287
288
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 286

def api_version
    @properties['api_version']
end

#context ⇒ AlertContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



265
266
267
268
269
270
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 265

def context
    unless @instance_context
        @instance_context = AlertContext.new(@version , @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



292
293
294
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 292

def date_created
    @properties['date_created']
end

#date_generated ⇒ Time

Returns The date and time in GMT when the alert was generated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601#UTC) format. Due to buffering, this can be different than ‘date_created`.

Returns:

  • (Time) —

    The date and time in GMT when the alert was generated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601#UTC) format. Due to buffering, this can be different than ‘date_created`.



298
299
300
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 298

def date_generated
    @properties['date_generated']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



304
305
306
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 304

def date_updated
    @properties['date_updated']
end

#error_code ⇒ String

Returns The error code for the condition that generated the alert. See the [Error Dictionary](www.twilio.com/docs/api/errors) for possible causes and solutions to the error.

Returns:

  • (String) —

    The error code for the condition that generated the alert. See the [Error Dictionary](www.twilio.com/docs/api/errors) for possible causes and solutions to the error.



310
311
312
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 310

def error_code
    @properties['error_code']
end

#fetch ⇒ AlertInstance

Fetch the AlertInstance

Returns:



389
390
391
392
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 389

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



403
404
405
406
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 403

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Monitor.V1.AlertInstance #{values}>"
end

#log_level ⇒ String

Returns The log level. Can be: ‘error`, `warning`, `notice`, or `debug`.

Returns:

  • (String) —

    The log level. Can be: ‘error`, `warning`, `notice`, or `debug`.



316
317
318
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 316

def log_level
    @properties['log_level']
end

#more_info ⇒ String

Returns The URL of the page in our [Error Dictionary](www.twilio.com/docs/api/errors) with more information about the error condition.

Returns:



322
323
324
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 322

def more_info
    @properties['more_info']
end

#request_headers ⇒ String

Returns The request headers of the request that generated the alert. This value is only returned when a single Alert resource is fetched.

Returns:

  • (String) —

    The request headers of the request that generated the alert. This value is only returned when a single Alert resource is fetched.



376
377
378
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 376

def request_headers
    @properties['request_headers']
end

#request_method ⇒ String

Returns The method used by the request that generated the alert. If the alert was generated by a request we made to your server, this is the method we used. If the alert was generated by a request from your application to our API, this is the method your application used.

Returns:

  • (String) —

    The method used by the request that generated the alert. If the alert was generated by a request we made to your server, this is the method we used. If the alert was generated by a request from your application to our API, this is the method your application used.



328
329
330
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 328

def request_method
    @properties['request_method']
end

#request_url ⇒ String

Returns The URL of the request that generated the alert. If the alert was generated by a request we made to your server, this is the URL on your server that generated the alert. If the alert was generated by a request from your application to our API, this is the URL of the resource requested.

Returns:

  • (String) —

    The URL of the request that generated the alert. If the alert was generated by a request we made to your server, this is the URL on your server that generated the alert. If the alert was generated by a request from your application to our API, this is the URL of the resource requested.



334
335
336
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 334

def request_url
    @properties['request_url']
end

#request_variables ⇒ String

Returns The variables passed in the request that generated the alert. This value is only returned when a single Alert resource is fetched.

Returns:

  • (String) —

    The variables passed in the request that generated the alert. This value is only returned when a single Alert resource is fetched.



340
341
342
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 340

def request_variables
    @properties['request_variables']
end

#resource_sid ⇒ String

Returns The SID 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 value would be the SID of the server. This value is empty if the alert was not generated for a particular resource.

Returns:

  • (String) —

    The SID 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 value would be the SID of the server. This value is empty if the alert was not generated for a particular resource.



346
347
348
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 346

def resource_sid
    @properties['resource_sid']
end

#response_body ⇒ String

Returns The response body of the request that generated the alert. This value is only returned when a single Alert resource is fetched.

Returns:

  • (String) —

    The response body of the request that generated the alert. This value is only returned when a single Alert resource is fetched.



352
353
354
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 352

def response_body
    @properties['response_body']
end

#response_headers ⇒ String

Returns The response headers of the request that generated the alert. This value is only returned when a single Alert resource is fetched.

Returns:

  • (String) —

    The response headers of the request that generated the alert. This value is only returned when a single Alert resource is fetched.



358
359
360
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 358

def response_headers
    @properties['response_headers']
end

#service_sid ⇒ String

Returns The SID of the service or resource that generated the alert. Can be ‘null`.

Returns:

  • (String) —

    The SID of the service or resource that generated the alert. Can be ‘null`.



382
383
384
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 382

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Alert resource.

Returns:

  • (String) —

    The unique string that we created to identify the Alert resource.



364
365
366
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 364

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



396
397
398
399
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 396

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Monitor.V1.AlertInstance #{values}>"
end

#url ⇒ String

Returns The absolute URL of the Alert resource.

Returns:

  • (String) —

    The absolute URL of the Alert resource.



370
371
372
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 370

def url
    @properties['url']
end