Class: Twilio::REST::Events::V1::SinkInstance

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

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

Initialize the SinkInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • sid (String) (defaults to: nil)

    A 34 character string that uniquely identifies this Sink.


278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 278

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

  # Marshaled Properties
  @properties = {
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'description' => payload['description'],
      'sid' => payload['sid'],
      'sink_configuration' => payload['sink_configuration'],
      'sink_type' => payload['sink_type'],
      'status' => payload['status'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#contextSinkContext

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

Returns:


303
304
305
306
307
308
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 303

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

#date_createdTime

Returns The date this Sink was created.

Returns:

  • (Time)

    The date this Sink was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date this Sink was updated.

Returns:

  • (Time)

    The date this Sink was updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the SinkInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


374
375
376
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 374

def delete
  context.delete
end

#descriptionString

Returns Sink Description.

Returns:

  • (String)

    Sink Description


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

def description
  @properties['description']
end

#fetchSinkInstance

Fetch the SinkInstance

Returns:


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

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


410
411
412
413
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 410

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

Returns Nested resource URLs.

Returns:

  • (String)

    Nested resource URLs.


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

def links
  @properties['links']
end

#sidString

Returns A string that uniquely identifies this Sink.

Returns:

  • (String)

    A string that uniquely identifies this Sink.


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

def sid
  @properties['sid']
end

#sink_configurationHash

Returns JSON Sink configuration.

Returns:

  • (Hash)

    JSON Sink configuration.


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

def sink_configuration
  @properties['sink_configuration']
end

#sink_testsink_test

Access the sink_test

Returns:


390
391
392
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 390

def sink_test
  context.sink_test
end

#sink_typesink.SinkType

Returns Sink type.

Returns:

  • (sink.SinkType)

    Sink type.


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

def sink_type
  @properties['sink_type']
end

#sink_validatesink_validate

Access the sink_validate

Returns:


397
398
399
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 397

def sink_validate
  context.sink_validate
end

#statussink.Status

Returns The Status of this Sink.

Returns:

  • (sink.Status)

    The Status of this Sink


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

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation


403
404
405
406
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 403

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

#update(description: nil) ⇒ SinkInstance

Update the SinkInstance

Parameters:

  • description (String) (defaults to: nil)

    A human readable description for the Sink **This value should not contain PII.**

Returns:


383
384
385
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 383

def update(description: nil)
  context.update(description: description, )
end

#urlString

Returns The URL of this resource.

Returns:

  • (String)

    The URL of this resource.


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

def url
  @properties['url']
end