public interface AppDeployer
tasks
.Modifier and Type | Field and Description |
---|---|
static String |
COUNT_PROPERTY_KEY
The environment property for the count (number of app instances).
|
static String |
GROUP_PROPERTY_KEY
The environment property for the group to which an app belongs.
|
Modifier and Type | Method and Description |
---|---|
String |
deploy(AppDeploymentRequest request)
Deploy an app using an
AppDeploymentRequest . |
AppStatus |
status(String id)
Return the
AppStatus for an app represented by a deployment id. |
void |
undeploy(String id)
Un-deploy an app using its deployment id.
|
static final String COUNT_PROPERTY_KEY
static final String GROUP_PROPERTY_KEY
String deploy(AppDeploymentRequest request)
AppDeploymentRequest
. The returned id is
later used with undeploy(String)
or status(String)
to
undeploy an app or check its status, respectively.
Implementations may perform this operation asynchronously; therefore a
successful deployment may not be assumed upon return. To determine the
status of a deployment, invoke status(String)
.request
- the app deployment requestIllegalStateException
- if the app has already been deployedvoid undeploy(String id)
status(String)
.id
- the app deployment id, as returned by deploy(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest)
IllegalStateException
- if the app has not been deployedAppStatus status(String id)
AppStatus
for an app represented by a deployment id.id
- the app deployment id, as returned by deploy(org.springframework.cloud.deployer.spi.core.AppDeploymentRequest)
Copyright © 2016 Pivotal Software, Inc.. All rights reserved.