Class: Twilio::REST::Monitor::V1::EventInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/monitor/v1/event.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ EventInstance

Initialize the EventInstance

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 Event resource to fetch.


255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 255

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'actor_sid' => payload['actor_sid'],
      'actor_type' => payload['actor_type'],
      'description' => payload['description'],
      'event_data' => payload['event_data'],
      'event_date' => Twilio.deserialize_iso8601_datetime(payload['event_date']),
      'event_type' => payload['event_type'],
      'resource_sid' => payload['resource_sid'],
      'resource_type' => payload['resource_type'],
      'sid' => payload['sid'],
      'source' => payload['source'],
      'source_ip_address' => payload['source_ip_address'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#actor_sidString

Returns The SID of the actor that caused the event, if available.

Returns:

  • (String)

    The SID of the actor that caused the event, if available


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

def actor_sid
  @properties['actor_sid']
end

#actor_typeString

Returns The type of actor that caused the event.

Returns:

  • (String)

    The type of actor that caused the event


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

def actor_type
  @properties['actor_type']
end

#contextEventContext

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

Returns:


285
286
287
288
289
290
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 285

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

#descriptionString

Returns A description of the event.

Returns:

  • (String)

    A description of the event


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

def description
  @properties['description']
end

#event_dataHash

Returns A JSON string that represents an object with additional data about the event.

Returns:

  • (Hash)

    A JSON string that represents an object with additional data about the event


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

def event_data
  @properties['event_data']
end

#event_dateTime

Returns The ISO 8601 date and time in GMT when the event was recorded.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the event was recorded


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

def event_date
  @properties['event_date']
end

#event_typeString

Returns The event's type.

Returns:

  • (String)

    The event's type


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

def event_type
  @properties['event_type']
end

#fetchEventInstance

Fetch the EventInstance

Returns:


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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


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

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

Returns The absolute URLs of related resources.

Returns:

  • (String)

    The absolute URLs of related resources


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

def links
  @properties['links']
end

#resource_sidString

Returns The SID of the resource that was affected.

Returns:

  • (String)

    The SID of the resource that was affected


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

def resource_sid
  @properties['resource_sid']
end

#resource_typeString

Returns The type of resource that was affected.

Returns:

  • (String)

    The type of resource that was affected


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

def resource_type
  @properties['resource_type']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#sourceString

Returns The originating system or interface that caused the event.

Returns:

  • (String)

    The originating system or interface that caused the event


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

def source
  @properties['source']
end

#source_ip_addressString

Returns The IP address of the source.

Returns:

  • (String)

    The IP address of the source


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

def source_ip_address
  @properties['source_ip_address']
end

#to_sObject

Provide a user friendly representation


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

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

#urlString

Returns The absolute URL of the resource that was affected.

Returns:

  • (String)

    The absolute URL of the resource that was affected


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

def url
  @properties['url']
end