Hexoku.API.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 currently released on an app.
Attributes
- id
- unique identifier of item generated by Heroku
- command
- command to use to launch this process
- quantity
- number of processes to maintain
- size
- dyno size (default: "1X")
- type
- type of process to maintain
- created_at
- when item was created
- updated_at
- when item was last modified
For more info read the Heroku API Reference
Summary
| batch_update(client, app, updates) | Batch update process types |
| info(client, app, formation) | Info for a process type |
| list(client, app) | List process type formation |
| update(client, app, formation, quantity, size \\ "1X") | TODO: Write This Doc |
Functions
Specs:
Batch update process types.
Examples
client |> Hexoku.API.Formation.batch_update("myapp", [
%{process: "web", quantity: 4, size: "2X"},
%{process: "worker", quantity: 1, size: "1X"}
])Specs:
- info(Hexoku.Client.t, binary, binary) :: Map.t
Info for a process type.
Examples
client |> Hexoku.API.Formation.info("myapp", "web")Specs:
- list(Hexoku.Client.t, binary) :: [Map.t]
List process type formation.
Examples
client |> Hexoku.API.Formation.TODO("myapp")