class PlatformAPI::AddonAction
Add-on Actions are lifecycle operations for add-on provisioning and deprovisioning. They allow add-on providers to (de)provision add-ons in the background and then report back when (de)provisioning is complete.
Public Class Methods
new(client)
click to toggle source
# File lib/platform-api/client.rb, line 872 def initialize(client) @client = client end
Public Instance Methods
deprovision(addon_id_or_addon_name)
click to toggle source
Mark an add-on as deprovisioned.
@param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on
# File lib/platform-api/client.rb, line 886 def deprovision(addon_id_or_addon_name) @client.addon_action.deprovision(addon_id_or_addon_name) end
provision(addon_id_or_addon_name)
click to toggle source
Mark an add-on as provisioned for use.
@param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on
# File lib/platform-api/client.rb, line 879 def provision(addon_id_or_addon_name) @client.addon_action.provision(addon_id_or_addon_name) end