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.



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

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



1781
1782
1783
 
# File 'lib/platform-api/client.rb', line 1781

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



1828
1829
1830
 
# File 'lib/platform-api/client.rb', line 1828

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



1835
1836
1837
 
# File 'lib/platform-api/client.rb', line 1835

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



1789
1790
1791
 
# File 'lib/platform-api/client.rb', line 1789

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



1804
1805
1806
 
# File 'lib/platform-api/client.rb', line 1804

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

#restart_formation(app_id_or_app_name, dyno_formation_type) ⇒ Object

Restart dynos of a given formation type.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • dyno_formation_type: —

    the formation type of this process on this dyno



1797
1798
1799
 
# File 'lib/platform-api/client.rb', line 1797

def restart_formation(app_id_or_app_name, dyno_formation_type)
  @client.dyno.restart_formation(app_id_or_app_name, dyno_formation_type)
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



1812
1813
1814
 
# File 'lib/platform-api/client.rb', line 1812

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

#stop_formation(app_id_or_app_name, dyno_formation_type) ⇒ Object

Stop dynos of a given formation type.

Parameters:

  • app_id_or_app_name: —

    unique identifier of app or unique name of app

  • dyno_formation_type: —

    the formation type of this process on this dyno



1820
1821
1822
 
# File 'lib/platform-api/client.rb', line 1820

def stop_formation(app_id_or_app_name, dyno_formation_type)
  @client.dyno.stop_formation(app_id_or_app_name, dyno_formation_type)
end