Deployment (Crafter Deployer 3.1.31 API)

java.lang.Object
- org.craftercms.deployer.api.Deployment

```
public class Deployment
extends Object
```
Represents a deployment. Contains every important status information of a particular deployment execution.

Author:

avasquez

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Deployment.Status

Nested Classes
Modifier and Type	Class and Description
`static class`	`Deployment.Status`

Field Summary

Fields
Modifier and Type	Field and Description
`protected ChangeSet`	`changeSet`
`protected ZonedDateTime`	`end`
`protected Lock`	`lock`
`protected Map<String,Object>`	`params`
`protected List<ProcessorExecution>`	`processorExecutions`
`protected ZonedDateTime`	`start`
`protected Deployment.Status`	`status`
`protected Target`	`target`

Constructor Summary

Constructors
Constructor and Description

Deployment(Target target)

Deployment(Target target, Map<String,Object> params)

Constructors
Constructor and Description
`Deployment(Target target)`
`Deployment(Target target, Map<String,Object> params)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addParam(String name, Object value)` Adds a param that can be used by processors during the deployment.
`void`	`addProcessorExecution(ProcessorExecution status)` Adds a `ProcessorExecution` to the list.
`void`	`end(Deployment.Status status)` Ends the deployment with the specified status.
`ChangeSet`	`getChangeSet()` Returns the change set of the deployment.
`Long`	`getDuration()` Returns the duration of the deployment.
`ZonedDateTime`	`getEnd()` Returns the end date of the deployment.
`Object`	`getParam(String name)` Returns a param that can be used by processors during the deployment.
`List<ProcessorExecution>`	`getProcessorExecutions()` Returns the list of `ProcessorExecution`s.
`ZonedDateTime`	`getStart()` Returns the start date of the deployment.
`Deployment.Status`	`getStatus()` Returns the status of the deployment, either success or failure.
`Target`	`getTarget()` Returns the `Target` being deployed.
`boolean`	`isChangeSetEmpty()` Returns true if the change set is null or empty.
`boolean`	`isRunning()` Returns true if the deployment is still running.
`void`	`removeParam(String name)` Removes the specified param
`void`	`setChangeSet(ChangeSet changeSet)` Sets the change set of the deployment.
`void`	`start()` Starts the deployment.
`String`	`toString()`

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

- Field Detail
  - target
```
protected Target target
```
  - start
```
protected volatile ZonedDateTime start
```
  - end
```
protected volatile ZonedDateTime end
```
  - status
```
protected volatile Deployment.Status status
```
  - changeSet
```
protected volatile ChangeSet changeSet
```
  - processorExecutions
```
protected List<ProcessorExecution> processorExecutions
```
  - params
```
protected Map<String,Object> params
```
  - lock
```
protected Lock lock
```
- Constructor Detail
  - Deployment
```
public Deployment(Target target)
```
  - Deployment
```
public Deployment(Target target,
                  Map<String,Object> params)
```
- Method Detail
  - getTarget
```
public Target getTarget()
```
    Returns the Target being deployed.
  - getStart
```
public ZonedDateTime getStart()
```
    Returns the start date of the deployment.
  - getEnd
```
public ZonedDateTime getEnd()
```
    Returns the end date of the deployment.
  - isRunning
```
public boolean isRunning()
```
    Returns true if the deployment is still running.
  - getDuration
```
public Long getDuration()
```
    Returns the duration of the deployment.
  - getStatus
```
public Deployment.Status getStatus()
```
    Returns the status of the deployment, either success or failure.
  - getChangeSet
```
public ChangeSet getChangeSet()
```
    Returns the change set of the deployment.
  - setChangeSet
```
public void setChangeSet(ChangeSet changeSet)
```
    Sets the change set of the deployment.
  - isChangeSetEmpty
```
public boolean isChangeSetEmpty()
```
    Returns true if the change set is null or empty.
  - start
```
public void start()
```
    Starts the deployment.
  - end
```
public void end(Deployment.Status status)
```
    Ends the deployment with the specified status.
  - getProcessorExecutions
```
public List<ProcessorExecution> getProcessorExecutions()
```
    Returns the list of ProcessorExecutions.
  - addProcessorExecution
```
public void addProcessorExecution(ProcessorExecution status)
```
    Adds a ProcessorExecution to the list.
  - addParam
```
public void addParam(String name,
                     Object value)
```
    Adds a param that can be used by processors during the deployment.
    
    Parameters:
    
    name - the name of the param
    
    value - the value of the param
  - getParam
```
public Object getParam(String name)
```
    Returns a param that can be used by processors during the deployment.
    
    Parameters:
    
    name - the name of the param
    
    Returns:
    
    the value of the param
  - removeParam
```
public void removeParam(String name)
```
    Removes the specified param
    
    Parameters:
    
    name - the name of the param
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Deployment

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

target

start

end

status

changeSet

processorExecutions

params

lock

Constructor Detail

Deployment

Deployment

Method Detail

getTarget

getStart

getEnd

isRunning

getDuration

getStatus

getChangeSet

setChangeSet

isChangeSetEmpty

start

end

getProcessorExecutions

addProcessorExecution

addParam

getParam

removeParam

toString