FlexDeployFunctions (FlexDeploy Function SDK javadoc)

java.lang.Object
- flexagon.fd.services.groovy.functions.BaseFunctions
- - flexagon.fd.services.groovy.functions.FlexDeployFunctions

```
public class FlexDeployFunctions
extends BaseFunctions
```
Functions to perform actions in FlexDeploy, like building a project or starting a release.

Since:

5.3

Constructor Summary

Constructors
Constructor and Description

FlexDeployFunctions(boolean isExecute, LogFunctions pFLOG)

Constructors
Constructor and Description
`FlexDeployFunctions(boolean isExecute, LogFunctions pFLOG)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activateBranch(java.lang.Long pProjectId, java.lang.String pBranchName)` Active a FlexDeploy Branch on a project.
`void`	`activateStream(java.lang.Long pProjectId, java.lang.String pStreamName)` Active a FlexDeploy Stream on a project.
`void`	`addFilesToPackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.util.List<java.lang.String> pFiles)` Adds files to a given package.
`void`	`addProjectsToRelease(java.lang.String pReleaseName, java.util.List<ReleaseProjectsPojo> pReleaseProjects)` Add FlexDeploy projects to a given release.
`void`	`approveTask(java.lang.String pUsername, java.lang.String pTaskIdentifier, java.lang.String pNotes)` Approve a FlexDeploy Task.
`java.lang.Long`	`buildPackage(java.lang.Long pStreamId, ProjectPackagePojo projectPackage)` Builds a FlexDeploy Package.
`java.lang.Long`	`buildPackage(java.lang.Long pStreamId, ProjectPackagePojo projectPackage, BuildOptions pBuildOptions)` Builds a FlexDeploy Package.
`java.lang.Long`	`buildPackage(java.lang.Long pStreamId, ProjectPackagePojo projectPackage, PollingResult pPollingResult, BuildOptions pBuildOptions)` Builds a FlexDeploy Package using a PollingResult.
`java.lang.Long`	`buildProject(java.lang.Long pStreamId, java.lang.Long pProjectId)` Builds a FlexDeploy Project.
`java.lang.Long`	`buildProject(java.lang.Long pStreamId, java.lang.Long pProjectId, BuildOptions pBuildOptions)` Builds a FlexDeploy Project.
`java.lang.Long`	`buildProject(java.lang.Long pStreamId, java.lang.Long pProjectId, PollingResult pPollingResult, BuildOptions pBuildOptions)` Builds a FlexDeploy Project using a PollingResult.
`void`	`cleanup()`
`void`	`completeManualStepBySnapshotId(java.lang.String pUsername, java.lang.Long pSnapshotId)` Completes a manual step Human task.
`void`	`completeManualStepByTaskId(java.lang.String pUsername, java.lang.Long pTaskId)` Completes a manual step Human task.
`java.lang.Long`	`createBranch(java.lang.Long pProjectId, ProjectStreamPojo pBranch)` Create a FlexDeploy Branch on a given project.
`java.lang.Long`	`createBranch(java.lang.Long pProjectId, java.lang.String pBranchName)` Create a FlexDeploy Branch on a given project.
`java.lang.Long`	`createBranch(java.lang.Long pProjectId, java.lang.String pBranchName, java.lang.String pVersionSyntax)` Create a FlexDeploy Branch on a given project.
`java.lang.Long`	`createDynamicPackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pDescription, java.lang.String pIncludePath, java.lang.String pExcludePath)` Creates a dynamic package for given include and exclude path.
`CMSObject`	`createIncidentByWorkflowType(java.lang.Long pWorkflowRequestId, java.util.Map<java.lang.String,java.io.Serializable> pIncidentFields)` Returns a CMSObject with incident details.
`CMSObject`	`createIncidentForWorklowRequest(java.lang.Long pWorkflowRequestId, java.util.Map<java.lang.String,java.io.Serializable> pIncidentFields, java.lang.String pCMSInstanceCode, java.lang.String pCMSInstanceName)` Returns a CMSObject with incident details for a particular CMS Instance by searching with Instance Name and Instance Code.
`java.lang.Long`	`createPackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pDescription, java.util.List<java.lang.String> pFiles)` Creates a package for a given project and list of files.
`java.lang.Long`	`createPackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pDescription, java.lang.Long pStreamId, PollingResult pPollingResult)` Creates a package for a given project relative to a PollingResult.
`java.lang.Long`	`createProject(ProjectPojo pProjectPojo)` Creates and configures a project with the provided data.
`java.lang.Long`	`createRelease(java.lang.String pReleaseName, java.lang.String pPipelineName, java.lang.String pDescription)` Create an empty FlexDeploy Release that defaults to 'Not Started' status.
`java.lang.Long`	`createRelease(java.lang.String pReleaseName, java.lang.String pPipelineName, java.lang.String pDescription, java.lang.String pCronSchedule)` Create an empty scheduled FlexDeploy Release that defaults to 'Not Started' status.
`java.lang.Long`	`createSCMInstance(SCMInstancePojo pSCMInstancePojo)` Creates and configures an SCM instance with the given data.
`java.lang.Long`	`createSCMInstance(java.lang.String pSCMInstanceName, java.lang.String pDescription, java.lang.Boolean pIsActive, java.lang.String pInstanceCode, java.util.List<PropertyValuePojo> pProperties, java.lang.String pSCMType)` Creates and configures an SCM Instance with the provided data.
`java.lang.Long`	`createSnapshot(java.lang.Long pReleaseId)` Create a Snapshot for a given Release.
`java.lang.Long`	`createStream(java.lang.Long pProjectId, ProjectStreamPojo pStream)` Create a FlexDeploy Stream on a given project.
`java.lang.Long`	`createStream(java.lang.Long pProjectId, java.lang.String pStreamName)` Create a FlexDeploy Stream on a given project.
`java.lang.Long`	`createStream(java.lang.Long pProjectId, java.lang.String pStreamName, java.lang.String pVersionSyntax)` Create a FlexDeploy Stream on a given project.
`void`	`deletePackage(java.lang.Long pProjectId, java.lang.String pPackageName)` Deletes a project package
`java.lang.Long`	`deployPackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pEnvironmentCode, DeployOptions pDeployOptions)` Deploys a FlexDeploy Package.
`java.lang.Long`	`deployProject(java.lang.Long pProjectId, java.lang.String pEnvironmentCode, DeployOptions pDeployOptions)` Deploys a FlexDeploy Project.
`java.lang.Integer`	`discoverFiles(java.lang.Long pProjectId, java.lang.Long pStreamId)` Populate partial deployment files for a given project.
`void`	`downloadLogs(java.lang.Long pWorkflowExecutionId, java.lang.String pDestinationPath)` Downloads the plugin logs from the workflow execution based on Id.
`void`	`downloadSnapshotCommitDetails(java.lang.Long pSnapshotId, java.lang.String pDestinationPath)` Gets the commit details of a snapshot and downloads a csv file to the destination path.
`void`	`endRelease(java.lang.Long pReleaseId)` End a FlexDeploy Release.
`void`	`endRelease(java.lang.String pReleaseName)` End a FlexDeploy Release.
`java.lang.Long`	`executeUtility(java.lang.Long pProjectId, java.lang.String pEnvironmentCode)` Executes a FlexDeploy Utility Project for a single environment on all instances configured in Project Configuration.
`java.lang.Long`	`executeUtility(java.lang.Long pProjectId, java.lang.String pEnvironmentCode, ExecuteOptions pExecuteOptions)` Executes a FlexDeploy Utility Project for a single environment with specified ExecuteOptions.
`java.lang.Long`	`findBranchId(java.lang.Long pProjectId, java.lang.String pBranchName)` Finds a FlexDeploy branch id from the Branch name.
`CMSInstancePojo`	`findCMSInstance(java.lang.String pCMSInstanceCode)` Gets a CMSInstance based on the CMS Instance Code passed.
`java.util.List<EnvironmentPojo>`	`findEnvironment(java.lang.String pEnvironmentCode)` Gets the environment with the specified Code.
`java.lang.Long`	`findFolderId(java.lang.String pFolderName)` Finds the FlexDeploy Folder id for any given name.
`java.util.List<FolderDataObject>`	`findFoldersWithName(java.lang.String pFolderName)` Finds FlexDeploy Folders for any given name
`FolderDataObject`	`findFolderWithId(java.lang.Long pFolderId)` Finds Folder using Id.
`java.util.List<InstancePojo>`	`findInstance(java.lang.String pInstanceCode)` Gets the instance with the specified Code.
`AccountInstancePojo`	`findIntegrationInstance(java.lang.String pIntegrationInstanceCode, java.lang.String pType)` Gets an integration instance based on the Id.
`PollingResult`	`findLocalChangeLogs(java.lang.String pUrl, java.lang.String pBranch, java.lang.String pCurrentRevision, java.lang.String pFromRevision)` Finds change logs for a local ssh enabled git repository.
`PollingResult`	`findLocalChangeLogs(java.lang.String pUrl, java.lang.String pBranch, java.lang.String pCurrentRevision, java.lang.String pFromRevision, boolean pIgnoreTargetBranchMerge)` Finds change logs for a local ssh enabled git repository.
`PollingResult`	`findLocalChangeLogs(java.lang.String pUrl, java.lang.String pBranch, java.lang.String pCurrentRevision, java.lang.String pFromRevision, java.lang.String pUser, java.lang.String pPassword)` Finds change logs for a local git repository.
`PollingResult`	`findLocalChangeLogs(java.lang.String pUrl, java.lang.String pBranch, java.lang.String pCurrentRevision, java.lang.String pFromRevision, java.lang.String pUser, java.lang.String pPassword, boolean pIgnoreTargetBranchMerge)` Finds change logs for a local ssh enabled git repository.
`java.util.Set<ProjectPackagePojo>`	`findPackagesForChange(java.lang.String pRepositoryName, java.lang.String pStreamName, java.util.List<java.lang.String> pChangedFiles)` Finds relevant FlexDeploy Packages for a list of changed files.
`java.util.Set<ProjectPackagePojo>`	`findPackagesForChange(java.lang.String pRepositoryName, java.lang.String pStreamName, PollingResult pPollingResult)` Finds relevant FlexDeploy Packages for any given PollingResult.
`java.lang.Long`	`findProjectId(java.lang.String pProjectName)` Finds the FlexDeploy Project id for any given name.
`java.util.Set<java.lang.Long>`	`findProjectsForChange(java.lang.String pRepositoryName, java.lang.String pStreamName, java.util.List<java.lang.String> pChangedFiles)` Finds relevant FlexDeploy Projects for a list of changed files.
`java.util.Set<java.lang.Long>`	`findProjectsForChange(java.lang.String pRepositoryName, java.lang.String pStreamName, PollingResult pPollingResult)` Finds relevant FlexDeploy Projects for any given PollingResult and stream.
`java.util.Set<java.lang.Long>`	`findProjectsForNewBranch(java.lang.String pRepositoryName)` Finds relevant FlexDeploy Projects for a new branch event.
`java.util.Set<java.lang.Long>`	`findProjectsForNewBranch(java.lang.String pRepositoryName, PollingResult pPollingResult)` Finds relevant FlexDeploy Projects for a new branch event.
`java.util.List<ProjectDataObject>`	`findProjectsWithName(java.lang.String pProjectName)` Finds FlexDeploy Projects for any given name
`ProjectDataObject`	`findProjectWithId(java.lang.Long pProjectId)` Finds Project using Id.
`java.util.List<ReleasePojo>`	`findReleases(java.lang.String pName)` Finds Releases matching the specified name.
`java.lang.Long`	`findStreamId(java.lang.Long pProjectId, java.lang.String pStreamName)` Finds a FlexDeploy stream id from the Stream name.
`ChangeManagementSystem`	`getChangeManagementSystemByInstanceCode(java.lang.String pInstanceCode)` Returns a CMS System for a particular CMS Instance by searching with Instance Code.
`ChangeManagementSystem`	`getChangeManagementSystemByInstanceId(java.lang.Long pCMSInstanceId)` Returns a CMS System for a particular CMS Instance Id.
`ChangeManagementSystem`	`getChangeManagementSystemByInstanceName(java.lang.String pInstanceName)` Returns a CMS System for a particular CMS Instance by searching with Instance Name.
`CMSInstancePojo`	`getCMSInstance(java.lang.Long pCMSInstanceId)` Gets a CMSInstance based on the CMS Instance Id passed.
`java.lang.Long`	`getCurrentlyDeployedVersionId(java.lang.Long pProjectId, java.lang.Long pEnvironmentId, java.lang.Long pInstanceId)` Returns currently deployed project version Id of full deployment project.
`java.lang.Long`	`getCurrentlyDeployedVersionId(java.lang.Long pProjectId, java.lang.Long pEnvironmentId, java.lang.Long pInstanceId, java.lang.String pPackageName)` Returns currently deployed project version Id of partial deployment project.
`EnvironmentPojo`	`getEnvironment(java.lang.Long pEnvironmentId)` Gets the environment with the specified Id.
`java.lang.String`	`getFlexDeployBaseUrl()` Returns the FlexDeploy Server base url configured in System Settings.
`java.lang.String`	`getGroovyKey()`
`InstancePojo`	`getInstance(java.lang.Long pInstanceId)` Gets the instance with the specified Id.
`AccountInstancePojo`	`getIntegrationInstance(java.lang.Long pIntegrationInstanceId, java.lang.String pType)` Gets an integration instance based on the Id.
`IssueTrackingSystem`	`getIssueTrackingSystemByInstanceCode(java.lang.String pInstanceCode)` Returns a ITS System for a particular ITS Instance Code.
`IssueTrackingSystem`	`getIssueTrackingSystemByInstanceId(java.lang.Long pITSInstanceId)` Returns a ITS System for a particular ITS Instance Id.
`IssueTrackingSystem`	`getIssueTrackingSystemByInstanceName(java.lang.String pInstanceName)` Returns a ITS System for a particular ITS Instance Name.
`java.lang.Long`	`getMatchingProjectObjectId(java.lang.Long pProjectId, java.lang.String pFile)` Returns internal id for file in a project.
`PackageDetailsResponsePojo`	`getPackage(java.lang.Long pProjectId, java.lang.String pPackageName)` Returns a PackageDetailsResponsePojo given a Project Id and Package Name
`StageExecutionInformationPOJO`	`getPipelineStageExecutionInfo(java.lang.Long pStageExecId)` Gets pipeline stage execution info based on the stage exec Id given.
`StepProjectsRequestPojo`	`getPipelineStepProjectsExecution(java.lang.Long pStageExecId, java.lang.Long pStepId)` Get the project request and execution statuses for a given pipeline step execution
`StepProjectsRequestPojo`	`getPipelineStepProjectsExecution(java.lang.Long pStageExecId, java.lang.String pStepName)` Get the project request and execution statuses for a given pipeline step execution
`java.util.Map<java.lang.Long,java.io.InputStream>`	`getPluginLogInputStreams(java.lang.Long pWorkflowExecutionId)` Returns plugin logs from a workflow execution as a map with the key being the plugin execution id and value as an InputStream of log data.
`java.util.Map<java.lang.Long,java.io.InputStream>`	`getPluginLogInputStreams(java.lang.Long pWorkflowExecutionId, java.lang.Boolean pOnlyError)` Returns plugin logs from a workflow execution as a map with the key being the plugin execution id and value as an InputStream of log data.
`java.util.Collection<PluginLogPojo>`	`getPluginLogs(java.lang.Long pWorkflowExecutionId)` Gets the plugin logs from the workflow execution based on Id.
`java.lang.Long`	`getPreviouslyDeployedVersionId(java.lang.Long pProjectId, java.lang.Long pEnvironmentId, java.lang.Long pInstanceId)` Returns previously deployed project version Id of full deployment project.
`java.lang.Long`	`getPreviouslyDeployedVersionId(java.lang.Long pProjectId, java.lang.Long pEnvironmentId, java.lang.Long pInstanceId, java.lang.String pPackageName)` Returns previously deployed project version Id of partial deployment project.
`ProjectPojo`	`getProject(java.lang.Long pProjectId)` Returns project information for a given projectId.
`ReleasePojo`	`getRelease(java.lang.Long pId)` Gets a release by a specific id.
`java.util.List<ReleaseProjectDetailsPojo>`	`getReleaseProjectInfo(java.lang.Long pReleaseDefId)` Gets release project info based on the release definition Id.
`ScanResultPojo`	`getScanResultForSonarqube(java.lang.String pBaseUrl, java.lang.String pProjectKey)` get Scan result for SonarQube
`java.io.InputStream`	`getSnapshotCommitDetailInputStreams(java.lang.Long pSnapshotId)` Gets the commit details of a snapshot and returns an input stream of the data.
`java.util.List<ReleaseSnapshotCommitDetailsPojo>`	`getSnapshotCommitDetails(java.lang.Long pSnapshotId)` Gets the commit details of a snapshot and returns an object with the data.
`FdUserDataObject`	`getUser(java.lang.String pUsername)` Returns user information for a given username.
`java.util.List<FDUser>`	`getUsersFromGroupId(java.lang.Long pGroupId)` Gets a list of FDUser objects that are members of the group with the given group Id.
`java.util.List<FDUser>`	`getUsersFromRoleId(java.lang.Long pRoleId)` Gets a list of the users that are members of the pipeline role with the specified role Id.
`void`	`inactivateBranch(java.lang.Long pProjectId, java.lang.String pBranchName)` Inactivates a project stream using AM method to patch stream
`void`	`inactivateStream(java.lang.Long pProjectId, java.lang.String pStreamName)` Inactivates a project stream using AM method to patch stream
`void`	`patchBranch(java.lang.Long pProjectId, java.lang.Long pBranchId, ProjectStreamDataObject pBranch)` Patches a FlexDeploy Branch on a given project.
`java.lang.Long`	`patchProject(java.lang.Long pProjectId, ProjectPojo pProjectPojo)` Updates a project with the provided data.
`java.lang.Long`	`patchProjectProperties(java.lang.Long pProjectId, java.util.List<PropertyValuePojo> pPropertyPojos)` Updates a project's properties with the provided data.
`void`	`patchStream(java.lang.Long pProjectId, java.lang.Long pStreamId, ProjectStreamDataObject pStream)` Patches a FlexDeploy Stream on a given project.
`void`	`pauseRelease(java.lang.Long pReleaseId)` Pause a FlexDeploy Release.
`void`	`pauseRelease(java.lang.String pReleaseName)` Pause a FlexDeploy Release.
`java.lang.Integer`	`populateFiles(java.lang.Long pProjectId, java.lang.Long pStreamId)` Deprecated.
`void`	`rejectTask(java.lang.String pUsername, java.lang.String pTaskIdentifier, java.lang.String pNotes)` Reject a FlexDeploy Task.
`void`	`removeProjectsFromRelease(java.lang.String pReleaseName, java.util.List<ReleaseProjectsPojo> pReleaseProjects)` Remove FlexDeploy projects from a given release.
`<any>`	`searchBranches(ProjectStreamDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Branches using criteria values provided.
`<any>`	`searchFolders(FolderDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Folders using criteria values provided.
`<any>`	`searchProjectPackages(ProjectPackageDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Packages using criteria values provided.
`<any>`	`searchProjects(ProjectDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)` Find Projects using criteria values provided.
`void`	`startRelease(java.lang.Long pReleaseId)` Start a FlexDeploy Release.
`void`	`startRelease(java.lang.String pReleaseName)` Start a FlexDeploy Release.
`void`	`updateBranch(java.lang.Long pProjectId, java.lang.Long pBranchId, ProjectStreamPojo pBranch)` Updates a FlexDeploy Branch on a given project.
`void`	`updatePackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.Long pStreamId, PollingResult pPollingResult)` Updates a given package relative to a PollingResult.
`void`	`updatePackage(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.Long pStreamId, PollingResult pPollingResult, boolean pSortFiles)` Updates a given package relative to a PollingResult.
`void`	`updatePackageStatus(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pPackageStatus)` Updates a given package status.
`java.lang.Long`	`updateProject(java.lang.Long pProjectId, ProjectPojo pProjectPojo)` Updates a project with the provided data.
`java.lang.Long`	`updateProjectProperties(java.lang.Long pProjectId, java.util.List<PropertyValuePojo> pPropertyPojos)` Updates a project's properties with the provided data.
`java.lang.Long`	`updateReleaseProperty(java.lang.Long pReleaseDefId, java.lang.String pPropertyKeyCode, java.io.Serializable pNewValue)` Updates a release's property with the provided property key code.
`void`	`updateScanResult(java.lang.Long pProjectId, java.lang.String pScanId, ScanResultPojo pScanResultPojo, boolean pIsStatusSuccess)` Updates a FlexDeploy ScanResult on a given project.
`java.lang.Long`	`updateSCMInstance(java.lang.Long pSCMInstanceId, SCMInstancePojo pSCMInstancePojo)` Updates an SCM instance with the given data.
`java.lang.Long`	`updateSCMInstance(java.lang.Long pSCMInstanceId, java.lang.String pSCMInstanceName, java.lang.String pDescription, java.lang.Boolean pIsActive, java.lang.String pInstanceCode, java.util.List<PropertyValuePojo> pProperties, java.lang.String pSCMType)` Updates an SCM instance with the given data.
`java.lang.Long`	`updateSnapshotVariable(java.lang.Long pSnapshotId, java.lang.String pVariableCode, java.io.Serializable pNewValue)` Updates a snapshot's variable with the provided variable code.
`void`	`updateStream(java.lang.Long pProjectId, java.lang.Long pStreamId, ProjectStreamPojo pStream)` Updates a FlexDeploy Stream on a given project.

Methods inherited from class flexagon.fd.services.groovy.functions.BaseFunctions
approveTask, approveTaskByEmails, completeManualStepBySnapshotId, completeManualStepByTaskId, decryptIntegrationInstance, doSimpleGet, findIntegrationInstance, getLogFunctions, getServerBaseUrl, rejectTask, rejectTaskByEmails

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

- Constructor Detail
  - FlexDeployFunctions
```
public FlexDeployFunctions(boolean isExecute,
                           LogFunctions pFLOG)
```
- Method Detail
  - findLocalChangeLogs
```
public PollingResult findLocalChangeLogs(java.lang.String pUrl,
                                         java.lang.String pBranch,
                                         java.lang.String pCurrentRevision,
                                         java.lang.String pFromRevision)
                                  throws FlexCheckedException
```
    Finds change logs for a local ssh enabled git repository. This can be used as a replacement for the getChangeLogs functions if your git provider doesn't have a specific function. If fromRevision is null it will return an empty PollingResult object. If your repository is not ssh enabled see findLocalChangeLogs
    
    Parameters:
    
    pUrl - Url of the git repository to find logs against
    
    pBranch - Branch to find logs against
    
    pCurrentRevision - Current revision after the push
    
    pFromRevision - Previous revision before the push
    
    Returns:
    
    PollingResult object containing the change logs found.
    
    Throws:
    
    FlexDeployValidationException - if an invalid revision is passed.
    
    FlexCheckedException
    
    Since:
    
    5.3.0.1
  - findLocalChangeLogs
```
public PollingResult findLocalChangeLogs(java.lang.String pUrl,
                                         java.lang.String pBranch,
                                         java.lang.String pCurrentRevision,
                                         java.lang.String pFromRevision,
                                         boolean pIgnoreTargetBranchMerge)
                                  throws FlexCheckedException
```
    Finds change logs for a local ssh enabled git repository. This can be used as a replacement for the getChangeLogs functions if your git provider doesn't have a specific function. If fromRevision is null it will return an empty PollingResult object. If your repository is not ssh enabled see findLocalChangeLogs
    
    Parameters:
    
    pUrl - Url of the git repository to find logs against
    
    pBranch - Branch to find logs against
    
    pCurrentRevision - Current revision after the push
    
    pFromRevision - Previous revision before the push
    
    pIgnoreTargetBranchMerge - Exclude commits that were merged from the target branch into this branch. When using git flow this will ignore merges done from the target branch 'develop' into your feature branch. Default value is true
    
    Returns:
    
    PollingResult object containing the change logs found.
    
    Throws:
    
    FlexDeployValidationException - if an invalid revision is passed.
    
    FlexCheckedException
    
    Since:
    
    5.3.0.3
  - findLocalChangeLogs
```
public PollingResult findLocalChangeLogs(java.lang.String pUrl,
                                         java.lang.String pBranch,
                                         java.lang.String pCurrentRevision,
                                         java.lang.String pFromRevision,
                                         java.lang.String pUser,
                                         java.lang.String pPassword)
                                  throws FlexCheckedException
```
    Finds change logs for a local git repository. This can be used as a replacement for the getChangeLogs functions if your git provider doesn't have a specific function. If fromRevision is null it will return an empty PollingResult object
    
    Parameters:
    
    pUrl - Url of the git repository to find logs against
    
    pBranch - Branch to find logs against
    
    pCurrentRevision - Current revision after the push
    
    pFromRevision - Previous revision before the push
    
    pUser - User to use for local credentials
    
    pPassword - Password of the user
    
    Returns:
    
    PollingResult object containing the change logs found.
    
    Throws:
    
    FlexDeployValidationException - if an invalid revision is passed.
    
    FlexCheckedException
    
    Since:
    
    5.3.0.1
  - findLocalChangeLogs
```
public PollingResult findLocalChangeLogs(java.lang.String pUrl,
                                         java.lang.String pBranch,
                                         java.lang.String pCurrentRevision,
                                         java.lang.String pFromRevision,
                                         java.lang.String pUser,
                                         java.lang.String pPassword,
                                         boolean pIgnoreTargetBranchMerge)
                                  throws FlexCheckedException
```
    Finds change logs for a local ssh enabled git repository. This can be used as a replacement for the getChangeLogs functions if your git provider doesn't have a specific function. If fromRevision is null it will return an empty PollingResult object. If your repository is not ssh enabled see findLocalChangeLogs
    
    Parameters:
    
    pUrl - Url of the git repository to find logs against
    
    pBranch - Branch to find logs against
    
    pCurrentRevision - Current revision after the push
    
    pFromRevision - Previous revision before the push
    
    pUser - User to use for local credentials
    
    pPassword - Password of the user
    
    pIgnoreTargetBranchMerge - Exclude commits that were merged from the target branch into this branch. When using git flow this will ignore merges done from the target branch 'develop' into your feature branch. Default value is true
    
    Returns:
    
    PollingResult object containing the change logs found.
    
    Throws:
    
    FlexDeployValidationException - if an invalid revision is passed.
    
    FlexCheckedException
    
    Since:
    
    5.3.0.3
  - getProject
```
public ProjectPojo getProject(java.lang.Long pProjectId)
                       throws FlexDeployRowNotFoundException
```
    Returns project information for a given projectId.
    
    Parameters:
    
    pProjectId - Project Id of the project to retrieve
    
    Returns:
    
    Object containing meta data about the given project
    
    Throws:
    
    FlexDeployRowNotFoundException - if no project is found for given pProjectId
    
    Since:
    
    5.3.0.1
  - getRelease
```
public ReleasePojo getRelease(java.lang.Long pId)
```
    Gets a release by a specific id.
    
    Parameters:
    
    pId - Release Id
    
    Returns:
    
    Object containing Release metadata
    
    Throws:
    
    FlexDeployRowNotFoundException - if no Release is found for the given pId
    
    Since:
    
    5.3.0.1
  - findReleases
```
public java.util.List<ReleasePojo> findReleases(java.lang.String pName)
                                         throws FlexDeployRowNotFoundException
```
    Finds Releases matching the specified name. Search uses an ignore case and contains on the Release Name. Unlike getRelease this method returns a list of Releases.
    
    Parameters:
    
    pName - Name to search by
    
    Returns:
    
    A List of Release objects containing Release information.
    
    Throws:
    
    FlexDeployRowNotFoundException - if no releases match the naming criteria pName
    
    Since:
    
    5.3.0.1
  - createProject
```
public java.lang.Long createProject(ProjectPojo pProjectPojo)
```
    Creates and configures a project with the provided data. Returns the Id of the project after creation.
    
    Parameters:
    
    pProjectPojo - - Object containing project configuration information.
    
    Returns:
    
    Id of the created project
    
    Since:
    
    5.4.0.1
  - updateProject
```
public java.lang.Long updateProject(java.lang.Long pProjectId,
                                    ProjectPojo pProjectPojo)
```
    Updates a project with the provided data.
    
    Parameters:
    
    pProjectId - - Id of the project that is to be updated.
    
    pProjectPojo- - Object containing project configuration information.
    
    Returns:
    
    Id of the updated project.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pProjectId does not exist.
    
    Since:
    
    5.4.0.1
  - patchProject
```
public java.lang.Long patchProject(java.lang.Long pProjectId,
                                   ProjectPojo pProjectPojo)
```
    Updates a project with the provided data. This will only update fields that are passed in the pojo. Returns the Id of the project after updating.
    
    Parameters:
    
    pProjectId - - Id of the project that is to be updated.
    
    pProjectPojo- - Object containing project configuration information.
    
    Returns:
    
    Id of the updated project.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pProjectId does not exist.
    
    Since:
    
    5.4.0.1
  - updateProjectProperties
```
public java.lang.Long updateProjectProperties(java.lang.Long pProjectId,
                                              java.util.List<PropertyValuePojo> pPropertyPojos)
```
    Updates a project's properties with the provided data. This will only update properties that are passed in the list. Returns the Id of the project after updating.
    
    Parameters:
    
    pProjectId - - Id of the project that is to be updated.
    
    pPropertyPojos - - List of property values to be updated on project.
    
    Returns:
    
    Id of the updated project.
    
    Since:
    
    5.4.0.1
  - patchProjectProperties
```
public java.lang.Long patchProjectProperties(java.lang.Long pProjectId,
                                             java.util.List<PropertyValuePojo> pPropertyPojos)
```
    Updates a project's properties with the provided data. This will only update properties that are passed in the list.
    
    Parameters:
    
    pProjectId - - Id of the project that is to be updated.
    
    pPropertyPojos - - List of property values to be updated on project.
    
    Returns:
    
    Id of the updated project.
    
    Since:
    
    5.4.0.1
  - addFilesToPackage
```
public void addFilesToPackage(java.lang.Long pProjectId,
                              java.lang.String pPackageName,
                              java.util.List<java.lang.String> pFiles)
                       throws FlexDeployRowNotFoundException
```
    Adds files to a given package. The files should match the filepath found in the File Catalog on the project.
    
    Parameters:
    
    pProjectId - Parent project id of the package
    
    pPackageName - Name of the package
    
    pFiles - Filepaths to add to the package.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pPackageName does not exist on project pProjectId.
  - populateFiles
```
@Deprecated
public java.lang.Integer populateFiles(java.lang.Long pProjectId,
                                                   java.lang.Long pStreamId)
```
    Deprecated.
    
    Populate partial deployment files for a given project. This will automatically save populate changes so it should only be used after commands and attributes have been validated.
    
    Parameters:
    
    pProjectId - Project id to populate files for. This should be a project using partial deployment.
    
    pStreamId - Stream id to use when populating.
    
    Returns:
    
    The number of new files found during populate.
    
    Throws:
    
    FlexDeployAPIException - if it is message wrapper error.
    
    See Also:
    
    findStreamId(java.lang.Long, java.lang.String)
  - discoverFiles
```
public java.lang.Integer discoverFiles(java.lang.Long pProjectId,
                                       java.lang.Long pStreamId)
```
    Populate partial deployment files for a given project. This will automatically save populate changes so it should only be used after commands and attributes have been validated.
    
    Parameters:
    
    pProjectId - Project id to populate files for. This should be a project using partial deployment.
    
    pStreamId - Stream id to use when populating.
    
    Returns:
    
    The number of new files found during populate.
    
    Throws:
    
    FlexDeployAPIException - if it is message wrapper error.
    
    See Also:
    
    findStreamId(java.lang.Long, java.lang.String)
  - updatePackageStatus
```
public void updatePackageStatus(java.lang.Long pProjectId,
                                java.lang.String pPackageName,
                                java.lang.String pPackageStatus)
```
    Updates a given package status.
    
    Parameters:
    
    pProjectId - Parent project id of the package
    
    pPackageName - Name of the package
    
    pPackageStatu} - The updated package status [ACTIVE, COMPLETED, or INACTIVE]
    
    Throws:
    
    FlexDeployRowNotFoundException - if pProjectId is not found or pPackageName doesnt exist on project
    
    FlexDeployValidationException - if pPackageStatus is invalid
  - updatePackage
```
public void updatePackage(java.lang.Long pProjectId,
                          java.lang.String pPackageName,
                          java.lang.Long pStreamId,
                          PollingResult pPollingResult)
```
    Updates a given package relative to a PollingResult. For manually adding files to a package use the addFilesToPackagemethod. This function will automatically populate files if new files are detected. Files added to this package are always added to the end of the list.
    
    Parameters:
    
    pProjectId - Parent project id of the package
    
    pPackageName - Name of the package
    
    pStreamId - Stream to use when populating files if new files are found
    
    pPollingResult - PollingResult object to use for finding differences
    
    Throws:
    
    FlexDeployRowNotFoundException - if pProjectId is not found or pPackageName doesnt exist on project
    
    FlexDeployValidationException - if project other than SCM Type GIT is invalid.
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - updatePackage
```
public void updatePackage(java.lang.Long pProjectId,
                          java.lang.String pPackageName,
                          java.lang.Long pStreamId,
                          PollingResult pPollingResult,
                          boolean pSortFiles)
```
    Updates a given package relative to a PollingResult. For manually adding files to a package use the addFilesToPackagemethod. This function will automatically populate files if new files are detected. The files in this package can optionally be sorted by their project files sequence number.
    
    Parameters:
    
    pProjectId - Parent project id of the package
    
    pPackageName - Name of the package
    
    pStreamId - Stream to use when populating files if new files are found
    
    pPollingResult - PollingResult object to use for finding differences
    
    pSortFiles - Sort package files after update
    
    Throws:
    
    FlexDeployRowNotFoundException - if pProjectId is not found or pPackageName doesnt exist on project
    
    FlexDeployValidationException - if project other than SCM Type GIT is invalid.
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - createPackage
```
public java.lang.Long createPackage(java.lang.Long pProjectId,
                                    java.lang.String pPackageName,
                                    java.lang.String pDescription,
                                    java.util.List<java.lang.String> pFiles)
```
    Creates a package for a given project and list of files.
    
    Parameters:
    
    pProjectId - Parent project id to create package under.
    
    pPackageName - Package name to use.
    
    pDescription - Description to give the package.
    
    pFiles - List of files to add to the package. File paths should be as they appear in the File Catalog of the project.
    
    Returns:
    
    Package id
  - createDynamicPackage
```
public java.lang.Long createDynamicPackage(java.lang.Long pProjectId,
                                           java.lang.String pPackageName,
                                           java.lang.String pDescription,
                                           java.lang.String pIncludePath,
                                           java.lang.String pExcludePath)
```
    Creates a dynamic package for given include and exclude path.
    
    Parameters:
    
    pProjectId - Parent project id to create package under.
    
    pPackageName - Package name to use.
    
    pDescription - Description to give the package.
    
    pIncludePath - files to be included in the package.
    
    pExcludePath - files to be excluded in the package.
    
    Returns:
    
    Package id
  - createPackage
```
public java.lang.Long createPackage(java.lang.Long pProjectId,
                                    java.lang.String pPackageName,
                                    java.lang.String pDescription,
                                    java.lang.Long pStreamId,
                                    PollingResult pPollingResult)
```
    Creates a package for a given project relative to a PollingResult.
    
    Parameters:
    
    pProjectId - Parent project id of the package
    
    pPackageName - Name of the package
    
    pDescription - Description to give the package.
    
    pPollingResult - PollingResult object to use for finding differences
    
    Throws:
    
    FlexDeployRowNotFoundException - if pProjectId is not found or pPackageName doesnt exist on project
    
    FlexDeployValidationException - if project pProjectId is invalid,
    
    Since:
    
    5.5.0.3
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - deletePackage
```
public void deletePackage(java.lang.Long pProjectId,
                          java.lang.String pPackageName)
```
    Deletes a project package
    
    Parameters:
    
    pProjectId - Parent project id package is under.
    
    pPackageName - Name of package to delete.
    
    Throws:
    
    FlexDeployOptimisticLockException - if another user updated or deleted row.
  - buildPackage
```
public java.lang.Long buildPackage(java.lang.Long pStreamId,
                                   ProjectPackagePojo projectPackage)
```
    Builds a FlexDeploy Package. This function will gather change logs and commiter information from scm. If you have this information already you can improve performance by using PollingResult variant
    
    Parameters:
    
    pStreamId - Stream to use when building package. See findStreamId.
    
    projectPackage - Wrapper object containing project id and package name to build.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamId not found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
  - buildPackage
```
public java.lang.Long buildPackage(java.lang.Long pStreamId,
                                   ProjectPackagePojo projectPackage,
                                   BuildOptions pBuildOptions)
```
    Builds a FlexDeploy Package. This function will gather change logs and commiter information from scm. If you have this information already you can improve performance by using PollingResult variant
    
    Parameters:
    
    pStreamId - Stream to use when building package. See findStreamId.
    
    projectPackage - Wrapper object containing project id and package name to build.
    
    pBuildOptions - Additional build object where optional options can be set.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamId not found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
  - buildPackage
```
public java.lang.Long buildPackage(java.lang.Long pStreamId,
                                   ProjectPackagePojo projectPackage,
                                   PollingResult pPollingResult,
                                   BuildOptions pBuildOptions)
```
    Builds a FlexDeploy Package using a PollingResult.
    
    Parameters:
    
    pStreamId - Stream to use when building package. See findStreamId.
    
    projectPackage - Wrapper object containing project id and package name to build.
    
    pPollingResult - PollingResult object containing change logs and committer information.
    
    pBuildOptions - Additional build object where optional options can be set.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamId not found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - buildProject
```
public java.lang.Long buildProject(java.lang.Long pStreamId,
                                   java.lang.Long pProjectId)
```
    Builds a FlexDeploy Project. This function will gather change logs and commiter information from scm. If you have this information already you can improve performance by using PollingResult variant
    
    Parameters:
    
    pStreamId - Stream to use when building project. See findStreamId.
    
    pProjectId - Project id to build.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamId not found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
  - buildProject
```
public java.lang.Long buildProject(java.lang.Long pStreamId,
                                   java.lang.Long pProjectId,
                                   BuildOptions pBuildOptions)
```
    Builds a FlexDeploy Project. This function will gather change logs and commiter information from scm. If you have this information already you can improve performance by using PollingResult variant
    
    Parameters:
    
    pStreamId - Stream to use when building project. See findStreamId.
    
    pProjectId - Project id to build.
    
    pBuildOptions - Additional build object where optional options can be set.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamId not found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
  - buildProject
```
public java.lang.Long buildProject(java.lang.Long pStreamId,
                                   java.lang.Long pProjectId,
                                   PollingResult pPollingResult,
                                   BuildOptions pBuildOptions)
```
    Builds a FlexDeploy Project using a PollingResult.
    
    Parameters:
    
    pStreamId - Stream to use when building project. See findStreamId.
    
    pProjectId - Project id to build.
    
    pPollingResult - PollingResult object containing change logs and committer information.
    
    pBuildOptions - Additional build object where optional options can be set.
    
    Returns:
    
    Long WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamId not found in project. if no row found for project. if default build environment not found
    
    FlexDeployValidationException - if requested project is a utility project. if requested project is not active. if no build workflow or target group mapped for the project.
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - deployPackage
```
public java.lang.Long deployPackage(java.lang.Long pProjectId,
                                    java.lang.String pPackageName,
                                    java.lang.String pEnvironmentCode,
                                    DeployOptions pDeployOptions)
```
    Deploys a FlexDeploy Package.
    
    Parameters:
    
    pProjectId - Project id to deploy.
    
    pPackageName - Name of package
    
    pEnvironmentCode - Code of the enviornment.
    
    pDeployOptions - Additional deploy object where optional options can be set.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pProjectId. if no row found for pEnvironmentCode. if no row found for pPackageName.
    
    FlexDeployValidationException - if pEnvironmentCode is missing. if requested project is a utility project. if requested project is not active. if no deploy workflow or target group mapped for the project. if package name given for standard project.
  - deployProject
```
public java.lang.Long deployProject(java.lang.Long pProjectId,
                                    java.lang.String pEnvironmentCode,
                                    DeployOptions pDeployOptions)
```
    Deploys a FlexDeploy Project.
    
    Parameters:
    
    pProjectId - Project id to deploy.
    
    pEnvironmentCode - Code of the enviornment.
    
    pDeployOptions - Additional deploy object where optional options can be set.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pProjectId. if no row found for pEnvironmentCode.
    
    FlexDeployValidationException - if pEnvironmentCode is missing. if requested project is a utility project. if requested project is not active. if no deploy workflow or target group mapped for the project.
  - findProjectsForNewBranch
```
public java.util.Set<java.lang.Long> findProjectsForNewBranch(java.lang.String pRepositoryName)
```
    Finds relevant FlexDeploy Projects for a new branch event. All webhook enabled projects using this repository will be returned. This function currently only compares against Git repositories and is not compatible with other scm types.
    
    Parameters:
    
    pRepositoryName - Git repository name with the change. Name is of the form (username/repo). e.g. toddmotto/public-apis
    
    Returns:
    
    List of Project ids
    
    Since:
    
    5.3.0.1
  - findProjectsForNewBranch
```
public java.util.Set<java.lang.Long> findProjectsForNewBranch(java.lang.String pRepositoryName,
                                                              PollingResult pPollingResult)
```
    Finds relevant FlexDeploy Projects for a new branch event. Only projects whose sources use the files found in the polling result will be returned. If you want to return ALL projects regardless of changed files then use findProjectsForNewBranch. This function currently only compares against Git repositories and is not compatible with other scm types.
    
    Parameters:
    
    pRepositoryName - Git repository name with the change. Name is of the form (username/repo). e.g. toddmotto/public-apis
    
    pPollingResult - PollingResult object for determining relevant projects.
    
    Returns:
    
    List of Project ids
    
    Since:
    
    5.3.0.1
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - findProjectsForChange
```
public java.util.Set<java.lang.Long> findProjectsForChange(java.lang.String pRepositoryName,
                                                           java.lang.String pStreamName,
                                                           PollingResult pPollingResult)
```
    Finds relevant FlexDeploy Projects for any given PollingResult and stream. A project must have a webhook trigger configured for this stream on the CI tab in order to be found by this function. This function currently only compares against Git repositories and is not compatible with other scm types.
    
    Parameters:
    
    pRepositoryName - Git repository name with the change. Name is of the form (username/repo). e.g. toddmotto/public-apis
    
    pStreamName - Stream/branch name for which the change occurred. e.g. 'master'
    
    pPollingResult - PollingResult object for determining relevant projects.
    
    Returns:
    
    List of Project ids
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - findProjectsForChange
```
public java.util.Set<java.lang.Long> findProjectsForChange(java.lang.String pRepositoryName,
                                                           java.lang.String pStreamName,
                                                           java.util.List<java.lang.String> pChangedFiles)
```
    Finds relevant FlexDeploy Projects for a list of changed files. A project must have a webhook trigger configured for this stream on the CI tab in order to be found by this function. This function currently only compares against Git repositories and is not compatible with other scm types.
    
    Parameters:
    
    pRepositoryName - Git repository name with the change. Name is of the form (username/repo). e.g. toddmotto/public-apis
    
    pStreamName - Stream/branch name for which the change occurred. e.g. 'master'
    
    pChangedFiles - List of changed files from a push event. If no files are passed then all projects using given repository will be returned.
    
    Returns:
    
    List of Project ids
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - findPackagesForChange
```
public java.util.Set<ProjectPackagePojo> findPackagesForChange(java.lang.String pRepositoryName,
                                                               java.lang.String pStreamName,
                                                               PollingResult pPollingResult)
```
    Finds relevant FlexDeploy Packages for any given PollingResult. A package must have a webhook trigger configured with this stream on the CI tab in order to be found by this function. This function currently only compares against Git repositories and is not compatible with other scm types.
    
    Parameters:
    
    pRepositoryName - Git repository name with the change. Name is of the form (username/repo). e.g. toddmotto/public-apis
    
    pStreamName - Stream/branch name for which the change occurred. e.g. 'master'
    
    pPollingResult - PollingResult object for determining relevant packages.
    
    Returns:
    
    List of ProjectPackages
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - findPackagesForChange
```
public java.util.Set<ProjectPackagePojo> findPackagesForChange(java.lang.String pRepositoryName,
                                                               java.lang.String pStreamName,
                                                               java.util.List<java.lang.String> pChangedFiles)
```
    Finds relevant FlexDeploy Packages for a list of changed files. A package must have a webhook trigger configured with this stream on the CI tab in order to be found by this function. This function currently only compares against Git repositories and is not compatible with other scm types.
    
    Parameters:
    
    pRepositoryName - Git repository name with the change. Name is of the form (username/repo). e.g. toddmotto/public-apis
    
    pStreamName - Stream/branch name for which the change occurred. e.g. 'master'
    
    pChangedFiles - List of changed files from a push event. If no files are passed then all packages using given repository will be returned.
    
    Returns:
    
    List of ProjectPackages
    
    See Also:
    
    BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String), GithubFunctions.getChangeLogs(java.lang.Object)
  - findProjectId
```
public java.lang.Long findProjectId(java.lang.String pProjectName)
```
    Finds the FlexDeploy Project id for any given name. This will only work properly if all project names are unique.
    
    Parameters:
    
    pProjectName - Case sensitive project name to search by
    
    Returns:
    
    Project id
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pProjectName.
  - findProjectWithId
```
public ProjectDataObject findProjectWithId(java.lang.Long pProjectId)
```
    Finds Project using Id.
    
    Parameters:
    
    pProjectId- - Id of Project to find.
    
    Returns:
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pProjectId.
  - findProjectsWithName
```
public java.util.List<ProjectDataObject> findProjectsWithName(java.lang.String pProjectName)
```
    Finds FlexDeploy Projects for any given name
    
    Parameters:
    
    pProjectName - Case insensitive project name to search by
    
    Returns:
  - searchProjects
```
public <any> searchProjects(ProjectDataObject pCriteriaObject,
                            java.lang.Integer pLimit,
                            java.lang.Integer pOffset)
```
    Find Projects using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject -
    
    pLimit -
    
    pOffset -
    
    Returns:
  - createRelease
```
public java.lang.Long createRelease(java.lang.String pReleaseName,
                                    java.lang.String pPipelineName,
                                    java.lang.String pDescription)
                             throws FlexCheckedException
```
    Create an empty FlexDeploy Release that defaults to 'Not Started' status.
    
    Parameters:
    
    pReleaseName - Name to give Release.
    
    pPipelineName - Pipeline name to use for the Release.
    
    pDescription - Optional description to give the Release.
    
    Returns:
    
    Release id
    
    Throws:
    
    FlexDeployValidationException - when creation of release gets failed.
    
    FlexCheckedException
  - createRelease
```
public java.lang.Long createRelease(java.lang.String pReleaseName,
                                    java.lang.String pPipelineName,
                                    java.lang.String pDescription,
                                    java.lang.String pCronSchedule)
                             throws FlexCheckedException
```
    Create an empty scheduled FlexDeploy Release that defaults to 'Not Started' status.
    
    Parameters:
    
    pReleaseName - Name to give Release.
    
    pPipelineName - Pipeline name to use for the Release.
    
    pDescription - Optional description to give the Release.
    
    pCronSchedule - Cron schedule to give the Release.
    
    Returns:
    
    Release id
    
    Throws:
    
    FlexDeployValidationException - when creation of release gets failed.
    
    FlexCheckedException
  - endRelease
```
public void endRelease(java.lang.String pReleaseName)
                throws FlexCheckedException,
                       FlexNotFoundException
```
    End a FlexDeploy Release.
    
    Parameters:
    
    pReleaseName - Release name to end.
    
    Throws:
    
    FlexNotFoundException - if Release is not found
    
    FlexCheckedException
  - endRelease
```
public void endRelease(java.lang.Long pReleaseId)
                throws FlexCheckedException,
                       FlexNotFoundException
```
    End a FlexDeploy Release.
    
    Parameters:
    
    pReleaseId - Release id to end.
    
    Throws:
    
    FlexNotFoundException - if Release is not found
    
    FlexCheckedException
  - pauseRelease
```
public void pauseRelease(java.lang.String pReleaseName)
                  throws FlexCheckedException,
                         FlexNotFoundException
```
    Pause a FlexDeploy Release.
    
    Parameters:
    
    pReleaseName - Release name to pause.
    
    Throws:
    
    FlexNotFoundException - if Release is not found
    
    FlexCheckedException
    
    Since:
    
    5.3.0.2
  - pauseRelease
```
public void pauseRelease(java.lang.Long pReleaseId)
                  throws FlexCheckedException,
                         FlexNotFoundException
```
    Pause a FlexDeploy Release.
    
    Parameters:
    
    pReleaseId - Release id to pause.
    
    Throws:
    
    FlexNotFoundException - if Release is not found
    
    FlexCheckedException
    
    Since:
    
    5.3.0.2
  - startRelease
```
public void startRelease(java.lang.String pReleaseName)
                  throws FlexCheckedException,
                         FlexNotFoundException
```
    Start a FlexDeploy Release.
    
    Parameters:
    
    pReleaseName - Release name to start.
    
    Throws:
    
    FlexNotFoundException - if Release is not found
    
    FlexCheckedException
  - startRelease
```
public void startRelease(java.lang.Long pReleaseId)
                  throws FlexCheckedException,
                         FlexNotFoundException
```
    Start a FlexDeploy Release.
    
    Parameters:
    
    pReleaseId - Release id to start.
    
    Throws:
    
    FlexNotFoundException - if Release is not found
    
    FlexCheckedException
  - addProjectsToRelease
```
public void addProjectsToRelease(java.lang.String pReleaseName,
                                 java.util.List<ReleaseProjectsPojo> pReleaseProjects)
                          throws FlexCheckedException,
                                 FlexDeployRowNotFoundException
```
    Add FlexDeploy projects to a given release.
    
    Parameters:
    
    pReleaseName - Release name to add projects to.
    
    pReleaseProjects - List of ReleaseProjects to add.
    
    Throws:
    
    FlexCheckedException
    
    FlexNotFoundException - if Release is not found
    
    FlexDeployRowNotFoundException
  - removeProjectsFromRelease
```
public void removeProjectsFromRelease(java.lang.String pReleaseName,
                                      java.util.List<ReleaseProjectsPojo> pReleaseProjects)
                               throws FlexCheckedException,
                                      FlexDeployRowNotFoundException
```
    Remove FlexDeploy projects from a given release.
    
    Parameters:
    
    pReleaseName - Release name to remove projects from.
    
    pReleaseProjects - List of ReleaseProjects to remove.
    
    Throws:
    
    FlexCheckedException
    
    FlexNotFoundException - if Release is not found
    
    FlexDeployRowNotFoundException
  - createSnapshot
```
public java.lang.Long createSnapshot(java.lang.Long pReleaseId)
                              throws FlexCheckedException
```
    Create a Snapshot for a given Release. The Release must be in a 'Started' state before a snapshot can be created.
    
    Parameters:
    
    pReleaseId - Release to create the snapshot for.
    
    Returns:
    
    Snapshot id
    
    Throws:
    
    FlexDeployValidationException - when failing to submit snapshot.
    
    FlexCheckedException
  - findBranchId
```
public java.lang.Long findBranchId(java.lang.Long pProjectId,
                                   java.lang.String pBranchName)
```
    Finds a FlexDeploy branch id from the Branch name.
    
    Parameters:
    
    pProjectId - Project id on which the branch belongs.
    
    pBranchName - Name of the branch. e.g. 'feature/JIRA-12', 'master'.
    
    Returns:
    
    Branch id
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pBranchName for pProjectId.
  - createBranch
```
public java.lang.Long createBranch(java.lang.Long pProjectId,
                                   java.lang.String pBranchName,
                                   java.lang.String pVersionSyntax)
```
    Create a FlexDeploy Branch on a given project. Allows custom setting of the version syntax. Useful for when a branch is created in source control.
    
    Parameters:
    
    pProjectId - Project to create the branch on.
    
    pBranchName - Branch name to create.
    
    pVersionSyntax - Version Syntax to use for the branch. For example: "1.0.mybranch." + SequenceNumber. Note that this is a groovy script and literal strings should be enclosed in quotes.
    
    Returns:
    
    branch id
    
    Since:
    
    5.3.0.1
  - createBranch
```
public java.lang.Long createBranch(java.lang.Long pProjectId,
                                   ProjectStreamPojo pBranch)
```
    Create a FlexDeploy Branch on a given project. Useful for when a branch is created in source control.
    
    Parameters:
    
    pProjectId - Project to create the branch on.
    
    pBranch - ProjectStreamDataObject object representing the branch to create.
    
    Returns:
    
    branch id
    
    Since:
    
    5.4.0.2
  - createBranch
```
public java.lang.Long createBranch(java.lang.Long pProjectId,
                                   java.lang.String pBranchName)
```
    Create a FlexDeploy Branch on a given project. The branch version syntax will default to 1.0.x.n where x is the branch name and n is the incrementing version. Useful for when a branch is created in source control.
    
    Parameters:
    
    pProjectId - Project to create the branch on.
    
    pBranchName - Branch name to create.
    
    Returns:
    
    Branch id
    
    Throws:
    
    FlexCheckedException
  - updateBranch
```
public void updateBranch(java.lang.Long pProjectId,
                         java.lang.Long pBranchId,
                         ProjectStreamPojo pBranch)
```
    Updates a FlexDeploy Branch on a given project.
    
    Parameters:
    
    pProjectId - Project to create the branch on.
    
    pBranchId - Id of the branch to update.
    
    pBranch - ProjectStreamPojo object representing the branch to update.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pBranchId does not exist for pProjectId.
    
    Since:
    
    5.4.0.2
  - patchBranch
```
public void patchBranch(java.lang.Long pProjectId,
                        java.lang.Long pBranchId,
                        ProjectStreamDataObject pBranch)
```
    Patches a FlexDeploy Branch on a given project. This will apply in a patch format. Only the fields passed will be updated.
    
    Parameters:
    
    pProjectId - Project to create the branch on.
    
    pBranchId - Id of the branch to update.
    
    pBranch - ProjectStreamDataObject object representing the branch to update.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pBranchId does not exist for pProjectId.
    
    Since:
    
    5.4.0.2
  - inactivateBranch
```
public void inactivateBranch(java.lang.Long pProjectId,
                             java.lang.String pBranchName)
```
    Inactivates a project stream using AM method to patch stream
    
    Parameters:
    
    pProjectId -
    
    pBranchName -
  - activateBranch
```
public void activateBranch(java.lang.Long pProjectId,
                           java.lang.String pBranchName)
                    throws FlexCheckedException
```
    Active a FlexDeploy Branch on a project.
    
    Parameters:
    
    pProjectId - project id for which the branch belongs.
    
    pBranchName - Branch name to inactivate.
    
    Throws:
    
    FlexCheckedException
  - approveTask
```
public void approveTask(java.lang.String pUsername,
                        java.lang.String pTaskIdentifier,
                        java.lang.String pNotes)
                 throws FlexCheckedException,
                        FlexNotFoundException
```
    Approve a FlexDeploy Task. Approval, scheduled or human tasks are all compatible. When using this function the execution will run as the username that is passed. Due to this, precaution should be taken to be sure that only relevant users have access to edit the use of this method and/or view webhook payloads which contain the task identifier.
    
    Parameters:
    
    pUsername - Username to approve the task as, the user passed here needs permission to approve otherwise an error will occur. User must be in local realm.
    
    pTaskIdentifier - Task identifier to approve. This identifier is only available in the TaskCreated webhook payload and is not visible from the UI.
    
    pNotes - Optional notes to assign to the approval.
    
    Throws:
    
    FlexNotFoundException - If no task found for pTaskIdentifier.
    
    FlexCheckedException.
    
    FlexCheckedException
  - rejectTask
```
public void rejectTask(java.lang.String pUsername,
                       java.lang.String pTaskIdentifier,
                       java.lang.String pNotes)
                throws FlexCheckedException,
                       FlexNotFoundException
```
    Reject a FlexDeploy Task. Approval, scheduled or human tasks are all compatible. When using this function the execution will run as the username that is passed. Due to this, precaution should be taken to be sure that only relevant users have access to edit the use of this method.
    
    Parameters:
    
    pUsername - Username to reject the task as, the user passed here needs permission to reject otherwise an error will occur. User must be in local realm.
    
    pTaskIdentifier - Task identifier to approve. This identifier is only available in the TaskCreated webhook payload and is not visible from the UI.
    
    pNotes - Optional notes to assign to the rejected task.
    
    Throws:
    
    FlexNotFoundException - If no task found forpTaskIdentifier.
    
    FlexCheckedException
  - findIntegrationInstance
```
public AccountInstancePojo findIntegrationInstance(java.lang.String pIntegrationInstanceCode,
                                                   java.lang.String pType)
                                            throws FlexNotFoundException
```
    Gets an integration instance based on the Id. If the Id corresponds to a normal instance it will not be returned.
    
    Parameters:
    
    pIntegrationInstanceCode - Code for the integration instace.
    
    pType - Type of the integration instance. {SCM, TEST, ITS, CMS, CLOUD, ARTIFACTREPO, CISERVER, ANALYSISTOOL, MESSAGING, OTHERTOOLS}.
    
    Returns:
    
    Simple pojo of the Integration Instance.
    
    Throws:
    
    FlexNotFoundException - if no integration instance found for passed code.
    
    Since:
    
    5.4
  - createSCMInstance
```
public java.lang.Long createSCMInstance(java.lang.String pSCMInstanceName,
                                        java.lang.String pDescription,
                                        java.lang.Boolean pIsActive,
                                        java.lang.String pInstanceCode,
                                        java.util.List<PropertyValuePojo> pProperties,
                                        java.lang.String pSCMType)
```
    Creates and configures an SCM Instance with the provided data.
    
    Parameters:
    
    pSCMInstanceName - - The unique name of the SCM instance.
    
    pDescription - - The description of the SCM instance.
    
    pIsActive - - Whether or not the SCM instance is active.
    
    pInstanceCode - - The code of the SCM instance.
    
    pProperties - - A list of objects containing the required property values for the specified SCM type. The objects must contain propertyName field as well as either propertyValue if the value is not encrypted or credentialId if the value is encrypted.
    
    pSCMType - - The SCM type of the instance. Must be a valid source control management system. Possible values are SVN, GIT, CVS, TFVC, PERF, PVCS, FILE, or NONE.
    
    Returns:
    
    Id of the created SCM instance.
    
    Since:
    
    5.4.0.1
  - createSCMInstance
```
public java.lang.Long createSCMInstance(SCMInstancePojo pSCMInstancePojo)
```
    Creates and configures an SCM instance with the given data.
    
    Parameters:
    
    pSCMInstancePojo - - The object containing all of the required data for the SCM instance.
    
    Returns:
    
    The Id of the created SCM instance.
    
    Since:
    
    5.4.0.1
  - updateSCMInstance
```
public java.lang.Long updateSCMInstance(java.lang.Long pSCMInstanceId,
                                        java.lang.String pSCMInstanceName,
                                        java.lang.String pDescription,
                                        java.lang.Boolean pIsActive,
                                        java.lang.String pInstanceCode,
                                        java.util.List<PropertyValuePojo> pProperties,
                                        java.lang.String pSCMType)
```
    Updates an SCM instance with the given data. Returns the Id of the SCM instance after updating. If a value is left null the attribute will not be updated.
    
    Parameters:
    
    pSCMInstanceId - - The Id of the instance to be updated.
    
    pSCMInstanceName - - The unique name of the SCM instance.
    
    pDescription - - The description of the SCM instance.
    
    pIsActive - - Whether or not the SCM instance is active.",
    
    pInstanceCode - - The code of the SCM instance.
    
    pProperties - - A list of objects containing the required property values for the specified SCM type. The objects must contain propertyName field as well as either propertyValue if the value is not encrypted or credentialId if the value is encrypted.
    
    pSCMType - - The SCM type of the instance. Must be a valid source control management system. Possible values are SVN, GIT, CVS, TFVC, PERF, PVCS, FILE, or NONE.
    
    Returns:
    
    The Id of the updated SCM Instance
    
    Since:
    
    5.4.0.1
  - updateSCMInstance
```
public java.lang.Long updateSCMInstance(java.lang.Long pSCMInstanceId,
                                        SCMInstancePojo pSCMInstancePojo)
```
    Updates an SCM instance with the given data. Returns the Id of the SCM instance after updating. If a value is left null the attribute will not be updated.
    
    Parameters:
    
    pSCMInstanceId - - The Id of the instance to be updated.
    
    pSCMInstancePojo - - Object containing all of the required data for the SCM instance.
    
    Returns:
    
    The Id of the updated SCM instance.
    
    Since:
    
    5.4.0.1
  - getIntegrationInstance
```
public AccountInstancePojo getIntegrationInstance(java.lang.Long pIntegrationInstanceId,
                                                  java.lang.String pType)
```
    Gets an integration instance based on the Id. If the Id corresponds to a normal instance it will not be returned.
    
    Parameters:
    
    pIntegrationInstanceId - Integration Instance id.
    
    pType - Type of the integration instance. {SCM, TEST, ITS, CMS, CLOUD, ARTIFACTREPO, CISERVER, ANALYSISTOOL, MESSAGING, OTHERTOOLS}.
    
    Returns:
    
    Simple pojo of the Integration Instance.
    
    Throws:
    
    FlexDeployRowNotFoundException - if no integration instance found for pIntegrationInstanceId.
    
    Since:
    
    5.4
  - findCMSInstance
```
public CMSInstancePojo findCMSInstance(java.lang.String pCMSInstanceCode)
```
    Gets a CMSInstance based on the CMS Instance Code passed. This method returns a simple object containing the metadata of the cms instance.
    
    Parameters:
    
    pCMSInstanceCode - Code of the instance you wish to retrieve.
    
    Returns:
    
    Simple pojo of the CMS Instance.
    
    Throws:
    
    FlexDeployRowNotFoundException - if no instance found for pCMSInstanceCode.
    
    Since:
    
    5.4
  - getCMSInstance
```
public CMSInstancePojo getCMSInstance(java.lang.Long pCMSInstanceId)
```
    Gets a CMSInstance based on the CMS Instance Id passed. This method returns a simple object containing the metadata of the cms instance.
    
    Parameters:
    
    pCMSInstanceId - Id of the instance you wish to retrieve.
    
    Returns:
    
    Simple pojo of the CMS Instance.
    
    Throws:
    
    FlexDeployRowNotFoundException - if no instance found for pCMSInstanceId.
    
    Since:
    
    5.4
  - getChangeManagementSystemByInstanceCode
```
public ChangeManagementSystem getChangeManagementSystemByInstanceCode(java.lang.String pInstanceCode)
```
    Returns a CMS System for a particular CMS Instance by searching with Instance Code.
    
    Parameters:
    
    pInstanceCode - Instance code to filter by.
    
    Returns:
    
    ChangeManagementSystem implementation.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no CMS instance was found given pCode.
  - getChangeManagementSystemByInstanceName
```
public ChangeManagementSystem getChangeManagementSystemByInstanceName(java.lang.String pInstanceName)
```
    Returns a CMS System for a particular CMS Instance by searching with Instance Name.
    
    Parameters:
    
    pInstanceName - Instance name to filter by.
    
    Returns:
    
    ChangeManagementSystem implementation.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no CMS instance was found givenpName.
  - createIncidentForWorklowRequest
```
public CMSObject createIncidentForWorklowRequest(java.lang.Long pWorkflowRequestId,
                                                 java.util.Map<java.lang.String,java.io.Serializable> pIncidentFields,
                                                 java.lang.String pCMSInstanceCode,
                                                 java.lang.String pCMSInstanceName)
```
    Returns a CMSObject with incident details for a particular CMS Instance by searching with Instance Name and Instance Code. Null can be passed for code or name if you do not wish to filter by that argument. You can execute all available functions used internally such as createRequest and createIncident.
    
    Parameters:
    
    pWorkflowRequestId - Associated workflow request id .
    
    pIncidentFields - Payload fields populated with key value to create an Incident.
    
    pCode - Instance code to filter by.
    
    pName - Instance name to filter by.
    
    Returns:
    
    CMSObject Incident details.
  - createIncidentByWorkflowType
```
public CMSObject createIncidentByWorkflowType(java.lang.Long pWorkflowRequestId,
                                              java.util.Map<java.lang.String,java.io.Serializable> pIncidentFields)
```
    Returns a CMSObject with incident details. This method creates incident if project's folder has an extenal approval configured for the workflow type and environment.
    
    Parameters:
    
    pWorkflowRequestId - Associated workflow request id .
    
    pIncidentFields - Payload fields populated with key value to create an Incident.
    
    Returns:
    
    CMSObject Incident details.
  - getChangeManagementSystemByInstanceId
```
public ChangeManagementSystem getChangeManagementSystemByInstanceId(java.lang.Long pCMSInstanceId)
```
    Returns a CMS System for a particular CMS Instance Id. The instance allows direct integration with the change management system and includes functions such as createTicket and createIncident.
    
    Parameters:
    
    pCMSInstanceId - Instance id of the implementation you wish to retrieve.
    
    Returns:
    
    ChangeManagementSystem implementation
    
    Throws:
    
    FlexDeployRowNotFoundException - If no instance found for pCMSInstanceId.
  - getReleaseProjectInfo
```
public java.util.List<ReleaseProjectDetailsPojo> getReleaseProjectInfo(java.lang.Long pReleaseDefId)
```
    Gets release project info based on the release definition Id. Returns basic project info for the release with given Id.
    
    Parameters:
    
    pReleaseDefId - Release Definition Id.
    
    Returns:
    
    All Projects associated to the release.
    
    Since:
    
    5.4
  - getPipelineStageExecutionInfo
```
public StageExecutionInformationPOJO getPipelineStageExecutionInfo(java.lang.Long pStageExecId)
```
    Gets pipeline stage execution info based on the stage exec Id given.
    
    Parameters:
    
    pStageExecId - Pipeline Stage Execution Id.
    
    Returns:
    
    Stage Execution Info.
    
    Since:
    
    5.4
  - getPipelineStepProjectsExecution
```
public StepProjectsRequestPojo getPipelineStepProjectsExecution(java.lang.Long pStageExecId,
                                                                java.lang.Long pStepId)
```
    Get the project request and execution statuses for a given pipeline step execution
    
    Parameters:
    
    pStageExecId - The pipeline stage execution id
    
    pStepid - The pipeline stage step id to get results for.
    
    Returns:
    
    An object containing step execution information and project requests
    
    Since:
    
    5.5.0.2
  - getPipelineStepProjectsExecution
```
public StepProjectsRequestPojo getPipelineStepProjectsExecution(java.lang.Long pStageExecId,
                                                                java.lang.String pStepName)
```
    Get the project request and execution statuses for a given pipeline step execution
    
    Parameters:
    
    pStageExecId - The pipeline stage execution id
    
    pStepName - The pipeline stage step name to get results for.
    
    Returns:
    
    An object containing step execution information and project requests
    
    Since:
    
    5.5.0.2
  - getUsersFromGroupId
```
public java.util.List<FDUser> getUsersFromGroupId(java.lang.Long pGroupId)
```
    Gets a list of FDUser objects that are members of the group with the given group Id.
    
    Parameters:
    
    pGroupId - FlexDeploy Group id to use.
    
    Returns:
    
    List of FDUser objects.
    
    Since:
    
    5.4
  - getUsersFromRoleId
```
public java.util.List<FDUser> getUsersFromRoleId(java.lang.Long pRoleId)
```
    Gets a list of the users that are members of the pipeline role with the specified role Id.
    
    Parameters:
    
    pRoleId - Pipeline role id.
    
    Returns:
    
    List of FDUser objects.
    
    Since:
    
    5.4
  - findEnvironment
```
public java.util.List<EnvironmentPojo> findEnvironment(java.lang.String pEnvironmentCode)
```
    Gets the environment with the specified Code.
    
    Parameters:
    
    pEnvironmentCode - Code of the enviornment.
    
    Returns:
    
    A simple pojo of the environment.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no environment is found for the given code
    
    Since:
    
    5.4
  - getEnvironment
```
public EnvironmentPojo getEnvironment(java.lang.Long pEnvironmentId)
```
    Gets the environment with the specified Id.
    
    Parameters:
    
    pEnvironmentId - Id of the enviornment.
    
    Returns:
    
    A simple pojo of the environment.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no environment is found for the given id.
    
    Since:
    
    5.4
  - findInstance
```
public java.util.List<InstancePojo> findInstance(java.lang.String pInstanceCode)
```
    Gets the instance with the specified Code.
    
    Parameters:
    
    pInstanceCode - Code of the instance.
    
    Returns:
    
    A simple pojo of the instance.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no instance is found for the given code.
    
    Since:
    
    5.4
  - getInstance
```
public InstancePojo getInstance(java.lang.Long pInstanceId)
```
    Gets the instance with the specified Id.
    
    Parameters:
    
    pInstanceId - Id of the instance.
    
    Returns:
    
    A simple pojo of the instance.
    
    Throws:
    
    FlexDeployRowNotFoundException - If no instance is found for the given id.
    
    Since:
    
    5.4
  - downloadLogs
```
public void downloadLogs(java.lang.Long pWorkflowExecutionId,
                         java.lang.String pDestinationPath)
```
    Downloads the plugin logs from the workflow execution based on Id. The logs will be saved in order of execution to the specified path in a folder named after the workflow execution Id.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to capture logs for.
    
    pDestinationPath - The path where the log files folder will be saved.
    
    Throws:
    
    FlexDeployValidationException - if pDestinationPath is not provided.
    
    Since:
    
    5.4
  - getPluginLogInputStreams
```
public java.util.Map<java.lang.Long,java.io.InputStream> getPluginLogInputStreams(java.lang.Long pWorkflowExecutionId)
```
    Returns plugin logs from a workflow execution as a map with the key being the plugin execution id and value as an InputStream of log data.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to capture logs for.
    
    Since:
    
    5.4
  - getPluginLogInputStreams
```
public java.util.Map<java.lang.Long,java.io.InputStream> getPluginLogInputStreams(java.lang.Long pWorkflowExecutionId,
                                                                                  java.lang.Boolean pOnlyError)
```
    Returns plugin logs from a workflow execution as a map with the key being the plugin execution id and value as an InputStream of log data.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to capture logs for.
    
    pOnlyError - Return only the failed plugin log input stream, otherwise all plugin logs for the workflow will be returned.
    
    Throws:
    
    FlexCheckedException
    
    Since:
    
    5.4
  - getPackage
```
public PackageDetailsResponsePojo getPackage(java.lang.Long pProjectId,
                                             java.lang.String pPackageName)
```
    Returns a PackageDetailsResponsePojo given a Project Id and Package Name
    
    Parameters:
    
    pProjectId - Parent project id package is under.
    
    pPackageName - Name of package
    
    Returns:
    
    PackageDetailsResponsePojo
    
    Throws:
    
    FlexDeployRowNotFoundException - If no project package found for pProjectId and pPackageName.
    
    Since:
    
    5.5.0.3
  - getPluginLogs
```
public java.util.Collection<PluginLogPojo> getPluginLogs(java.lang.Long pWorkflowExecutionId)
```
    Gets the plugin logs from the workflow execution based on Id.
    
    Parameters:
    
    pWorkflowExecutionId - Workflow Execution Id to capture logs for.
    
    Returns:
    
    A collection, one per plugin execution, of PluginLogPojos.
    
    Since:
    
    5.4
  - getSnapshotCommitDetailInputStreams
```
public java.io.InputStream getSnapshotCommitDetailInputStreams(java.lang.Long pSnapshotId)
```
    Gets the commit details of a snapshot and returns an input stream of the data.
    
    Parameters:
    
    pSnapshotId - - Id of the snapshot which details will be returned
    
    Returns:
    
    List of Input streams of the snapshot content details.
    
    Since:
    
    5.4.0.1
  - downloadSnapshotCommitDetails
```
public void downloadSnapshotCommitDetails(java.lang.Long pSnapshotId,
                                          java.lang.String pDestinationPath)
```
    Gets the commit details of a snapshot and downloads a csv file to the destination path. File name will be SNAPSHOTID_SNAPSHOTNAME. SNAPSHOTNAME will have the time section removed in the file name.
    
    Parameters:
    
    pSnapshotId - - Id of the snapshot whose commit details will be returned.
    
    pDestinationPath - - Path where the csv will be downloaded.
    
    Throws:
    
    FlexDeployValidationException - if pDestinationPath is not provided.
    
    Since:
    
    5.4.0.1
  - getSnapshotCommitDetails
```
public java.util.List<ReleaseSnapshotCommitDetailsPojo> getSnapshotCommitDetails(java.lang.Long pSnapshotId)
```
    Gets the commit details of a snapshot and returns an object with the data.
    
    Parameters:
    
    pSnapshotId - - Id of the snapshot whose commit details will be returned.
    
    Returns:
    
    List of objects for each row of release snapshot content table for snapshot Id provided.
  - getFlexDeployBaseUrl
```
public java.lang.String getFlexDeployBaseUrl()
```
    Returns the FlexDeploy Server base url configured in System Settings.
    
    Returns:
    
    The base url of the current FlexDeploy service.
    
    Since:
    
    5.4
  - getGroovyKey
```
public java.lang.String getGroovyKey()
```
    Specified by:
    
    getGroovyKey in class BaseFunctions
  - cleanup
```
public void cleanup()
```
    Specified by:
    
    cleanup in class BaseFunctions
  - executeUtility
```
public java.lang.Long executeUtility(java.lang.Long pProjectId,
                                     java.lang.String pEnvironmentCode)
```
    Executes a FlexDeploy Utility Project for a single environment on all instances configured in Project Configuration.
    
    Parameters:
    
    pProjectId - Project id to execute.
    
    pEnvironmentCode - Environment code to use for the utility request.
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployValidationException - if pEnvironmentCode is not provided.
  - executeUtility
```
public java.lang.Long executeUtility(java.lang.Long pProjectId,
                                     java.lang.String pEnvironmentCode,
                                     ExecuteOptions pExecuteOptions)
```
    Executes a FlexDeploy Utility Project for a single environment with specified ExecuteOptions. If instance codes are not passed in the ExecuteOptions, then the project will get executed on all instances associated to the passed environment.
    
    Parameters:
    
    pProjectId - Project id to execute.
    
    pEnvironmentCode - Environment code to use for the utility request.
    
    pInstanceCode - Instance code to use for the utility request.
    
    pExecuteOptions - Execute options contains list of instances to execute on, with inputs and flexfields
    
    Returns:
    
    WorkflowRequest id
    
    Throws:
    
    FlexDeployValidationException - if pEnvironmentCode is not provided.
  - findFolderId
```
public java.lang.Long findFolderId(java.lang.String pFolderName)
```
    Finds the FlexDeploy Folder id for any given name. This will only work properly if all Folder Names are unique.
    
    Parameters:
    
    pFolderName - Case sensitive folder name to search by
    
    Returns:
    
    Folder id
    
    Throws:
    
    FlexDeployRowNotFoundException - If folder name is not found in FlexDeploy
  - findFolderWithId
```
public FolderDataObject findFolderWithId(java.lang.Long pFolderId)
```
    Finds Folder using Id.
    
    Parameters:
    
    pFolderId -
    
    Returns:
  - findFoldersWithName
```
public java.util.List<FolderDataObject> findFoldersWithName(java.lang.String pFolderName)
```
    Finds FlexDeploy Folders for any given name
    
    Parameters:
    
    pFolderName - Case insensitive project name to search by
    
    Returns:
  - searchFolders
```
public <any> searchFolders(FolderDataObject pCriteriaObject,
                           java.lang.Integer pLimit,
                           java.lang.Integer pOffset)
```
    Find Folders using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject -
    
    pLimit -
    
    pOffset -
    
    Returns:
  - searchBranches
```
public <any> searchBranches(ProjectStreamDataObject pCriteriaObject,
                            java.lang.Integer pLimit,
                            java.lang.Integer pOffset)
```
    Find Branches using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject -
    
    pLimit -
    
    pOffset -
    
    Returns:
  - getUser
```
public FdUserDataObject getUser(java.lang.String pUsername)
```
    Returns user information for a given username.
    
    Parameters:
    
    pUsername - - Username of the user to retrieve.
    
    Returns:
    
    Object containing basic information for given user if user exists.
    
    Since:
    
    5.7.0.2
  - getCurrentlyDeployedVersionId
```
public java.lang.Long getCurrentlyDeployedVersionId(java.lang.Long pProjectId,
                                                    java.lang.Long pEnvironmentId,
                                                    java.lang.Long pInstanceId)
```
    Returns currently deployed project version Id of full deployment project.
    
    Parameters:
    
    pProjectId - Project Id of the project to retrieve.
    
    pEnvironmentId - - Id of the enviornment.
    
    pInstanceId - - Id of the instance.
    
    Returns:
    
    currently deployed project version Id.
  - getCurrentlyDeployedVersionId
```
public java.lang.Long getCurrentlyDeployedVersionId(java.lang.Long pProjectId,
                                                    java.lang.Long pEnvironmentId,
                                                    java.lang.Long pInstanceId,
                                                    java.lang.String pPackageName)
```
    Returns currently deployed project version Id of partial deployment project.
    
    Parameters:
    
    pProjectId - Project Id of the project to retrieve.
    
    pEnvironmentId - - Id of the enviornment.
    
    pInstanceId - - Id of the instance.
    
    pPackageName - - Name of the package.
    
    Returns:
    
    currently deployed project version Id.
    
    Throws:
    
    FlexDeployValidationException - if pPackageName is not provided.
  - getPreviouslyDeployedVersionId
```
public java.lang.Long getPreviouslyDeployedVersionId(java.lang.Long pProjectId,
                                                     java.lang.Long pEnvironmentId,
                                                     java.lang.Long pInstanceId)
```
    Returns previously deployed project version Id of full deployment project.
    
    Parameters:
    
    pProjectId - Project Id of the project to retrieve.
    
    pEnvironmentId - - Id of the enviornment.
    
    pInstanceId - - Id of the instance.
    
    Returns:
    
    previoulsy deployed project version Id.
  - getPreviouslyDeployedVersionId
```
public java.lang.Long getPreviouslyDeployedVersionId(java.lang.Long pProjectId,
                                                     java.lang.Long pEnvironmentId,
                                                     java.lang.Long pInstanceId,
                                                     java.lang.String pPackageName)
```
    Returns previously deployed project version Id of partial deployment project.
    
    Parameters:
    
    pProjectId - Project Id of the project to retrieve.
    
    pEnvironmentId - - Id of the enviornment.
    
    pInstanceId - - Id of the instance.
    
    pPackageName - - Name of the package.
    
    Returns:
    
    previously deployed project version Id.
    
    Throws:
    
    FlexDeployValidationException - if pPackageName is not provided.
  - updateReleaseProperty
```
public java.lang.Long updateReleaseProperty(java.lang.Long pReleaseDefId,
                                            java.lang.String pPropertyKeyCode,
                                            java.io.Serializable pNewValue)
```
    Updates a release's property with the provided property key code.
    
    Parameters:
    
    pReleaseDefId - - Id of the release that has the property to be updated.
    
    pPropertyKeyCode - - The code of the property that is to be updated.
    
    pNewValue - - The value that the property will be updated to.
    
    Returns:
    
    - The Id of the release that has had it's property updated.
    
    Since:
    
    5.7.0.3
  - updateSnapshotVariable
```
public java.lang.Long updateSnapshotVariable(java.lang.Long pSnapshotId,
                                             java.lang.String pVariableCode,
                                             java.io.Serializable pNewValue)
                                      throws FlexCheckedException
```
    Updates a snapshot's variable with the provided variable code.
    
    Parameters:
    
    pSnapshotId - - The id of the snapshot that has the variable to be updated.
    
    pVariableCode - - The code of the variable that is to be updated.
    
    pNewValue - - The value taht the property will be updated to.
    
    Returns:
    
    - The Id of the snapshot that has had it's property updated.
    
    Throws:
    
    FlexCheckedException
    
    Since:
    
    5.7.0.3
  - completeManualStepByTaskId
```
public void completeManualStepByTaskId(java.lang.String pUsername,
                                       java.lang.Long pTaskId)
                                throws FlexCheckedException,
                                       FlexNotFoundException
```
    Completes a manual step Human task. When using the execution will run as the username that is passed.
    
    Parameters:
    
    pUsername - - Username to complete the task as.
    
    pTaskId - - Task ID of the human task/manual step to complete.
    
    Throws:
    
    FlexNotFoundException - If no task is found for passed Id.
    
    FlexCheckedException - All other exceptions.
    
    Since:
    
    5.7.0.4
  - completeManualStepBySnapshotId
```
public void completeManualStepBySnapshotId(java.lang.String pUsername,
                                           java.lang.Long pSnapshotId)
                                    throws FlexCheckedException,
                                           FlexNotFoundException
```
    Completes a manual step Human task. When using the execution will run as the username that is passed.
    
    Parameters:
    
    pUsername - - Username to complete the task as.
    
    pSnapshotId - - Snapshot Id which has a manual step waiting to be completed.
    
    Throws:
    
    FlexNotFoundException - If no task is found for passed Id.
    
    FlexCheckedException - All other exceptions.
    
    Since:
    
    5.7.0.4
  - createStream
```
public java.lang.Long createStream(java.lang.Long pProjectId,
                                   ProjectStreamPojo pStream)
```
    Create a FlexDeploy Stream on a given project. Useful for when a branch is created in source control.
    
    Parameters:
    
    pProjectId - Project to create the stream on.
    
    pStream - ProjectStreamDataObject object representing the stream to create.
    
    Returns:
    
    Stream id
    
    Since:
    
    5.4.0.2
  - createStream
```
public java.lang.Long createStream(java.lang.Long pProjectId,
                                   java.lang.String pStreamName)
```
    Create a FlexDeploy Stream on a given project. The stream version syntax will default to 1.0.x.n where x is the stream name and n is the incrementing version. Useful for when a branch is created in source control.
    
    Parameters:
    
    pProjectId - Project to create the stream on.
    
    pStreamName - Stream name to create.
    
    Returns:
    
    Stream id
    
    Throws:
    
    FlexCheckedException
  - createStream
```
public java.lang.Long createStream(java.lang.Long pProjectId,
                                   java.lang.String pStreamName,
                                   java.lang.String pVersionSyntax)
```
    Create a FlexDeploy Stream on a given project. Allows custom setting of the version syntax. Useful for when a branch is created in source control.
    
    Parameters:
    
    pProjectId - Project to create the stream on.
    
    pStreamName - Stream name to create.
    
    pVersionSyntax - Version Syntax to use for the stream. For example: "1.0.mybranch." + SequenceNumber. Note that this is a groovy script and literal strings should be enclosed in quotes.
    
    Returns:
    
    Stream id
    
    Since:
    
    5.3.0.1
  - findStreamId
```
public java.lang.Long findStreamId(java.lang.Long pProjectId,
                                   java.lang.String pStreamName)
```
    Finds a FlexDeploy stream id from the Stream name.
    
    Parameters:
    
    pProjectId - Project id on which the stream belongs.
    
    pStreamName - Name of the stream. e.g. 'feature/JIRA-12', 'master'.
    
    Returns:
    
    Stream id
    
    Throws:
    
    FlexDeployRowNotFoundException - if no row found for pStreamName for pProjectId.
  - inactivateStream
```
public void inactivateStream(java.lang.Long pProjectId,
                             java.lang.String pStreamName)
```
    Inactivates a project stream using AM method to patch stream
    
    Parameters:
    
    pProjectId -
    
    pStreamName -
  - activateStream
```
public void activateStream(java.lang.Long pProjectId,
                           java.lang.String pStreamName)
                    throws FlexCheckedException
```
    Active a FlexDeploy Stream on a project.
    
    Parameters:
    
    pProjectId - project id for which the stream belongs.
    
    pStreamName - Stream name to inactivate.
    
    Throws:
    
    FlexCheckedException
  - patchStream
```
public void patchStream(java.lang.Long pProjectId,
                        java.lang.Long pStreamId,
                        ProjectStreamDataObject pStream)
```
    Patches a FlexDeploy Stream on a given project. This will apply in a patch format. Only the fields passed will be updated.
    
    Parameters:
    
    pProjectId - Project to create the stream on.
    
    pStreamId - Id of the stream to update.
    
    pStream - ProjectStreamDataObject object representing the stream to update.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamId does not exist for pProjectId.
    
    Since:
    
    5.4.0.2
  - updateStream
```
public void updateStream(java.lang.Long pProjectId,
                         java.lang.Long pStreamId,
                         ProjectStreamPojo pStream)
```
    Updates a FlexDeploy Stream on a given project.
    
    Parameters:
    
    pProjectId - Project to create the stream on.
    
    pStreamId - Id of the stream to update.
    
    pStream - ProjectStreamPojo object representing the stream to update.
    
    Throws:
    
    FlexDeployRowNotFoundException - if pStreamId does not exist for pProjectId.
    
    Since:
    
    5.4.0.2
  - updateScanResult
```
public void updateScanResult(java.lang.Long pProjectId,
                             java.lang.String pScanId,
                             ScanResultPojo pScanResultPojo,
                             boolean pIsStatusSuccess)
```
    Updates a FlexDeploy ScanResult on a given project.
    
    Parameters:
    
    pProjectId - Project to update the scan results.
    
    pScanId - Id of the scan result to update.
    
    pScanResultPojo - ScanResultPojo object representing the scanResult to update.
    
    pIsStatusSuccess - is scan status success or not.
    
    Since:
    
    6.0
  - getScanResultForSonarqube
```
public ScanResultPojo getScanResultForSonarqube(java.lang.String pBaseUrl,
                                                java.lang.String pProjectKey)
                                         throws FlexCheckedException
```
    get Scan result for SonarQube
    
    Parameters:
    
    pBaseUrl -
    
    pProjectKey -
    
    Returns:
    
    ScanResultPojo
    
    Throws:
    
    FlexCheckedException
    
    Since:
    
    6.0
  - getIssueTrackingSystemByInstanceCode
```
public IssueTrackingSystem getIssueTrackingSystemByInstanceCode(java.lang.String pInstanceCode)
```
    Returns a ITS System for a particular ITS Instance Code. The instance allows direct integration with the issue tracking system and includes functions such as getTicketStatus, getTicketURL.
    
    Parameters:
    
    pInstanceCode - Instance code of the implementation you wish to retrieve.
    
    Returns:
    
    IssueTrackingSystem implementation
    
    Throws:
    
    FlexDeployRowNotFoundException - If no instance found for pInstanceCode.
  - getIssueTrackingSystemByInstanceName
```
public IssueTrackingSystem getIssueTrackingSystemByInstanceName(java.lang.String pInstanceName)
```
    Returns a ITS System for a particular ITS Instance Name. The instance allows direct integration with the issue tracking system and includes functions such as getTicketStatus, getTicketURL.
    
    Parameters:
    
    pInstanceName - Instance Name of the implementation you wish to retrieve.
    
    Returns:
    
    IssueTrackingSystem implementation
    
    Throws:
    
    FlexDeployRowNotFoundException - If no instance found for pInstanceName.
  - getIssueTrackingSystemByInstanceId
```
public IssueTrackingSystem getIssueTrackingSystemByInstanceId(java.lang.Long pITSInstanceId)
```
    Returns a ITS System for a particular ITS Instance Id. The instance allows direct integration with the issue tracking system and includes functions such as getTicketStatus, getTicketURL.
    
    Parameters:
    
    pITSInstanceId - Instance id of the implementation you wish to retrieve.
    
    Returns:
    
    IssueTrackingSystem implementation
    
    Throws:
    
    FlexDeployRowNotFoundException - If no instance found for pITSInstanceId.
  - getMatchingProjectObjectId
```
public java.lang.Long getMatchingProjectObjectId(java.lang.Long pProjectId,
                                                 java.lang.String pFile)
```
    Returns internal id for file in a project. File is path represented on File Catalog.
    
    Parameters:
    
    pProjectId -
    
    pFile -
    
    Returns:
  - searchProjectPackages
```
public <any> searchProjectPackages(ProjectPackageDataObject pCriteriaObject,
                                   java.lang.Integer pLimit,
                                   java.lang.Integer pOffset)
```
    Find Packages using criteria values provided. Results are limited by pLimit and pOffset.
    
    Parameters:
    
    pCriteriaObject -
    
    pLimit -
    
    pOffset -
    
    Returns:

Class FlexDeployFunctions

Constructor Summary

Method Summary

Methods inherited from class flexagon.fd.services.groovy.functions.BaseFunctions

Methods inherited from class java.lang.Object

Constructor Detail

FlexDeployFunctions

Method Detail

findLocalChangeLogs

findLocalChangeLogs

findLocalChangeLogs

findLocalChangeLogs

getProject

getRelease

findReleases

createProject

updateProject

patchProject

updateProjectProperties

patchProjectProperties

addFilesToPackage

populateFiles

discoverFiles

updatePackageStatus

updatePackage

updatePackage

createPackage

createDynamicPackage

createPackage

deletePackage

buildPackage

buildPackage

buildPackage

buildProject

buildProject

buildProject

deployPackage

deployProject

findProjectsForNewBranch

findProjectsForNewBranch

findProjectsForChange

findProjectsForChange

findPackagesForChange

findPackagesForChange

findProjectId

findProjectWithId

findProjectsWithName

searchProjects

createRelease

createRelease

endRelease

endRelease

pauseRelease

pauseRelease

startRelease

startRelease

addProjectsToRelease

removeProjectsFromRelease

createSnapshot

findBranchId

createBranch

createBranch

createBranch

updateBranch

patchBranch

inactivateBranch

activateBranch

approveTask

rejectTask

findIntegrationInstance

createSCMInstance

createSCMInstance

updateSCMInstance

updateSCMInstance

getIntegrationInstance

findCMSInstance

getCMSInstance

getChangeManagementSystemByInstanceCode

getChangeManagementSystemByInstanceName

createIncidentForWorklowRequest