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

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, environment_sid, sid) ⇒ VariableContext

Initialize the VariableContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The unique SID identifier of the Service for this Variable.

  • environment_sid (String) —

    The unique SID identifier of the Environment in which this Variable exists.

  • sid (String) —

    The unique SID identifier of this Variable.



196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 196

def initialize(version, service_sid, environment_sid, sid)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, environment_sid: environment_sid, sid: sid, }
  @uri = "/Services/#{@solution[:service_sid]}/Environments/#{@solution[:environment_sid]}/Variables/#{@solution[:sid]}"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the VariableInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ VariableInstance

Fetch a VariableInstance

Returns:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 207

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  VariableInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      environment_sid: @solution[:environment_sid],
      sid: @solution[:sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Serverless.V1.VariableContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



259
260
261
262
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 259

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Serverless.V1.VariableContext #{context}>"
end

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

Update the VariableInstance

Parameters:

  • key (String) (defaults to: :unset) —

    A string by which this Variable can be referenced, fewer than 128 characters. Optional.

  • value (String) (defaults to: :unset) —

    A string that contains the actual value of this Variable, less than 450 bytes. Optional.

Returns:



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 232

def update(key: :unset, value: :unset)
  data = Twilio::Values.of({'Key' => key, 'Value' => value, })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  VariableInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      environment_sid: @solution[:environment_sid],
      sid: @solution[:sid],
  )
end