Class: PlatformAPI::Dyno

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

Dynos encapsulate running processes of an app on Heroku. Detailed information about dyno sizes can be found at: https://devcenter.heroku.com/articles/dyno-types.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Dyno

Returns a new instance of Dyno.



1341
1342
1343
 
# File 'lib/platform-api/client.rb', line 1341

def initialize(client)
  @client = client
end

Instance Method Details

#create(app_id_or_app_name, body = {}) ⇒ Object

Create a new dyno.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • body: —

    the object to pass as the request payload



1349
1350
1351
 
# File 'lib/platform-api/client.rb', line 1349

def create(app_id_or_app_name, body = {})
  @client.dyno.create(app_id_or_app_name, body)
end

#info(app_id_or_app_name, dyno_id_or_dyno_name) ⇒ Object

Info for existing dyno.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • dyno_id_or_dyno_name: —

    unique identifier of this dyno or the name of this process on this dyno



1380
1381
1382
 
# File 'lib/platform-api/client.rb', line 1380

def info(app_id_or_app_name, dyno_id_or_dyno_name)
  @client.dyno.info(app_id_or_app_name, dyno_id_or_dyno_name)
end

#list(app_id_or_app_name) ⇒ Object

List existing dynos.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



1387
1388
1389
 
# File 'lib/platform-api/client.rb', line 1387

def list(app_id_or_app_name)
  @client.dyno.list(app_id_or_app_name)
end

#restart(app_id_or_app_name, dyno_id_or_dyno_name) ⇒ Object

Restart dyno.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • dyno_id_or_dyno_name: —

    unique identifier of this dyno or the name of this process on this dyno



1357
1358
1359
 
# File 'lib/platform-api/client.rb', line 1357

def restart(app_id_or_app_name, dyno_id_or_dyno_name)
  @client.dyno.restart(app_id_or_app_name, dyno_id_or_dyno_name)
end

#restart_all(app_id_or_app_name) ⇒ Object

Restart all dynos.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app



1364
1365
1366
 
# File 'lib/platform-api/client.rb', line 1364

def restart_all(app_id_or_app_name)
  @client.dyno.restart_all(app_id_or_app_name)
end

#stop(app_id_or_app_name, dyno_id_or_dyno_name) ⇒ Object

Stop dyno.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • dyno_id_or_dyno_name: —

    unique identifier of this dyno or the name of this process on this dyno



1372
1373
1374
 
# File 'lib/platform-api/client.rb', line 1372

def stop(app_id_or_app_name, dyno_id_or_dyno_name)
  @client.dyno.stop(app_id_or_app_name, dyno_id_or_dyno_name)
end