Package com.uipath.uipathpackage

Class UiPathDeploy

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

com.uipath.uipathpackage.UiPathDeploy

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class UiPathDeploy
extends Recorder
implements SimpleBuildStep

Class responsible for deploying the nuget package to the orchestrator instance provided by the user.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UiPathDeploy.DescriptorImpl	Publisher.

Nested classes/interfaces inherited from class hudson.tasks.Publisher

Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
UiPathDeploy(java.lang.String packagePath, java.lang.String orchestratorAddress, java.lang.String orchestratorTenant, java.lang.String folderName, java.lang.String environments, SelectEntry credentials, TraceLevel traceLevel, java.lang.String entryPointPaths, boolean createProcess)	Data bound constructor which is responsible for setting/saving of the values provided by the user

Method Summary

Modifier and Type	Method	Description
boolean	getCreateProcess()	Whether the process should be created automatically or not (default true)
SelectEntry	getCredentials()	Credentials ID, appearing as choice and will be responsible to extract credentials and use for orchestrator connection
java.lang.String	getEntryPointPaths()	The comma-separated list of entry points with which processes will be created
java.lang.String	getEnvironments()	The comma-separated list of environments which should be assigned to the process or test cases in the package.
java.lang.String	getFolderName()	Orchestrator Folder
java.lang.String	getOrchestratorAddress()	Base orchestrator URL
java.lang.String	getOrchestratorTenant()	Orchestrator Tenant
java.lang.String	getPackagePath()	nupkg path which has to be uploaded
BuildStepMonitor	getRequiredMonitorService()	Declares the scope of the synchronization monitor this BuildStep expects from outside.
TraceLevel	getTraceLevel()	traceLevel
void	perform(Run<?,?> run, FilePath workspace, EnvVars env, Launcher launcher, TaskListener listener)	Run this step.

Methods inherited from class hudson.tasks.Recorder

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, perform, prebuild

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Detail

UiPathDeploy

@DataBoundConstructor
public UiPathDeploy(java.lang.String packagePath,
                    java.lang.String orchestratorAddress,
                    java.lang.String orchestratorTenant,
                    java.lang.String folderName,
                    java.lang.String environments,
                    SelectEntry credentials,
                    TraceLevel traceLevel,
                    java.lang.String entryPointPaths,
                    boolean createProcess)

Data bound constructor which is responsible for setting/saving of the values provided by the user

Parameters:

packagePath - Package Path

orchestratorAddress - Orchestrator base URL

orchestratorTenant - Orchestrator tenant

folderName - Orchestrator folder

credentials - Orchestrator credentials

environments - Environments on which to deploy

traceLevel - The trace logging level. One of the following values: None, Critical, Error, Warning, Information, Verbose. (default None)

entryPointPaths - Entry points with which processes will be created

createProcess - Create process flag (default true)

Method Detail

getCredentials

public SelectEntry getCredentials()

Credentials ID, appearing as choice and will be responsible to extract credentials and use for orchestrator connection

Returns:

SelectEntry credentials

getPackagePath

public java.lang.String getPackagePath()

nupkg path which has to be uploaded

Returns:

String packagePath

getOrchestratorAddress

public java.lang.String getOrchestratorAddress()

Base orchestrator URL

Returns:

String orchestratorAddress

getOrchestratorTenant

public java.lang.String getOrchestratorTenant()

Orchestrator Tenant

Returns:

String orchestratorTenant

getFolderName

public java.lang.String getFolderName()

Orchestrator Folder

Returns:

String folderName

getEnvironments

public java.lang.String getEnvironments()

The comma-separated list of environments which should be assigned to the process or test cases in the package.

Returns:

The environments on which to deploy

getTraceLevel

public TraceLevel getTraceLevel()

traceLevel

Returns:

TraceLevel traceLevel

getEntryPointPaths

public java.lang.String getEntryPointPaths()

The comma-separated list of entry points with which processes will be created

Returns:

the entry points

getCreateProcess

public boolean getCreateProcess()

Whether the process should be created automatically or not (default true)

Returns:

createProcess flag

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Declares the scope of the synchronization monitor this BuildStep expects from outside. BuildStepMonitor.NONE No external synchronization is performed on this build step. This is the most efficient, and thus the recommended value for newer plugins. Wherever necessary, you can directly use CheckPoints to perform necessary synchronizations.

Specified by:

getRequiredMonitorService in interface BuildStep

Returns:

BuildStepMonitor BuildStepMonitor.NONE

perform

public void perform(@Nonnull
                    Run<?,?> run,
                    @Nonnull
                    FilePath workspace,
                    @Nonnull
                    EnvVars env,
                    @Nonnull
                    Launcher launcher,
                    @Nonnull
                    TaskListener listener)
             throws java.lang.InterruptedException,
                    java.io.IOException

Run this step.

Specified by:

perform in interface SimpleBuildStep

Parameters:

run - a build this is running as a part of

workspace - a workspace to use for any file operations

launcher - a way to start processes

listener - a place to send output

Throws:

java.lang.InterruptedException - if the step is interrupted

java.io.IOException - if something goes wrong