Class: Twilio::REST::Serverless::V1::ServiceContext::EnvironmentContext::VariableInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Serverless::V1::ServiceContext::EnvironmentContext::VariableInstance

Defined in:

lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb

Overview

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

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the Variable resource.

• #context ⇒ VariableContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

  The ISO 8601 date and time in GMT when the Variable resource was created.

• #date_updated ⇒ Time

  The ISO 8601 date and time in GMT when the Variable resource was last updated.

• #delete ⇒ Boolean

  Delete the VariableInstance.

• #environment_sid ⇒ String

  The SID of the Environment in which the Variable exists.

• #fetch ⇒ VariableInstance

  Fetch the VariableInstance.

• #initialize(version, payload, service_sid: nil, environment_sid: nil, sid: nil) ⇒ VariableInstance constructor

  Initialize the VariableInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #key ⇒ String

  A string by which the Variable resource can be referenced.

• #service_sid ⇒ String

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

• #sid ⇒ String

  The unique string that identifies the Variable resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(key: :unset, value: :unset) ⇒ VariableInstance

  Update the VariableInstance.

• #url ⇒ String

  The absolute URL of the Variable resource.

• #value ⇒ String

  A string that contains the actual value of the Variable.

Constructor Details

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

Initialize the VariableInstance

# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 268

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'environment_sid' => payload['environment_sid'],
      'key' => payload['key'],
      'value' => payload['value'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 317

def account_sid
  @properties['account_sid']
end

#context ⇒ VariableContext

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

# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 297

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

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the VariableInstance

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

def delete
  context.delete
end

#environment_sid ⇒ String

# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 329

def environment_sid
  @properties['environment_sid']
end

#fetch ⇒ VariableInstance

Fetch the VariableInstance

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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#key ⇒ String

# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 335

def key
  @properties['key']
end

#service_sid ⇒ String

# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 323

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 311

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#update(key: :unset, value: :unset) ⇒ VariableInstance

Update the VariableInstance

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

def update(key: :unset, value: :unset)
  context.update(key: key, value: value, )
end

#url ⇒ String

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

def url
  @properties['url']
end

#value ⇒ String

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

def value
  @properties['value']
end