ApiDeployment (inedo-buildmaster-plugin 3.1.0 API)

java.lang.Object
- com.inedo.buildmaster.domain.ApiDeployment

public class ApiDeployment
extends java.lang.Object

Deployment Object

See Also:: Data Specification

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.Integer`	`applicationId` An integer representing the system-unique identifier of the application for the deployment.
`java.lang.String`	`applicationName` A string representing the system-unique name of the application for the deployment.
`java.lang.Integer`	`buildId` An integer representing the system-unique identifier of the build for the deployment.
`java.lang.String`	`buildNumber` A string representing the release-unique number of the build for the deployment.
`java.lang.String`	`canceledBy` A string representing the user who canceled the deployment (SYSTEM if canceled non-interactively), or null if the deployment was not canceled.
`java.lang.String`	`canceledOn` A string representing the UTC date when the deployment was canceled, in ISO 8601 format (yyyy-MM-ddThh:mm:ss), or null if the deployment was not canceled.
`java.lang.String`	`createdBy` A string representing the user who initiated the deployment, or SYSTEM if initiated non-interactively.
`java.lang.String`	`createdOn` A string representing the UTC date when the deployment was initiated, in ISO 8601 format (yyyy-MM-ddThh:mm:ss).
`java.lang.String`	`ended` A string representing the UTC date when the deployment completed, in ISO 8601 format (yyyy-MM-ddThh:mm:ss), or null if the execution hasn't completed.
`java.lang.Integer`	`environmentId` An integer representing the system-unique identifier of the environment used by the deployment, or null if no environment is in context.
`java.lang.String`	`environmentName` A string representing the name of the environment used by the deployment, or null if no environment is in context.
`java.lang.Integer`	`id` An integer representing the system-unique identifier of the deployment.
`java.lang.Integer`	`pipelineId` An integer representing the system-unique identifier of the pipeline used by the deployment.
`java.lang.String`	`pipelineName` A string representing the name of the pipeline used by the deployment.
`java.lang.String`	`pipelineStageName` A string representing the name the stage in the pipeline used by the deployment.
`java.lang.String`	`plan` A string representing the name of the plan used for deployment.
`java.lang.Integer`	`releaseId` An integer representing the system-unique identifier of the release for the deployment.
`java.lang.String`	`releaseName` A string representing the name of the release for the deployment.
`java.lang.String`	`releaseNumber` A string representing the application-unique number of the release for the deployment.
`java.lang.String`	`started` A string representing the UTC date when the deployment actually started, in ISO 8601 format (yyyy-MM-ddThh:mm:ss), or null if the execution hasn't started.
`java.lang.String`	`status` A string consisting of pending, executing, succeeded, warned, or failed

Constructor Summary

Constructors
Constructor and Description

ApiDeployment()

Constructors
Constructor and Description
`ApiDeployment()`

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

- Field Detail
  - id
```
public java.lang.Integer id
```
    An integer representing the system-unique identifier of the deployment.
  - plan
```
public java.lang.String plan
```
    A string representing the name of the plan used for deployment.
  - status
```
public java.lang.String status
```
    A string consisting of pending, executing, succeeded, warned, or failed
  - started
```
public java.lang.String started
```
    A string representing the UTC date when the deployment actually started, in ISO 8601 format (yyyy-MM-ddThh:mm:ss), or null if the execution hasn't started.
  - ended
```
public java.lang.String ended
```
    A string representing the UTC date when the deployment completed, in ISO 8601 format (yyyy-MM-ddThh:mm:ss), or null if the execution hasn't completed.
  - createdBy
```
public java.lang.String createdBy
```
    A string representing the user who initiated the deployment, or SYSTEM if initiated non-interactively.
  - createdOn
```
public java.lang.String createdOn
```
    A string representing the UTC date when the deployment was initiated, in ISO 8601 format (yyyy-MM-ddThh:mm:ss).
  - canceledBy
```
public java.lang.String canceledBy
```
    A string representing the user who canceled the deployment (SYSTEM if canceled non-interactively), or null if the deployment was not canceled.
  - canceledOn
```
public java.lang.String canceledOn
```
    A string representing the UTC date when the deployment was canceled, in ISO 8601 format (yyyy-MM-ddThh:mm:ss), or null if the deployment was not canceled.
  - pipelineId
```
public java.lang.Integer pipelineId
```
    An integer representing the system-unique identifier of the pipeline used by the deployment.
  - pipelineName
```
public java.lang.String pipelineName
```
    A string representing the name of the pipeline used by the deployment.
  - pipelineStageName
```
public java.lang.String pipelineStageName
```
    A string representing the name the stage in the pipeline used by the deployment.
  - environmentId
```
public java.lang.Integer environmentId
```
    An integer representing the system-unique identifier of the environment used by the deployment, or null if no environment is in context.
  - environmentName
```
public java.lang.String environmentName
```
    A string representing the name of the environment used by the deployment, or null if no environment is in context.
  - applicationId
```
public java.lang.Integer applicationId
```
    An integer representing the system-unique identifier of the application for the deployment.
  - applicationName
```
public java.lang.String applicationName
```
    A string representing the system-unique name of the application for the deployment.
  - releaseId
```
public java.lang.Integer releaseId
```
    An integer representing the system-unique identifier of the release for the deployment.
  - releaseNumber
```
public java.lang.String releaseNumber
```
    A string representing the application-unique number of the release for the deployment.
  - releaseName
```
public java.lang.String releaseName
```
    A string representing the name of the release for the deployment.
  - buildId
```
public java.lang.Integer buildId
```
    An integer representing the system-unique identifier of the build for the deployment.
  - buildNumber
```
public java.lang.String buildNumber
```
    A string representing the release-unique number of the build for the deployment.
- Constructor Detail
  - ApiDeployment
```
public ApiDeployment()
```

Class ApiDeployment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

plan

status

started

ended

createdBy

createdOn

canceledBy

canceledOn

pipelineId

pipelineName

pipelineStageName

environmentId

environmentName

applicationId

applicationName

releaseId

releaseNumber

releaseName

buildId

buildNumber

Constructor Detail

ApiDeployment