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

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

    The SID of the Alert resource to fetch.



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

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 that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#alert_text ⇒ String

Returns The text of the alert.

Returns:

  • (String) —

    The text of the alert



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

def alert_text
  @properties['alert_text']
end

#api_version ⇒ String

Returns The API version used when the alert was generated.

Returns:

  • (String) —

    The API version used when the alert was generated



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

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:



268
269
270
271
272
273
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 268

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_generated ⇒ Time

Returns The date and time when the alert was generated specified in ISO 8601 format.

Returns:

  • (Time) —

    The date and time when the alert was generated specified in ISO 8601 format



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

def date_generated
  @properties['date_generated']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#error_code ⇒ String

Returns The error code for the condition that generated the alert.

Returns:

  • (String) —

    The error code for the condition that generated the alert



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

def error_code
  @properties['error_code']
end

#fetch ⇒ AlertInstance

Fetch a AlertInstance

Returns:



392
393
394
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 392

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#log_level ⇒ String

Returns The log level.

Returns:

  • (String) —

    The log level



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

def log_level
  @properties['log_level']
end

#more_info ⇒ String

Returns The URL of the page in our Error Dictionary with more information about the error condition.

Returns:

  • (String) —

    The URL of the page in our Error Dictionary with more information about the error condition



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

def more_info
  @properties['more_info']
end

#request_headers ⇒ String

Returns The request headers of the request that generated the alert.

Returns:

  • (String) —

    The request headers of the request that generated the alert



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

def request_headers
  @properties['request_headers']
end

#request_method ⇒ String

Returns The method used by the request that generated the alert.

Returns:

  • (String) —

    The method used by the request that generated the alert



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

def request_method
  @properties['request_method']
end

#request_url ⇒ String

Returns The URL of the request that generated the alert.

Returns:

  • (String) —

    The URL of the request that generated the alert



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

def request_url
  @properties['request_url']
end

#request_variables ⇒ String

Returns The variables passed in the request that generated the alert.

Returns:

  • (String) —

    The variables passed in the request that generated the alert



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

def request_variables
  @properties['request_variables']
end

#resource_sid ⇒ String

Returns The SID of the resource for which the alert was generated.

Returns:

  • (String) —

    The SID of the resource for which the alert was generated



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

def resource_sid
  @properties['resource_sid']
end

#response_body ⇒ String

Returns The response body of the request that generated the alert.

Returns:

  • (String) —

    The response body of the request that generated the alert



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

def response_body
  @properties['response_body']
end

#response_headers ⇒ String

Returns The response headers of the request that generated the alert.

Returns:

  • (String) —

    The response headers of the request that generated the alert



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

def response_headers
  @properties['response_headers']
end

#service_sid ⇒ String

Returns The SID of the service or resource that generated the alert.

Returns:

  • (String) —

    The SID of the service or resource that generated the alert



385
386
387
 
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 385

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def url
  @properties['url']
end