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.



229
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
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 229

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:



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

def 
    @properties['account_sid']
end

#alert_text ⇒ String

Returns The text of the alert.

Returns:

  • (String) —

    The text of the alert.



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

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.



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

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:



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

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:



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

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`.



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

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:



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

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.



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

def error_code
    @properties['error_code']
end

#fetch ⇒ AlertInstance

Fetch the AlertInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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`.



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

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:



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

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.



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

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.



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

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.



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

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.



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

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.



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

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.



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

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.



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

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`.



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

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.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

def url
    @properties['url']
end