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.



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 399

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:



444
445
446
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 444

def 
    @properties['account_sid']
end

#alert_text ⇒ String

Returns The text of the alert.

Returns:

  • (String) —

    The text of the alert.



450
451
452
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 450

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.



456
457
458
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 456

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:



435
436
437
438
439
440
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 435

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:



462
463
464
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 462

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.



468
469
470
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 468

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:



474
475
476
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 474

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.



480
481
482
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 480

def error_code
    @properties['error_code']
end

#fetch ⇒ AlertInstance

Fetch the AlertInstance

Returns:



559
560
561
562
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 559

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



573
574
575
576
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 573

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.



486
487
488
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 486

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:



492
493
494
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 492

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.



546
547
548
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 546

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.



498
499
500
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 498

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.



504
505
506
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 504

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.



510
511
512
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 510

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.



516
517
518
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 516

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.



522
523
524
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 522

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.



528
529
530
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 528

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.



552
553
554
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 552

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.



534
535
536
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 534

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



566
567
568
569
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 566

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.



540
541
542
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 540

def url
    @properties['url']
end