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.

  • Constructor Details

    • UiPathDeploy

      @DataBoundConstructor public UiPathDeploy(String packagePath, String orchestratorAddress, String orchestratorTenant, String folderName, String environments, SelectEntry credentials, TraceLevel traceLevel, 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 Details

    • 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 String getPackagePath()
      nupkg path which has to be uploaded
      Returns:
      String packagePath

    • getOrchestratorAddress

      public String getOrchestratorAddress()
      Base orchestrator URL
      Returns:
      String orchestratorAddress

    • getOrchestratorTenant

      public String getOrchestratorTenant()
      Orchestrator Tenant
      Returns:
      String orchestratorTenant

    • getFolderName

      public String getFolderName()
      Orchestrator Folder
      Returns:
      String folderName

    • getEnvironments

      public 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 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 InterruptedException, 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:
      InterruptedException - if the step is interrupted
      IOException - if something goes wrong

    • setIgnoreLibraryDeployConflict

      @DataBoundSetter public void setIgnoreLibraryDeployConflict(Boolean ignoreLibraryDeployConflict)

    • getIgnoreLibraryDeployConflict

      public Boolean getIgnoreLibraryDeployConflict()

    • setProcessName

      @DataBoundSetter public void setProcessName(String processName)

    • getProcessName

      public String getProcessName()

    • setProcessNames

      @DataBoundSetter public void setProcessNames(String processNames)

    • getProcessNames

      public String getProcessNames()