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



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

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'],
      'resource_sid' => payload['resource_sid'],
      'sid' => payload['sid'],
      'url' => payload['url'],
      'request_variables' => payload['request_variables'],
      'response_body' => payload['response_body'],
      'response_headers' => payload['response_headers'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#alert_text ⇒ String

Returns The alert_text.

Returns:

  • (String) —

    The alert_text



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.

Returns:

  • (String) —

    The 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:



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

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

Returns:

  • (Time) —

    The date_generated



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

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the AlertInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#error_code ⇒ String

Returns The error_code.

Returns:

  • (String) —

    The error_code



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

def error_code
  @properties['error_code']
end

#fetch ⇒ AlertInstance

Fetch a AlertInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

Returns:

  • (String) —

    The more_info



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

def more_info
  @properties['more_info']
end

#request_method ⇒ String

Returns The request_method.

Returns:

  • (String) —

    The request_method



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

Returns:

  • (String) —

    The request_url



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

Returns:

  • (String) —

    The request_variables



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

Returns:

  • (String) —

    The resource_sid



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.

Returns:

  • (String) —

    The response_body



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.

Returns:

  • (String) —

    The response_headers



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

def response_headers
  @properties['response_headers']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end