HerokuAPI (heroku-api 0.24 API)

java.lang.Object
- com.heroku.api.HerokuAPI

```
public class HerokuAPI
extends Object
```
A convenience class for making HTTP requests to the Heroku API for a given user. An underlying Connection is created for each instance of HerokuAPI. To make HTTP requests to the Heroku API in multi-user or systems that have resource constraints (e.g. a pool of Connection objects are required), Connection should be used directly.
Example usage:
```
     HerokuAPI heroku = new HerokuAPI("apiKey");
     App app = heroku.createApp();
     heroku.scaleProcess(app.getName(), "web", 1)
 
 
```
RuntimeException will be thrown for any request failures.

Field Summary

Fields
Modifier and Type Field and Description

protected String apiKey

protected Connection connection

Fields
Modifier and Type	Field and Description
`protected String`	`apiKey`
`protected Connection`	`connection`

Constructor Summary

Constructors
Constructor and Description
`HerokuAPI(Connection connection, String apiKey)`
`HerokuAPI(String apiKey)` Constructs a HerokuAPI with a `Connection` based on the first `ConnectionProvider` found on the classpath.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddonChange`	`addAddon(String appName, String addonName)` Add an addon to the app.
`void`	`addCollaborator(String appName, String collaborator)` Add a collaborator to an app.
`void`	`addKey(String sshKey)` Add an ssh key to the current user's account.
`boolean`	`appExists(String name)` Checks if an app with the given name exists on Heroku.
`App`	`createApp()` Create a new app on the {Heroku.Stack.Cedar14} stack.
`App`	`createApp(App app)` Create a new app using `App` to specify parameters.
`Build`	`createBuild(String appName, Build build)` Creates a build
`Slug`	`createSlug(String appName, Map<String,String> processTypes)` Gets the slug info for an existing slug
`Source`	`createSource()` Creates a source
`void`	`destroyApp(String appName)` Delete an app.
`App`	`getApp(String name)` Get information about a specific app.
`Build`	`getBuildInfo(String appName, String buildId)` Gets the info for a running build
`Connection`	`getConnection()`
`LogStreamResponse`	`getLogs(Log.LogRequestBuilder logRequest)` Get logs for an app by specifying additional parameters.
`LogStreamResponse`	`getLogs(String appName)` Get logs for an app.
`LogStreamResponse`	`getLogs(String appName, Boolean tail)` Get logs for an app.
`Release`	`getReleaseInfo(String appName, String releaseName)` Information about a specific release.
`Slug`	`getSlugInfo(String appName, String slugId)` Gets the slug info for an existing slug
`User`	`getUserInfo()` Information for the current user.
`boolean`	`isAppNameAvailable(String name)` Checks if the given app name is available on Heroku.
`boolean`	`isMaintenanceModeEnabled(String appName)` Checks if maintenance mode is enabled for the given app
`List<Addon>`	`listAllAddons()` Get a list of all addons available.
`List<Addon>`	`listAppAddons(String appName)` List the addons already added to an app.
`Range<App>`	`listApps()` List all apps for the current user's account.
`Range<App>`	`listApps(String range)` List all apps for the current user's account.
`List<StackInfo>`	`listAppStacks()` Gets a list of stacks available.
`List<Collaborator>`	`listCollaborators(String appName)` Get a list of collaborators that are allowed access to an app.
`Map<String,String>`	`listConfig(String appName)` List all the environment variables for an app.
`Range<Dyno>`	`listDynos(String appName)` List app dynos for an app
`List<Formation>`	`listFormation(String appName)` Lists the formation info for an app
`List<Key>`	`listKeys()` Get a list of keys associated with the current user's account.
`List<Release>`	`listReleases(String appName)` List of releases for an app.
`AddonChange`	`removeAddon(String appName, String addonName)` Remove an addon from an app.
`void`	`removeCollaborator(String appName, String collaborator)` Remove a collaborator from an app.
`void`	`removeKey(String sshKey)` Delete an ssh key from the current user's account.
`String`	`renameApp(String appName, String newName)` Rename an existing app.
`void`	`restartDyno(String appName, String dynoId)` Restarts a single dyno
`void`	`restartDynos(String appName)` Restarts all dynos for an app
`Release`	`rollback(String appName, String releaseUuid)` Rollback an app to a specific release.
`Formation`	`scale(String appName, String processType, int quantity)` Scales a process type
`void`	`setMaintenanceMode(String appName, boolean enable)` Sets maintenance mode for the given app
`void`	`transferApp(String appName, String to)` Transfer the ownership of an application to another user.
`void`	`updateConfig(String appName, Map<String,String> config)` Update environment variables to an app.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - connection
```
protected final Connection connection
```
  - apiKey
```
protected final String apiKey
```
- Constructor Detail
  - HerokuAPI
```
public HerokuAPI(String apiKey)
```
    Constructs a HerokuAPI with a Connection based on the first ConnectionProvider found on the classpath.
    
    Parameters:
    
    apiKey - User's API key found at https://api.heroku.com/account
  - HerokuAPI
```
public HerokuAPI(Connection connection,
                 String apiKey)
```
    Parameters:
    
    connection - the connection to Heroku API
    
    apiKey - User's API key found at https://api.heroku.com/account
- Method Detail
  - getConnection
```
public Connection getConnection()
```
  - getUserInfo
```
public User getUserInfo()
```
    Information for the current user.
    
    Returns:
    
    user info object
  - addKey
```
public void addKey(String sshKey)
```
    Add an ssh key to the current user's account.
    
    Parameters:
    
    sshKey - Public key value. e.g. ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCz29znMi/UJX/nvkRSO5FFugKhU9DkkI53E0vXUnP8zeLFxMgyUqmXryPVjWtGzz2LRWqjm14SbqHAmM44pGHVfBIp6wCKBWSUYGv/FxOulwYgtWzz4moxWLZrFyWWgJAnehcVUifHNgzKwT2ovWm2ns52681Z8yFK3K8/uLStDjLIaPePEOaxaTvgIxZNsfyEoXoHcyTPwdR1GtQuDTuDYqYmjmPCoKybYnXrTQ1QFuQxDneBkswQYSl0H2aLf3uBK4F01hr+azXQuSe39eSV4I/TqzmNJlanpILT9Jz3/J1i4r6brpF3AxLnFnb9ufIbzQAIa/VZIulfrZkcBsUl [email protected]
  - removeKey
```
public void removeKey(String sshKey)
```
    Delete an ssh key from the current user's account.
    
    Parameters:
    
    sshKey - The comment in the public key. See listKeys() to get a list of keys that can be removed.
  - listKeys
```
public List<Key> listKeys()
```
    Get a list of keys associated with the current user's account.
    
    Returns:
    
    a list of keys
  - listApps
```
public Range<App> listApps()
```
    List all apps for the current user's account.
    
    Returns:
    
    a list of apps
  - listApps
```
public Range<App> listApps(String range)
```
    List all apps for the current user's account.
    
    Parameters:
    
    range - The range of apps provided by Range.getNextRange()
    
    Returns:
    
    a list of apps
  - getApp
```
public App getApp(String name)
```
    Get information about a specific app.
    
    Parameters:
    
    name - The name of the app. See listApps() to get a list of apps and their names.
    
    Returns:
    
    an app object
  - appExists
```
public boolean appExists(String name)
```
    Checks if an app with the given name exists on Heroku. A true response does not necessarily indicate the user has access to the app. Use getApp(String) to check user access.
    
    Parameters:
    
    name - name of the app
    
    Returns:
    
    true if an app exists with the specified name
  - isAppNameAvailable
```
public boolean isAppNameAvailable(String name)
```
    Checks if the given app name is available on Heroku.
    
    Parameters:
    
    name - name of the app
    
    Returns:
    
    true if the app name is available
  - createApp
```
public App createApp()
```
    Create a new app on the {Heroku.Stack.Cedar14} stack. For more information about the Cedar stack, please see the Dev Center.
    
    Returns:
    
    an app object
  - createApp
```
public App createApp(App app)
```
    Create a new app using App to specify parameters. App has convenience methods for specifying parameters to send as part of the request. Typically, these will be the name of the app and the requested stack. e.g.
```
 heroku.createApp(new App().on(Heroku.Stack.Cedar).named("new-app")
```
    Parameters:
    
    app - See App
    
    Returns:
    
    an app object
  - renameApp
```
public String renameApp(String appName,
                        String newName)
```
    Rename an existing app.
    
    Parameters:
    
    appName - Existing app name. See listApps() for names that can be used.
    
    newName - New name to give the existing app.
    
    Returns:
    
    the new name of the object
  - destroyApp
```
public void destroyApp(String appName)
```
    Delete an app.
    
    Parameters:
    
    appName - the app name
  - addAddon
```
public AddonChange addAddon(String appName,
                            String addonName)
```
    Add an addon to the app.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    addonName - Addon name. See listAllAddons() to get a list of addons that can be used.
    
    Returns:
    
    The request object
  - listAllAddons
```
public List<Addon> listAllAddons()
```
    Get a list of all addons available. Refer to http://addons.heroku.com for more information about addons.
    
    Returns:
    
    a list of add-ons
  - listAppAddons
```
public List<Addon> listAppAddons(String appName)
```
    List the addons already added to an app.
    
    Parameters:
    
    appName - new of the app
    
    Returns:
    
    a list of add-ons
  - removeAddon
```
public AddonChange removeAddon(String appName,
                               String addonName)
```
    Remove an addon from an app.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    addonName - Addon name. See listAppAddons(java.lang.String) for a list of addons that can be used.
    
    Returns:
    
    the request object
  - listReleases
```
public List<Release> listReleases(String appName)
```
    List of releases for an app.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    Returns:
    
    a list of releases
  - rollback
```
public Release rollback(String appName,
                        String releaseUuid)
```
    Rollback an app to a specific release.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    releaseUuid - Release UUID. See listReleases(java.lang.String) for a list of the app's releases.
    
    Returns:
    
    the release object
  - getReleaseInfo
```
public Release getReleaseInfo(String appName,
                              String releaseName)
```
    Information about a specific release.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    releaseName - Release name. See listReleases(java.lang.String) for a list of the app's releases.
    
    Returns:
    
    the release object
  - listCollaborators
```
public List<Collaborator> listCollaborators(String appName)
```
    Get a list of collaborators that are allowed access to an app.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    Returns:
    
    list of collaborators
  - addCollaborator
```
public void addCollaborator(String appName,
                            String collaborator)
```
    Add a collaborator to an app.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    collaborator - Username of the collaborator to add. This is usually in the form of "[email protected]".
  - removeCollaborator
```
public void removeCollaborator(String appName,
                               String collaborator)
```
    Remove a collaborator from an app.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    collaborator - See listCollaborators(java.lang.String) for collaborators that can be removed from the app.
  - updateConfig
```
public void updateConfig(String appName,
                         Map<String,String> config)
```
    Update environment variables to an app.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    config - Key/Value pairs of environment variables.
  - listConfig
```
public Map<String,String> listConfig(String appName)
```
    List all the environment variables for an app.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    Returns:
    
    map of config vars
  - transferApp
```
public void transferApp(String appName,
                        String to)
```
    Transfer the ownership of an application to another user.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    to - Username of the person to transfer the app to. This is usually in the form of "[email protected]".
  - getLogs
```
public LogStreamResponse getLogs(String appName)
```
    Get logs for an app.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    Returns:
    
    log stream response
  - getLogs
```
public LogStreamResponse getLogs(String appName,
                                 Boolean tail)
```
    Get logs for an app.
    
    Parameters:
    
    appName - App name. See listApps() for a list of apps that can be used.
    
    Returns:
    
    log stream response
  - getLogs
```
public LogStreamResponse getLogs(Log.LogRequestBuilder logRequest)
```
    Get logs for an app by specifying additional parameters.
    
    Parameters:
    
    logRequest - See {LogRequestBuilder}
    
    Returns:
    
    log stream response
  - listAppStacks
```
public List<StackInfo> listAppStacks()
```
    Gets a list of stacks available.
    
    Returns:
    
    List of stacks available.
  - isMaintenanceModeEnabled
```
public boolean isMaintenanceModeEnabled(String appName)
```
    Checks if maintenance mode is enabled for the given app
    
    Parameters:
    
    appName - See listApps() for a list of apps that can be used.
    
    Returns:
    
    true if maintenance mode is enabled
  - setMaintenanceMode
```
public void setMaintenanceMode(String appName,
                               boolean enable)
```
    Sets maintenance mode for the given app
    
    Parameters:
    
    appName - See listApps() for a list of apps that can be used.
    
    enable - true to enable; false to disable
  - createSlug
```
public Slug createSlug(String appName,
                       Map<String,String> processTypes)
```
    Gets the slug info for an existing slug
    
    Parameters:
    
    appName - See listApps() for a list of apps that can be used.
    
    processTypes - hash mapping process type names to their respective command
  - getSlugInfo
```
public Slug getSlugInfo(String appName,
                        String slugId)
```
    Gets the slug info for an existing slug
    
    Parameters:
    
    appName - See listApps() for a list of apps that can be used.
    
    slugId - the unique identifier of the slug
  - createSource
```
public Source createSource()
```
    Creates a source
  - createBuild
```
public Build createBuild(String appName,
                         Build build)
```
    Creates a build
    
    Parameters:
    
    appName - See listApps() for a list of apps that can be used.
    
    build - the build information
  - getBuildInfo
```
public Build getBuildInfo(String appName,
                          String buildId)
```
    Gets the info for a running build
    
    Parameters:
    
    appName - See listApps() for a list of apps that can be used.
    
    buildId - the unique identifier of the build
  - listDynos
```
public Range<Dyno> listDynos(String appName)
```
    List app dynos for an app
    
    Parameters:
    
    appName - See listApps() for a list of apps that can be used.
  - restartDyno
```
public void restartDyno(String appName,
                        String dynoId)
```
    Restarts a single dyno
    
    Parameters:
    
    appName - See listApps() for a list of apps that can be used.
    
    dynoId - the unique identifier of the dyno to restart
  - restartDynos
```
public void restartDynos(String appName)
```
    Restarts all dynos for an app
    
    Parameters:
    
    appName - See listApps() for a list of apps that can be used.
  - scale
```
public Formation scale(String appName,
                       String processType,
                       int quantity)
```
    Scales a process type
    
    Parameters:
    
    appName - See listApps() for a list of apps that can be used.
    
    processType - type of process to maintain
    
    quantity - number of processes to maintain
  - listFormation
```
public List<Formation> listFormation(String appName)
```
    Lists the formation info for an app
    
    Parameters:
    
    appName - See listApps() for a list of apps that can be used.

Class HerokuAPI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

connection

apiKey

Constructor Detail

HerokuAPI

HerokuAPI

Method Detail

getConnection

getUserInfo

addKey

removeKey

listKeys

listApps

listApps

getApp

appExists

isAppNameAvailable

createApp

createApp

renameApp

destroyApp

addAddon

listAllAddons

listAppAddons

removeAddon

listReleases

rollback

getReleaseInfo

listCollaborators

addCollaborator

removeCollaborator

updateConfig

listConfig

transferApp

getLogs

getLogs

getLogs

listAppStacks

isMaintenanceModeEnabled

setMaintenanceMode

createSlug

getSlugInfo

createSource

createBuild

getBuildInfo

listDynos

restartDyno

restartDynos

scale

listFormation