createProcess
Creates a new process for an application or component.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
processName | String | The name of the process. (Required) |
componentName | String | The name of the component, if the process is owned by a component. |
applicationName | String | The name of the application, if the process is owned by an application. |
componentApplicationName | String | If specified, the component is scoped to this application not the project. |
credentialName | String | The name of a credential to attach to this process. |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
exclusiveEnvironment | Boolean | True if environment is exclusive to the application or service process. |
microserviceApplicationName | String | If specified, the microservice is scoped to an application. |
microserviceName | String | The name of the microservice, if the process is owned by a microservice. |
processType | String | Defines type of action performed by the process |
smartUndeployEnabled | Boolean | True if smart deploy should be enabled for the undeploy component process |
timeLimit | String | Maximum amount of time the step can execute; abort if it exceeds this time. |
timeLimitUnits | String | Units for step time limit: seconds, minutes, or hours. |
workingDirectory | String | Working directory in which to execute the command for this process. A relative name is interpreted relative to the root directory for the job’s workspace. |
workspaceName | String | The name of the default workspace for this process. |
deleteProcess
Deletes an application or component process.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
processName | String | The name of the process. (Required) |
componentName | String | The name of the component, if the process is owned by a component. |
applicationName | String | The name of the application, if the process is owned by an application. |
componentApplicationName | String | If specified, the component is scoped to this application not the project. |
microserviceApplicationName | String | If specified, the microservice is scoped to an application. |
microserviceName | String | The name of the microservice, if the process is owned by a microservice. |
getProcess
Get an application or component process.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
processName | String | The name of the process. (Required) |
componentName | String | The name of the component, if the process is owned by a component. |
applicationEntityRevisionId | String | Revisionid of the versioned object |
applicationName | String | The name of the application, if the process is owned by an application. |
componentApplicationName | String | If specified, the component is scoped to this application not the project. |
microserviceApplicationName | String | If specified, the microservice is scoped to an application. |
microserviceName | String | The name of the microservice, if the process is owned by a microservice. |
getProcesses
Retrieve all processes in an application or component.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
componentName | String | The name of the component, if the process is owned by a component. |
applicationEntityRevisionId | String | Revisionid of the versioned object |
applicationName | String | The name of the application, if the process is owned by an application. |
componentApplicationName | String | If specified, the component is scoped to this application not the project. |
microserviceApplicationName | String | If specified, the microservice is scoped to an application. |
microserviceName | String | The name of the microservice, if the process is owned by a microservice. |
modifyProcess
Modifies an existing process.
Arguments
Argument Name | Type | Description |
---|---|---|
projectName | String | The name for the project that must be unique among all projects. (Required) |
processName | String | The name of the process. (Required) |
componentName | String | The name of the component, if the process is owned by a component. |
applicationName | String | The name of the application, if the process is owned by an application. |
componentApplicationName | String | If specified, the component is scoped to this application not the project. |
credentialName | String | The name of a credential to attach to this process. |
description | String | Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
exclusiveEnvironment | Boolean | True if environment is exclusive to the application or service process. |
microserviceApplicationName | String | If specified, the microservice is scoped to an application. |
microserviceName | String | The name of the microservice, if the process is owned by a microservice. |
newName | String | New name for an existing object that is being renamed. |
processType | String | Defines type of action performed by the process |
smartUndeployEnabled | Boolean | True if smart deploy should be enabled for the undeploy component process |
timeLimit | String | Maximum amount of time the step can execute; abort if it exceeds this time. |
timeLimitUnits | String | Units for step time limit: seconds, minutes, or hours. |
workingDirectory | String | Working directory in which to execute the command for this process. A relative name is interpreted relative to the root directory for the job’s workspace. |
workspaceName | String | The name of the default workspace for this process. |