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: devcenter.heroku.com/articles/dyno-types.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Dyno

Returns a new instance of Dyno.



1726
1727
1728
# File 'lib/platform-api/client.rb', line 1726

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



1734
1735
1736
# File 'lib/platform-api/client.rb', line 1734

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



1765
1766
1767
# File 'lib/platform-api/client.rb', line 1765

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



1772
1773
1774
# File 'lib/platform-api/client.rb', line 1772

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



1742
1743
1744
# File 'lib/platform-api/client.rb', line 1742

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



1749
1750
1751
# File 'lib/platform-api/client.rb', line 1749

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



1757
1758
1759
# File 'lib/platform-api/client.rb', line 1757

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