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

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

Overview

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

Defined Under Namespace

Classes: DeploymentContext, DeploymentInstance, DeploymentList, DeploymentPage, LogContext, LogInstance, LogList, LogPage, VariableContext, VariableInstance, VariableList, VariablePage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ EnvironmentContext

Initialize the EnvironmentContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the Service to fetch the Environment resource from.

  • sid (String) —

    The SID of the Environment resource to fetch.


175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 175

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

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

  # Dependents
  @variables = nil
  @deployments = nil
  @logs = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the EnvironmentInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


205
206
207
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 205

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

#deployments(sid = :unset) ⇒ DeploymentList, DeploymentContext

Access the deployments

Returns:

Raises:

  • (ArgumentError) 

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

def deployments(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return DeploymentContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
  end

  unless @deployments
    @deployments = DeploymentList.new(
        @version,
        service_sid: @solution[:service_sid],
        environment_sid: @solution[:sid],
    )
  end

  @deployments
end

#fetch ⇒ EnvironmentInstance

Fetch the EnvironmentInstance

Returns:


191
192
193
194
195
196
197
198
199
200
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 191

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation


284
285
286
287
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 284

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

#logs(sid = :unset) ⇒ LogList, LogContext

Access the logs

Returns:

Raises:

  • (ArgumentError) 

257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 257

def logs(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return LogContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
  end

  unless @logs
    @logs = LogList.new(
        @version,
        service_sid: @solution[:service_sid],
        environment_sid: @solution[:sid],
    )
  end

  @logs
end

#to_s ⇒ Object

Provide a user friendly representation


277
278
279
280
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 277

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

#variables(sid = :unset) ⇒ VariableList, VariableContext

Access the variables

Returns:

Raises:

  • (ArgumentError) 

213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 213

def variables(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return VariableContext.new(@version, @solution[:service_sid], @solution[:sid], sid, )
  end

  unless @variables
    @variables = VariableList.new(
        @version,
        service_sid: @solution[:service_sid],
        environment_sid: @solution[:sid],
    )
  end

  @variables
end