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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 216

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_sidString

Returns The account_sid.

Returns:

  • (String)

    The account_sid



258
259
260
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 258

def 
  @properties['account_sid']
end

#alert_textString

Returns The alert_text.

Returns:

  • (String)

    The alert_text



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

def alert_text
  @properties['alert_text']
end

#api_versionString

Returns The api_version.

Returns:

  • (String)

    The api_version



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

def api_version
  @properties['api_version']
end

#contextAlertContext

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

Returns:



249
250
251
252
253
254
# File 'lib/twilio-ruby/rest/monitor/v1/alert.rb', line 249

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

#date_createdTime

Returns The date_created.

Returns:

  • (Time)

    The date_created



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

def date_created
  @properties['date_created']
end

#date_generatedTime

Returns The date_generated.

Returns:

  • (Time)

    The date_generated



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

def date_generated
  @properties['date_generated']
end

#date_updatedTime

Returns The date_updated.

Returns:

  • (Time)

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Deletes the AlertInstance

Returns:

  • (Boolean)

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#error_codeString

Returns The error_code.

Returns:

  • (String)

    The error_code



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

def error_code
  @properties['error_code']
end

#fetchAlertInstance

Fetch a AlertInstance

Returns:



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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



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

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

#log_levelString

Returns The log_level.

Returns:

  • (String)

    The log_level



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

def log_level
  @properties['log_level']
end

#more_infoString

Returns The more_info.

Returns:

  • (String)

    The more_info



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

def more_info
  @properties['more_info']
end

#request_methodString

Returns The request_method.

Returns:

  • (String)

    The request_method



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

def request_method
  @properties['request_method']
end

#request_urlString

Returns The request_url.

Returns:

  • (String)

    The request_url



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

def request_url
  @properties['request_url']
end

#request_variablesString

Returns The request_variables.

Returns:

  • (String)

    The request_variables



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

def request_variables
  @properties['request_variables']
end

#resource_sidString

Returns The resource_sid.

Returns:

  • (String)

    The resource_sid



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

def resource_sid
  @properties['resource_sid']
end

#response_bodyString

Returns The response_body.

Returns:

  • (String)

    The response_body



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

def response_body
  @properties['response_body']
end

#response_headersString

Returns The response_headers.

Returns:

  • (String)

    The response_headers



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

def response_headers
  @properties['response_headers']
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid



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

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation



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

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

#urlString

Returns The url.

Returns:

  • (String)

    The url



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

def url
  @properties['url']
end