getProcess

Back to index

Summary

Retrieves an application or component process.
projectName
Stringrequired
The name for the project that must be unique among all projects.
processName
Stringrequired
The name of the process.
applicationEntityRevisionId
UUIDoptional
The revision ID of the versioned object.
applicationName
Stringoptional
The name of the application, if the process is owned by an application.
componentApplicationName
Stringoptional
If specified, the component is scoped to this application not the project.
componentName
Stringoptional
The name of the component, if the process is owned by a component.
microserviceApplicationName
Stringoptional
If specified, the microservice is scoped to an application.
microserviceName
Stringoptional
The name of the microservice, if the process is owned by a microservice.

Usage

Perl

$cmdr->getProcess( "test-projectName", # projectName "test-processName" # processName # optionals );

ectool

ectool getProcess \ "test-projectName" `# projectName` \ "test-processName" `# processName` \ # optionals

Example

Perl

To retrieve a component process in a master component:

$cmdr->getProcess('Default', 'Deploy', {componentName => 'WAR file'});

To retrieve a component process in a specific application:

$cmdr->getProcess('Default', 'Deploy', {componentName => 'WAR file', componentApplicationName => 'Shopping Cart'});

To retrieve an application process:

$cmdr->getProcess('Default', 'Deploy', {applicationName => 'Shopping Cart'});

ectool

To retrieve a component process in a master component:

ectool getProcess 'Default' 'Deploy' --componentName 'WAR file'

To retrieve a component process in a specific application:

ectool getProcess 'Default' 'Deploy' --componentName 'WAR file' --componentApplicationName 'Shopping Cart'

To retrieve an application process:

ectool getProcess 'Default' 'Deploy' --applicationName 'Shopping Cart'