Class Deployment
java.lang.Object
com.xebialabs.deployit.engine.api.dto.AbstractDto
com.xebialabs.deployit.engine.api.dto.Deployment
The parameter object of a deployment action.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
The type of deployment: INITIAL, UPDATE or UNDEPLOYMENT. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem object) Adds aConfigurationItem
to the list of deployeds of this deployment.void
Adds a list ofConfigurationItem
s to the list of deployeds of this deployment.void
addResolvedPlaceholders
(Set<com.xebialabs.deployit.plugin.api.deployment.ResolvedPlaceholder> resolvedPlaceholders) com.xebialabs.deployit.plugin.api.udm.ConfigurationItem
List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem>
int
getId()
Set<com.xebialabs.deployit.plugin.api.deployment.ResolvedPlaceholder>
boolean
void
setContainers
(List<ConfigurationItemId> containers) void
setDeployables
(List<ConfigurationItemId> deployables) void
setDeployedApplication
(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem deployedApplication) void
setDeployeds
(List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> deployeds) void
setDeploymentGroupIndex
(int deploymentGroupIndex) void
setDeploymentType
(Deployment.DeploymentType deploymentType) void
setGroupedRequiredDeployments
(List<List<Deployment>> dependencies) void
void
setRequiredDeployments
(List<Deployment> requiredDeployments) void
setResolvedPlaceholders
(Set<com.xebialabs.deployit.plugin.api.deployment.ResolvedPlaceholder> resolvedPlaceholders) Methods inherited from class com.xebialabs.deployit.engine.api.dto.AbstractDto
toString
-
Constructor Details
-
Deployment
public Deployment()
-
-
Method Details
-
getId
- Returns:
- The id of the deployment action.
-
setId
- Parameters:
id
- The id of the deployment action.
-
getDeployedApplication
public com.xebialabs.deployit.plugin.api.udm.ConfigurationItem getDeployedApplication()- Returns:
- The application being deployed, upgraded or undeployed.
-
getDeployeds
- Returns:
- A list of
ConfigurationItem
s representing the deployeds of this deployment.
-
getDeploymentType
- Returns:
- The
Deployment.DeploymentType
of the current deployment.
-
setDeploymentType
- Parameters:
deploymentType
- TheDeployment.DeploymentType
of the current deployment.
-
isOfType
- Parameters:
type
- TheDeployment.DeploymentType
to check against.- Returns:
- Whether the current deployment has the given
Deployment.DeploymentType
.
-
setDeployedApplication
public void setDeployedApplication(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem deployedApplication) - Parameters:
deployedApplication
- The application being deployed, upgraded or undeployed.
-
setDeployeds
- Parameters:
deployeds
- A list ofConfigurationItem
s representing the deployeds of this deployment.
-
add
public void add(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem object) Adds aConfigurationItem
to the list of deployeds of this deployment. -
addAll
Adds a list ofConfigurationItem
s to the list of deployeds of this deployment. -
getVersion
- Returns:
- The CI id of the deployed package.
-
getEnvironment
- Returns:
- The CI id of the deployment environment.
-
getDeployables
- Returns:
- A list of CI references (
ConfigurationItemId
s) representing the deployables of this deployment.
-
setDeployables
- Parameters:
deployables
- A list of CI references (ConfigurationItemId
s) representing the deployables of this deployment.
-
getContainers
- Returns:
- A list of CI references (
ConfigurationItemId
s) representing the containers of this deployment.
-
setContainers
- Parameters:
containers
- A list of CI references (ConfigurationItemId
s) representing the containers of this deployment.
-
getRequiredDeployments
- Returns:
- A list of Deployments (
Deployment
s) representing the dependent deployments.
-
getGroupedRequiredDeployments
-
setGroupedRequiredDeployments
- Parameters:
dependencies
- A list of Deployments (Deployment
s) representing the dependent deployments.
-
getDeploymentGroupIndex
public int getDeploymentGroupIndex() -
setDeploymentGroupIndex
public void setDeploymentGroupIndex(int deploymentGroupIndex) -
setRequiredDeployments
-
getResolvedPlaceholders
public Set<com.xebialabs.deployit.plugin.api.deployment.ResolvedPlaceholder> getResolvedPlaceholders() -
addResolvedPlaceholders
public void addResolvedPlaceholders(Set<com.xebialabs.deployit.plugin.api.deployment.ResolvedPlaceholder> resolvedPlaceholders) -
setResolvedPlaceholders
public void setResolvedPlaceholders(Set<com.xebialabs.deployit.plugin.api.deployment.ResolvedPlaceholder> resolvedPlaceholders)
-