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

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 update the Variable resource under.

  • environment_sid (String)

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

  • sid (String)

    The SID of the Variable resource to update.



171
172
173
174
175
176
177
178
179
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 171

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

#deleteBoolean

Delete the VariableInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



183
184
185
186
187
188
189
190
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 183

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    @version.delete('DELETE', @uri, headers: headers)
end

#fetchVariableInstance

Fetch the VariableInstance

Returns:



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

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    VariableInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        environment_sid: @solution[:environment_sid],
        sid: @solution[:sid],
    )
end

#inspectObject

Provide a detailed, user friendly representation



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

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

#to_sObject

Provide a user friendly representation



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

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:



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 218

def update(
    key: :unset, 
    value: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    VariableInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        environment_sid: @solution[:environment_sid],
        sid: @solution[:sid],
    )
end