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 beta products that are subject to change. Use them with caution.

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 SID of the Service to fetch the Variable resource from.

  • environment_sid (String) —

    The SID of the Environment with the Variable resource to fetch.

  • sid (String) —

    The SID of the Variable resource to fetch.


189
190
191
192
193
194
195
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 189

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

Delete the VariableInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

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

#fetch ⇒ VariableInstance

Fetch the VariableInstance

Returns:


200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 200

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

  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


249
250
251
252
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 249

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

#to_s ⇒ Object

Provide a user friendly representation


242
243
244
245
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 242

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 the Variable resource can be referenced. It can be a maximum of 128 characters.

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

    A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size.

Returns:


219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 219

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