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

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/serverless/v1/service.rb,
lib/twilio-ruby/rest/serverless/v1/service/asset.rb,
lib/twilio-ruby/rest/serverless/v1/service/build.rb,
lib/twilio-ruby/rest/serverless/v1/service/function.rb,
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/build/build_status.rb,
lib/twilio-ruby/rest/serverless/v1/service/asset/asset_version.rb,
lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb,
lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb,
lib/twilio-ruby/rest/serverless/v1/service/function/function_version.rb,
lib/twilio-ruby/rest/serverless/v1/service/function/function_version/function_version_content.rb

Overview

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

Defined Under Namespace

Classes: AssetContext, AssetInstance, AssetList, AssetPage, BuildContext, BuildInstance, BuildList, BuildPage, EnvironmentContext, EnvironmentInstance, EnvironmentList, EnvironmentPage, FunctionContext, FunctionInstance, FunctionList, FunctionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ServiceContext

Initialize the ServiceContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The ‘sid` or `unique_name` of the Service resource to update.



164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 164

def initialize(version, sid)
    super(version)

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

    # Dependents
    @environments = nil
    @functions = nil
    @builds = nil
    @assets = nil
end

Instance Method Details

#assets(sid = :unset) ⇒ AssetList, AssetContext

Access the assets

Returns:

Raises:

  • (ArgumentError) 


288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 288

def assets(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

    unless @assets
        @assets = AssetList.new(
            @version, service_sid: @solution[:sid], )
    end

 @assets
end

#builds(sid = :unset) ⇒ BuildList, BuildContext

Access the builds

Returns:

Raises:

  • (ArgumentError) 


269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 269

def builds(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

    unless @builds
        @builds = BuildList.new(
            @version, service_sid: @solution[:sid], )
    end

 @builds
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



180
181
182
183
184
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 180

def delete

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

#environments(sid = :unset) ⇒ EnvironmentList, EnvironmentContext

Access the environments

Returns:

Raises:

  • (ArgumentError) 


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

def environments(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

    unless @environments
        @environments = EnvironmentList.new(
            @version, service_sid: @solution[:sid], )
    end

 @environments
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



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

def fetch

    
    payload = @version.fetch('GET', @uri)
    ServiceInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#functions(sid = :unset) ⇒ FunctionList, FunctionContext

Access the functions

Returns:

Raises:

  • (ArgumentError) 


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 250

def functions(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

    unless @functions
        @functions = FunctionList.new(
            @version, service_sid: @solution[:sid], )
    end

 @functions
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



313
314
315
316
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 313

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

#to_s ⇒ Object

Provide a user friendly representation



306
307
308
309
 
# File 'lib/twilio-ruby/rest/serverless/v1/service.rb', line 306

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

#update(include_credentials: :unset, friendly_name: :unset, ui_editable: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

  • include_credentials (Boolean) (defaults to: :unset) —

    Whether to inject Account credentials into a function invocation context.

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

    A descriptive string that you create to describe the Service resource. It can be a maximum of 255 characters.

  • ui_editable (Boolean) (defaults to: :unset) —

    Whether the Service resource’s properties and subresources can be edited via the UI. The default value is ‘false`.

Returns:



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

def update(
    include_credentials: :unset, 
    friendly_name: :unset, 
    ui_editable: :unset
)

    data = Twilio::Values.of({
        'IncludeCredentials' => include_credentials,
        'FriendlyName' => friendly_name,
        'UiEditable' => ui_editable,
    })

    
    payload = @version.update('POST', @uri, data: data)
    ServiceInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end