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



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

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

Returns:

  • (String)

    The account_sid



268
269
270
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 268

def 
  @properties['account_sid']
end

#actor_sidString

Returns The actor_sid.

Returns:

  • (String)

    The actor_sid



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

def actor_sid
  @properties['actor_sid']
end

#actor_typeString

Returns The actor_type.

Returns:

  • (String)

    The actor_type



280
281
282
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 280

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:



259
260
261
262
263
264
# File 'lib/twilio-ruby/rest/monitor/v1/event.rb', line 259

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

#descriptionString

Returns The description.

Returns:

  • (String)

    The description



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

def description
  @properties['description']
end

#event_dataHash

Returns The event_data.

Returns:

  • (Hash)

    The event_data



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

def event_data
  @properties['event_data']
end

#event_dateTime

Returns The event_date.

Returns:

  • (Time)

    The event_date



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

def event_date
  @properties['event_date']
end

#event_typeString

Returns The event_type.

Returns:

  • (String)

    The event_type



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

def event_type
  @properties['event_type']
end

#fetchEventInstance

Fetch a EventInstance

Returns:



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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



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

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

Returns The links.

Returns:

  • (String)

    The links



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

def links
  @properties['links']
end

#resource_sidString

Returns The resource_sid.

Returns:

  • (String)

    The resource_sid



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

def resource_sid
  @properties['resource_sid']
end

#resource_typeString

Returns The resource_type.

Returns:

  • (String)

    The resource_type



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

def resource_type
  @properties['resource_type']
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid



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

def sid
  @properties['sid']
end

#sourceString

Returns The source.

Returns:

  • (String)

    The source



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

def source
  @properties['source']
end

#source_ip_addressString

Returns The source_ip_address.

Returns:

  • (String)

    The source_ip_address



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

def source_ip_address
  @properties['source_ip_address']
end

#to_sObject

Provide a user friendly representation



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

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

#urlString

Returns The url.

Returns:

  • (String)

    The url



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

def url
  @properties['url']
end