class PlatformAPI::Formation

The formation of processes that should be maintained for an app. Update the formation to scale processes or change dyno sizes. Available process type names and commands are defined by the `process_types` attribute for the [slug](slug) currently released on an app.

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 1915
def initialize(client)
  @client = client
end

Public Instance Methods

batch_update(app_id_or_app_name, body = {}) click to toggle source

Batch update process types

@param app_id_or_app_name: unique identifier of app or unique name of app @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 1938
def batch_update(app_id_or_app_name, body = {})
  @client.formation.batch_update(app_id_or_app_name, body)
end
info(app_id_or_app_name, formation_id_or_formation_type) click to toggle source

Info for a process type

@param app_id_or_app_name: unique identifier of app or unique name of app @param formation_id_or_formation_type: unique identifier of this process type or type of process to maintain

# File lib/platform-api/client.rb, line 1923
def info(app_id_or_app_name, formation_id_or_formation_type)
  @client.formation.info(app_id_or_app_name, formation_id_or_formation_type)
end
list(app_id_or_app_name) click to toggle source

List process type formation

@param app_id_or_app_name: unique identifier of app or unique name of app

# File lib/platform-api/client.rb, line 1930
def list(app_id_or_app_name)
  @client.formation.list(app_id_or_app_name)
end
update(app_id_or_app_name, formation_id_or_formation_type, body = {}) click to toggle source

Update process type

@param app_id_or_app_name: unique identifier of app or unique name of app @param formation_id_or_formation_type: unique identifier of this process type or type of process to maintain @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 1947
def update(app_id_or_app_name, formation_id_or_formation_type, body = {})
  @client.formation.update(app_id_or_app_name, formation_id_or_formation_type, body)
end