Class: Twilio::REST::Serverless::V1::ServiceContext::EnvironmentInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/serverless/v1/service/environment.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ EnvironmentInstance

Initialize the EnvironmentInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Environment resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 305

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'build_sid' => payload['build_sid'],
        'unique_name' => payload['unique_name'],
        'domain_suffix' => payload['domain_suffix'],
        'domain_name' => payload['domain_name'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Environment resource.

Returns:



347
348
349
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 347

def 
    @properties['account_sid']
end

#build_sid ⇒ String

Returns The SID of the build deployed in the environment.

Returns:

  • (String) —

    The SID of the build deployed in the environment.



359
360
361
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 359

def build_sid
    @properties['build_sid']
end

#context ⇒ EnvironmentContext

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

Returns:



332
333
334
335
336
337
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 332

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

#date_created ⇒ Time

Returns The date and time in GMT when the Environment resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



383
384
385
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 383

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the Environment resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



389
390
391
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 389

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the EnvironmentInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



408
409
410
411
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 408

def delete

    context.delete
end

#deployments ⇒ deployments

Access the deployments

Returns:



438
439
440
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 438

def deployments
    context.deployments
end

#domain_name ⇒ String

Returns The domain name for all Functions and Assets deployed in the Environment, using the Service unique name, a randomly-generated Service suffix, and an optional Environment domain suffix.

Returns:

  • (String) —

    The domain name for all Functions and Assets deployed in the Environment, using the Service unique name, a randomly-generated Service suffix, and an optional Environment domain suffix.



377
378
379
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 377

def domain_name
    @properties['domain_name']
end

#domain_suffix ⇒ String

Returns A URL-friendly name that represents the environment and forms part of the domain name.

Returns:

  • (String) —

    A URL-friendly name that represents the environment and forms part of the domain name.



371
372
373
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 371

def domain_suffix
    @properties['domain_suffix']
end

#fetch ⇒ EnvironmentInstance

Fetch the EnvironmentInstance

Returns:



416
417
418
419
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 416

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



451
452
453
454
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 451

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

#links ⇒ Hash

Returns The URLs of the Environment resource’s nested resources.

Returns:

  • (Hash) —

    The URLs of the Environment resource’s nested resources.



401
402
403
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 401

def links
    @properties['links']
end

#logs ⇒ logs

Access the logs

Returns:



424
425
426
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 424

def logs
    context.logs
end

#service_sid ⇒ String

Returns The SID of the Service that the Environment resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the Environment resource is associated with.



353
354
355
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 353

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Environment resource.

Returns:

  • (String) —

    The unique string that we created to identify the Environment resource.



341
342
343
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 341

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



444
445
446
447
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 444

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

#unique_name ⇒ String

Returns A user-defined string that uniquely identifies the Environment resource.

Returns:

  • (String) —

    A user-defined string that uniquely identifies the Environment resource.



365
366
367
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 365

def unique_name
    @properties['unique_name']
end

#url ⇒ String

Returns The absolute URL of the Environment resource.

Returns:

  • (String) —

    The absolute URL of the Environment resource.



395
396
397
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 395

def url
    @properties['url']
end

#variables ⇒ variables

Access the variables

Returns:



431
432
433
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 431

def variables
    context.variables
end