public class FlexDeploy2Functions extends BaseFunctions implements IFlexDeployFunctions
mExecute, mFLOG, mScriptRef| Constructor and Description |
|---|
FlexDeploy2Functions() |
FlexDeploy2Functions(boolean isExecute,
LogFunctions pFLOG) |
| Modifier and Type | Method and Description |
|---|---|
void |
activateBranch(java.lang.Long pProjectId,
java.lang.String pBranchName)
Activate a FlexDeploy Branch on a project.
|
void |
activateStream(java.lang.Long pProjectId,
java.lang.String pbranchName)
Deprecated.
|
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.
|
FdCommentDataObject |
addWorkItemComment(java.lang.String pWorkItemNumber,
java.lang.String pComment)
Adds a WorkItem comment with the provided data.
|
void |
addWorkItemsToRelease(java.lang.Long pReleaseId,
java.lang.Long pInstanceId,
java.util.List<java.lang.String> pWorkItemNumbers)
Add WorkItems to an existing Release.
|
void |
approveTask(java.lang.String pUsername,
java.lang.String pTaskIdentifier,
java.lang.String pNotes)
Approve a FlexDeploy Task.
|
void |
approveTaskById(java.lang.Long pTaskId,
java.lang.String pNotes)
Approves a FlexDeploy Approval or Scheduled Window task.
|
void |
assignGroupToUser(java.lang.Long pGroupId,
java.lang.Long pUserId)
Assigns Group to User with the provided data.
|
void |
assignGroupToUser(java.lang.String pGroupName,
java.lang.String pUserName)
Assigns Group to User with the provided data.
|
TagAssignmentDataObject |
assignTag(FlexDeploySecurityConstants.SecurityObjectType pObjectType,
java.lang.Long pObjectId,
java.lang.String pTagName)
Assigns tag to the object with the provided data.
|
java.lang.Long |
buildPackage(java.lang.Long pBranchId,
ProjectPackagePojo projectPackage)
Builds a FlexDeploy Package.
|
java.lang.Long |
buildPackage(java.lang.Long pBranchId,
ProjectPackagePojo projectPackage,
BuildOptions pBuildOptions)
Builds a FlexDeploy Package.
|
java.lang.Long |
buildPackage(java.lang.Long pBranchId,
ProjectPackagePojo projectPackage,
PollingResult pPollingResult)
Builds a FlexDeploy Package using a PollingResult.
|
java.lang.Long |
buildPackage(java.lang.Long pBranchId,
ProjectPackagePojo projectPackage,
PollingResult pPollingResult,
BuildOptions pBuildOptions)
Builds a FlexDeploy Package using a PollingResult.
|
java.lang.Long |
buildProject(java.lang.Long pBranchId,
java.lang.Long pProjectId)
Builds a FlexDeploy Project.
|
java.lang.Long |
buildProject(java.lang.Long pBranchId,
java.lang.Long pProjectId,
BuildOptions pBuildOptions)
Builds a FlexDeploy Project.
|
java.lang.Long |
buildProject(java.lang.Long pBranchId,
java.lang.Long pProjectId,
PollingResult pPollingResult)
Builds a FlexDeploy Project using a PollingResult.
|
java.lang.Long |
buildProject(java.lang.Long pBranchId,
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)
Approve a manual step Human task.
|
void |
completeManualStepByTaskId(java.lang.String pUsername,
java.lang.Long pTaskId)
Approve a manual step Human task.
|
RelDefinitionDataObject |
copyRelease(CopyReleaseInput pCopyReleaseInput)
Create a Release from the source release based on the provided data.
|
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.
|
CmsTicketDataObject |
createCmsTicket(CmsTicketDataObject pCmsTicketDataObject)
Create CMS Ticket with the provided data.
|
FdCommentDataObject |
createComment(FdCommentDataObject pCommentDataObj)
Create Comment with the provided data.
|
CredentialDataObject |
createCredential(CredentialDataObject pCredentialDataObject)
Create Credential with the provided data.
|
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.
|
EndpointDataObject |
createEndpoint(EndpointDataObject pEndpointDataObject)
Create Endpoint with the provided data.
|
EnvironmentDataObject |
createEnvironment(EnvironmentDataObject pEnvDataObject)
Create Environment with the provided data.
|
FlxWorkItemDataObject |
createFlxWorkItem(FlxWorkItemDataObject pPojo)
Creates a FlexWorkItem with the provided data.Returns the WorkItem details after creation.
|
FlxWorkItemFieldDataObject |
createFlxWorkItemField(FlxWorkItemFieldDataObject pDobj)
Creates a FlexWorkItem Field with the provided data.
|
PropertyKeyGroupDataObject |
createFlxWorkItemFieldGroup(PropertyKeyGroupDataObject pDobj)
Creates a FlexWorkItem Field Group with the provided data.
|
FolderDataObject |
createFolder(FolderDataObject pFolderDataObject)
Create Folder with the provided data.
|
FdGroupDataObject |
createGroup(FdGroupDataObject pGroupDataObject)
Create Group with the provided data.
|
CMSObject |
createIncidentByWorkflowType(java.lang.Long pWorkflowRequestId,
java.util.Map<java.lang.String,java.io.Serializable> pIncidentFields)
Returns a CMSObject with incident details.
|
CMSObject |
createIncidentForWorkflowRequest(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.
|
CMSObject |
createIncidentForWorklowRequest(java.lang.Long pWorkflowRequestId,
java.util.Map<java.lang.String,java.io.Serializable> pIncidentFields,
java.lang.String pCMSInstanceCode,
java.lang.String pCMSInstanceName)
Deprecated.
|
IntegrationInstancePojo |
createIntegrationInstanceAndProperties(IntegrationInstancePojo pPojo)
Creates and configures the properties of an Integration instance using the provided data
object.
|
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 pBranchId,
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.
|
ProjectTriggerDataObject |
createProjectTrigger(ProjectTriggerDataObject pPojo)
Creates a project trigger with the provided data.Returns the project trigger details after
creation.
|
PropertyKeyDefinitionDataObject |
createPropertyKeyDefinition(PropertyKeyDefinitionDataObject pPojo)
Creates a property key definition with the provided data.
|
java.lang.Long |
createRelease(java.lang.Long pFolderId,
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 'STARTED' status.
|
java.lang.Long |
createRelease(java.lang.String pReleaseName,
java.lang.String pPipelineName,
java.lang.String pDescription)
Create an empty FlexDeploy Release that defaults to '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 'STARTED' status.
|
RelProjectDataObject |
createReleaseProject(RelProjectDataObject pPojo)
Create Release Project with the provided data.
|
java.util.List<RelProjectDataObject> |
createReleaseProjects(java.lang.Long pReleaseId,
java.util.List<RelProjectDataObject> pPojos)
Create Release Project with the provided data.
|
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 |
createSnapshot(java.lang.Long pReleaseId,
java.util.List<SnapshotVersionInputPojo> pVersions,
java.util.List<CodeValueInputPOJO> pInputs)
Create a Snapshot for a given Release, Versions, Inputs.
|
java.lang.Long |
createStandaloneRelease(java.lang.Long pProjectId,
java.lang.Long pBranchId,
java.lang.String pReleaseName,
java.lang.Long pBuildEnvironmentId,
java.lang.Long pPipelineId)
Creates a Standalone Release for standard project that defaults to 'STARTED' status.
|
java.lang.Long |
createStandaloneRelease(java.lang.Long pProjectId,
java.lang.Long pBranchId,
java.lang.String pPackageName,
java.lang.String pReleaseName,
java.lang.Long pBuildEnvironmentId,
java.lang.Long pPipelineId)
Creates a Standalone Release for partial project that defaults to 'STARTED' status.
|
java.lang.Long |
createStream(java.lang.Long pProjectId,
ProjectStreamPojo pBranch)
Deprecated.
|
java.lang.Long |
createStream(java.lang.Long pProjectId,
java.lang.String pbranchName)
Deprecated.
|
java.lang.Long |
createStream(java.lang.Long pProjectId,
java.lang.String pbranchName,
java.lang.String pVersionSyntax)
Deprecated.
|
TargetGroupDataObject |
createTargetGroup(TargetGroupDataObject pTargetGroupDataObj)
Create TargetGroup with the provided data.
|
FdUserDataObject |
createUser(FdUserDataObject pUserDataObj)
Create User with the provided data.
|
FlxWorkItemDataObject |
createWorkItem(FlxWorkItemDataObject pPojo) |
void |
deleteCmsTicket(java.lang.Long pCmsTicketId)
Deletes a CMS Ticket.
|
void |
deleteComment(java.lang.Long pCommentId)
Deletes a Comment.
|
void |
deleteCredential(java.lang.Long pCredentialId)
Deletes a Credential.
|
void |
deleteEndpoint(java.lang.Long pEndpointId)
Deletes an Endpoint.
|
void |
deleteEnvironment(java.lang.Long pEnvironmentId)
Deletes an Environment.
|
void |
deleteFlxWorkItem(java.lang.Long pFlexWorkItemId)
Deletes a FlexWorkItem
|
void |
deleteFlxWorkItemField(java.lang.Long pFlexWorkItemFieldId)
Deletes a FlexWorkItem Field
|
void |
deleteFlxWorkItemFieldGroup(java.lang.String pFlexWorkItemFieldGroupCode)
Deletes a FlexWorkItem Field Group
|
void |
deleteFolder(java.lang.Long pFolderId)
Deletes a Folder.
|
void |
deletePackage(java.lang.Long pProjectId,
java.lang.String pPackageName)
Deletes a project package
|
void |
deleteProjectTrigger(java.lang.Long pProjectTriggerId)
Deletes the project trigger based on Project Trigger id.
|
void |
deleteReleaseProject(java.lang.Long pRelProjectId)
Delete Release project from release.
|
void |
deleteReleaseProjects(java.util.List<java.lang.Long> pRelProjectIds)
Delete Release projects from release.
|
void |
deleteTargetGroup(java.lang.Long pTargetGroupId)
Deletes a TargetGroup.
|
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 pBranchId)
Populate partial deployment files for a given project.
|
java.lang.Integer |
discoverFiles(java.lang.Long pProjectId,
java.lang.Long pBranchId,
boolean pInactivateMissingFiles) |
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.io.File |
exportBuild(java.lang.Long pWorkflowExecutionId)
Export build archive as zip file.
|
java.io.File |
exportConfigurations()
Export configurations as zip file.
|
java.io.File |
exportSnapshot(java.lang.Long pSnapshotId)
Export snapshot archive as zip file.
|
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 environment code.
|
FlxWorkItemDataObject |
findFlxWorkItemByNumber(java.lang.String pWorkItemNumber)
Gets FlexWorkItem based on WorkItem number.
|
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.
|
IntegrationInstancePojo |
findIntegrationInstance(java.lang.String pIntegrationInstanceCode,
java.lang.String pType)
Gets an integration instance based on the code.
|
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 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 git repository.
|
java.util.Set<ProjectPackagePojo> |
findPackagesForChange(java.lang.String pRepositoryName,
java.lang.String pbranchName,
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 pbranchName,
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 pbranchName,
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 pbranchName,
PollingResult pPollingResult)
Finds relevant FlexDeploy Projects for any given PollingResult and branch.
|
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.util.List<ReleasePojo> |
findReleases(java.lang.String pName,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Finds Releases matching the specified name.
|
java.lang.Long |
findStreamId(java.lang.Long pProjectId,
java.lang.String pbranchName)
Deprecated.
|
void |
forceEndRelease(java.lang.Long pReleaseId)
Force a FlexDeploy Release to end.
|
void |
forceEndRelease(java.lang.String pReleaseName)
Force a FlexDeploy Release to end.
|
java.util.List<FlexFieldMetadataDataObject> |
getActiveBuildFlexfieldMetadata()
Gets active build flexfields metadata.
|
java.util.List<FlexFieldMetadataDataObject> |
getActiveDeployUtilityFlexfieldMetadata()
Gets active deploy or utility flexfields metadata.
|
java.util.List<FDUser> |
getAllUsersFromRoleId(java.lang.Long pRoleId)
Gets a list of all the users that are part of Assigned Users as well as all the active users
belongs to the Assigned Groups for the pipeline role with the specified pipeline role id.
|
java.util.List<FDUser> |
getAllUsersFromRoleId(java.lang.Long pRoleId,
java.lang.Long pRelDefId)
Gets a list of all the users that are part of Assigned Users as well as all the active users
belongs to the Assigned Groups for the pipeline role with the specified pipeline role id and
release definition id to get Users overridden at the release.
|
java.util.List<TasksQueryResultPojo> |
getApprovedPipelineStageGateTasks(java.lang.Long pPipelineStageExecId)
Gets Task details based on pipeline stage execution id.
|
java.util.List<WorkflowExecutionDataObject> |
getBuildWorkflowExecutionsFromProjectVersionIds(java.util.List<java.lang.Long> pProjectVersionIds)
Get the build workflow execution details for given project version id(s)
|
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.
|
CmsTicketDataObject |
getCmsTicketById(java.lang.Long pCmsTicketId)
Returns CMS Ticket information for a given CMS Ticket Id.
|
java.util.List<CmsTicketDataObject> |
getCmsTicketsByNumber(java.lang.String pCmsTicketNumber)
Returns a list of CMS Ticket information for a given CMS Ticket Number.
|
CredentialDataObject |
getCredentialById(java.lang.Long pCredentialId)
Returns Credential information for a given Credential Id.
|
CredentialDataObject |
getCredentialByName(java.lang.String pCredentialName)
Returns Credential information for a given Credential name.
|
java.lang.String |
getCredentialSecretTextById(java.lang.Long pCredentialId)
Returns the secret text value for a given Credential name.
|
java.lang.String |
getCredentialSecretTextByName(java.lang.String pCredentialName)
Returns the secret text value for a given Credential name.
|
CredentialValuePojo |
getCredentialValueById(java.lang.Long pCredentialId)
Returns the plaintext value for a given Credential id.
|
CredentialValuePojo |
getCredentialValueByName(java.lang.String pCredentialName)
Returns the plaintext value for a given Credential id.
|
java.lang.Long |
getCurrentlyDeployedVersionId(java.lang.Long pProjectId,
java.lang.Long pEnvironmentId,
java.lang.Long pTargetGroupId)
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 pTargetGroupId,
java.lang.String pPackageName)
Returns currently deployed project version Id of partial deployment project.
|
java.util.List<java.lang.String> |
getEmailAddressesFromRoleId(java.lang.Long pRoleId)
Gets a list of email addresses that are members of the pipeline role with the specified role
Id.
|
java.util.List<java.lang.String> |
getEmailAddressesFromRoleId(java.lang.Long pRoleId,
java.lang.Long pRelDefId)
Gets a list of email addresses that are members of the pipeline role with the specified role id
and release definition id to get emails overridden at the release.
|
EndpointDataObject |
getEndpointById(java.lang.Long pEndpointId)
Returns Endpoint information for a given endpoint Id.
|
EndpointDataObject |
getEndpointByName(java.lang.String pEndpointName)
Returns Endpoint information for a given Endpoint Name.
|
EnvironmentPojo |
getEnvironment(java.lang.Long pEnvironmentId)
Gets the environment with the specified Id.
|
EnvironmentDataObject |
getEnvironmentByCode(java.lang.String pEnvironmentCode)
Returns Environment information for a given environment code.
|
EnvironmentDataObject |
getEnvironmentById(java.lang.Long pEnvironmentId)
Returns Environment information for a given environment Id.
|
EnvironmentDataObject |
getEnvironmentByName(java.lang.String pEnvironmentName)
Returns Environment information for a given environmentName
|
java.lang.String |
getFlexDeployBaseUrl()
Returns the FlexDeploy Server base url configured in System Settings.
|
java.util.List<FlxWorkItemFieldDataDataObject> |
getFlxWorkItemFieldData(java.lang.String pWorkItemNumber)
Returns List of WorkItem field details for FlexWorkItem number.
|
PropertyKeyGroupDataObject |
getFlxWorkItemFieldGroupWithCode(java.lang.String pFlexWorkItemFieldGroupCode)
Finds a FlexWorkItem Field Group using Code.
|
FlxWorkItemFieldDataObject |
getFlxWorkItemFieldWithId(java.lang.Long pFlexWorkItemFieldId)
Finds FlexWorkItem Field using Id.
|
java.util.List<FlxWorkItemStatusDataObject> |
getFlxWorkItemStatuses()
Gets the FlexWorkItem statuses.
|
FlxWorkItemStatusDataObject |
getFlxWorkItemStatusWithId(java.lang.Long pFlexWorkItemStatusId)
Finds FlexWorkItem Status using Id.
|
java.util.List<FlxWorkItemTypeDataObject> |
getFlxWorkItemTypes()
Gets the FlexWorkItem types.
|
FlxWorkItemTypeDataObject |
getFlxWorkItemTypeWithCode(java.lang.String pFlexWorkItemTypeCode)
Finds FlexWorkItem Type using Code.
|
java.lang.String |
getGroovyKey() |
FdGroupDataObject |
getGroupById(java.lang.Long pGroupId)
Returns Group information for a given group Id.
|
FdGroupDataObject |
getGroupByName(java.lang.String pGroupName)
Returns Group information for a given group name.
|
java.util.List<FdGroupDataObject> |
getGroupsFromRoleId(java.lang.Long pRoleId)
Gets a list of the Groups that are members of the pipeline role with the specified role Id.
|
java.util.List<FdGroupDataObject> |
getGroupsFromRoleId(java.lang.Long pRoleId,
java.lang.Long pRelDefId)
Gets a list of the Groups that are members of the pipeline role with the specified role id and
release definition id to get Groups overridden at the release.
|
IntegrationInstancePojo |
getIntegrationInstance(java.lang.Long pIntegrationInstanceId,
java.lang.String pType)
Gets an integration instance based on the id.
|
IssueTrackingSystem |
getIssueTrackingSystemByInstanceCode(java.lang.String pInstanceCode)
Returns an ITS System for a particular ITS Instance Code.
|
IssueTrackingSystem |
getIssueTrackingSystemByInstanceId(java.lang.Long pITSInstanceId)
Returns an ITS System for a particular ITS Instance Id.
|
IssueTrackingSystem |
getIssueTrackingSystemByInstanceName(java.lang.String pInstanceName)
Returns an 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
|
java.util.List<TasksQueryResultPojo> |
getPendingTasksByChangeTicket(java.lang.String pChangeTicket)
Find Pending Tasks for given change ticket.
|
StageExecutionInformation |
getPipelineStageExecutionInfo(java.lang.Long pStageExecId)
Gets pipeline stage execution info based on the stage exec Id given.
|
java.util.List<TasksQueryResultPojo> |
getPipelineStageGateTasks(java.lang.Long pPipelineStageExecId)
Gets Task details based on pipeline stage execution id.
|
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 pTargetGroupId,
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.
|
ProjectStreamDataObject |
getProjectBranchById(java.lang.Long pBranchId,
java.lang.Long pProjectId)
Returns the project branch details for given branchId and projectId
|
java.util.List<PropertyValuePojo> |
getProjectProperties(java.lang.Long pProjectId)
Get the list of project properties for a given project id.
|
java.io.Serializable |
getProjectPropertyValue(java.lang.Long pProjectId,
java.lang.String pPropertyKeyCode)
Get the project property value for a given project id and property key code.
|
ProjectTriggerDataObject |
getProjectTriggerById(java.lang.Long pProjectTriggerId)
Returns the project trigger information based on Project Trigger id.
|
ProjectVersionDataObject |
getProjectVersionById(java.lang.Long pProjectVersionId,
java.lang.Long pProjectId)
Gets project version data object by project version id and project Id.
|
PropertyKeyDefinitionDataObject |
getPropertyKeyDefinition(java.lang.Long pPropertyKeyDefinitionId)
Retrieves a property key definition by its ID.
|
PropertyKeyDefinitionDataObject |
getPropertyKeyDefinition(java.lang.String pKeyName)
Retrieves a property key definition by its key name.
|
PropertySetDataObject |
getPropertySet(java.lang.Long pPropertySetId)
Retrieves a property set by its ID.
|
ReleasePojo |
getRelease(java.lang.Long pId)
Gets a release by a specific id.
|
RelDefinitionDataObject |
getReleaseById(java.lang.Long pRelDefinitionId)
Returns Release information for a given release definition Id.
|
RelDefinitionDataObject |
getReleaseByName(java.lang.String pRelDefinitionName)
Returns Release information for a given release name.
|
java.util.List<ReleaseProjectDetailsPojo> |
getReleaseProjectInfo(java.lang.Long pReleaseDefId)
Gets release project info based on the release definition Id.
|
java.util.List<RelPropertyDataObject> |
getReleaseProperties(java.lang.Long pReleaseDefinitionId)
Get the list of Release properties details for a given Release definition id.
|
RelPropertyDataObject |
getReleaseProperty(java.lang.Long pRelDefId,
java.lang.String pPropertyKeyCode)
Get the Release property detail for a given Release definition id and Property key code.
|
java.util.List<WorkItemDataObject> |
getReleaseWorkItems(java.lang.Long pReleaseId)
Get WorkItems associated with Release Id.
|
java.io.InputStream |
getReportDataByWorkflowExecutionReportId(java.lang.Long pWorkflowExecutionReportId)
Get a report by Workflow Execution Report ID.
|
java.util.List<WorkflowExecutionReportDataObject> |
getReportsByWorkflowExecutionId(java.lang.Long pWorkflowExecutionId)
Gets a list of WorkflowExecutionReportDataObject objects that are associated with a workflow
execution
|
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.
|
RelSnapshotDataObject |
getSnapshotDetails(java.lang.Long pSnapshotId)
RETURN a release snapshot data object by id.
|
TargetGroupDataObject |
getTargetGroupByCode(java.lang.String pTargetGroupCode)
Get the TargetGroup based on TargetGroup code passed.
|
TargetGroupDataObject |
getTargetGroupById(java.lang.Long pTargetGroupId)
Get the TargetGroup based on TargetGroup id passed.
|
TargetGroupDataObject |
getTargetGroupByName(java.lang.String pTargetGroupName)
Get the TargetGroup based on TargetGroup name passed.
|
java.util.List<PropertyKeyDataObject> |
getTargetProperties(java.lang.Long pTargetId)
Get the list of Target properties for a given target id.
|
TasksQueryExtResultRow |
getTaskById(java.lang.Long pTaskId)
Gets the task details based on the task id passed.
|
FdUserDataObject |
getUser(java.lang.String pUsername)
Returns user information for a given username.
|
FdUserDataObject |
getUserById(java.lang.Long pUserId)
Returns User information along with the user attributes and group detail for a given user Id.
|
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> |
getUsersFromGroupName(java.lang.String pGroupName)
Gets a list of FDUser objects that are members of the group with the given group name.
|
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.
|
java.util.List<FDUser> |
getUsersFromRoleId(java.lang.Long pRoleId,
java.lang.Long pRelDefId)
Gets a list of the users that are members of the pipeline role with the specified role id and
release definition id to get Users overridden at the release.
|
WorkflowExecutionDataObject |
getWorkflowExecutionById(java.lang.Long pWorkflowExecutionId)
Gets workflow execution details for workflow execution id.
|
java.util.List<WorkflowExecutionDataObject> |
getWorkflowExecutionByWorkflowRequestId(java.lang.Long pWorkflowRequestId)
Gets workflow execution details by workflow request id.
|
java.util.List<ScmCommitDataObject> |
getWorkflowExecutionCommits(java.lang.Long pWorkflowExecutionId)
Gets Commit details associated with workflow execution.
|
java.util.List<CodeValueInputPOJO> |
getWorkflowExecutionFlexfields(java.lang.Long pWorkflowExecutionId)
Gets workflow execution flexfields details for workflow execution id.
|
java.util.List<CodeValueInputPOJO> |
getWorkflowExecutionInputs(java.lang.Long pWorkflowExecutionId)
Gets workflow execution inputs details for workflow execution id.
|
java.util.List<CodeValueInputPOJO> |
getWorkflowExecutionOutputs(java.lang.Long pWorkflowExecutionId)
Gets workflow execution output details for workflow execution id.
|
WorkflowExecutionVariables |
getWorkflowExecutionVariables(java.lang.Long pWorkflowExecutionId)
Gets workflow execution variables for workflow execution id.
|
java.util.List<WorkItemDataObject> |
getWorkflowExecutionWorkItems(java.lang.Long pWorkflowExecutionId)
Gets WorkItem details associated with workflow execution.
|
java.util.List<TasksQueryResultPojo> |
getWorkflowRequestTasks(java.lang.Long pWorkflowRequestId)
Gets Task details based on workflow request id.
|
WorkItemDataObject |
getWorkItemById(java.lang.Long pWorkItemId)
Gets the WorkItem details based on WorkItem id.
|
java.util.List<FlxWorkItemFieldDataDataObject> |
getWorkItemFieldData(java.lang.String pWorkItemNumber) |
java.util.List<WorkItemDataObject> |
getWorkItemsByNumber(java.lang.String pWorkItemNumber)
Gets a list of WorkItems based on WorkItem number.
|
java.util.List<WorkItemDataObject> |
getWorkItemsForAllExecutions(java.lang.Long pSnapshotId,
java.lang.Long pEnvironmentId)
Gets WorkItem details associated with all execution for given snapshot and environment.
|
java.util.List<WorkItemDataObject> |
getWorkItemsForFailedExecutions(java.lang.Long pSnapshotId,
java.lang.Long pEnvironmentId)
Gets WorkItem details associated with failed execution for given snapshot and environment.
|
java.util.List<WorkItemDataObject> |
getWorkItemsForSnapshotVersions(java.lang.Long pSnapshotId)
Gets WorkItem details associated with snapshot versions.
|
java.util.List<WorkItemDataObject> |
getWorkItemsForSuccessfulExecutions(java.lang.Long pSnapshotId,
java.lang.Long pEnvironmentId)
Gets WorkItem details associated with successful execution for given snapshot and environment.
|
java.lang.String |
getWorkItemStatus(WorkItemDataObject pWorkItem)
Gets WorkItem Status.
|
java.util.List<FlxWorkItemStatusDataObject> |
getWorkItemStatuses() |
java.util.List<FlxWorkItemTypeDataObject> |
getWorkItemTypes() |
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 pbranchName)
Deprecated.
|
boolean |
isBotUsername(java.lang.String pUsername)
Return whether a username (case-insensitive) is a FlexDeploy bot username and not a FlexDeploy
user.
|
java.lang.String |
parseWorkItemRichText(java.lang.String pWorkItemRichText)
Parse Rich Text to retrieve raw text.
|
void |
patchBranch(java.lang.Long pProjectId,
java.lang.Long pBranchId,
ProjectStreamDataObject pBranch)
Patches a FlexDeploy Branch on a given project.
|
CmsTicketDataObject |
patchCmsTicket(CmsTicketDataObject pCmsTicketDataObject)
Update CMS Ticket with the provided data.
|
FdCommentDataObject |
patchComment(FdCommentDataObject pCommentDataObj)
Update Comment with the provided data.
|
CredentialDataObject |
patchCredential(CredentialDataObject pCredentialDataObject)
Update Credential with the provided data.
|
EndpointDataObject |
patchEndpoint(EndpointDataObject pEndpointDataObject)
Update Endpoint with the provided data.
|
EnvironmentDataObject |
patchEnvironment(EnvironmentDataObject pEnvDataObject)
Update Environment with the provided data.
|
FlxWorkItemDataObject |
patchFlxWorkItem(FlxWorkItemDataObject pPojo)
Patches a FlexWorkItem with the provided data.
|
FlxWorkItemFieldDataObject |
patchFlxWorkItemField(FlxWorkItemFieldDataObject pPojo)
Patches a FlexWorkItem Field with the provided data.
|
PropertyKeyGroupDataObject |
patchFlxWorkItemFieldGroup(PropertyKeyGroupDataObject pDobj)
Patches a FlexWorkItem Field Group with the provided data.
|
FolderDataObject |
patchFolder(FolderDataObject pFolderDataObject)
Update Folder with the provided data.
|
FdGroupDataObject |
patchGroup(FdGroupDataObject pGroupDataObject)
Update Group with the provided data.
|
IntegrationInstancePojo |
patchIntegrationInstanceAndProperties(IntegrationInstancePojo pPojo)
Updates an Integration instance and its properties with the provided data.
|
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.
|
ProjectTriggerDataObject |
patchProjectTrigger(ProjectTriggerDataObject pPojo)
Updates a project trigger with the provided data.
|
PropertyKeyDefinitionDataObject |
patchPropertyKeyDefinition(PropertyKeyDefinitionDataObject pPojo)
updates a property key definition with the provided data.
|
RelDefinitionDataObject |
patchRelease(RelDefinitionDataObject pReleasePojo)
Updates a release with the provided data.
|
RelProjectDataObject |
patchReleaseProject(RelProjectDataObject pRelProjectDataObj)
Updates a release with the provided data.
|
void |
patchStream(java.lang.Long pProjectId,
java.lang.Long pBranchId,
ProjectStreamDataObject pStream)
Deprecated.
|
TargetGroupDataObject |
patchTargetGroup(TargetGroupDataObject pTargetGroupDataObj)
Update TargetGroup with the provided data.
|
java.util.List<PropertyKeyDataObject> |
patchTargetProperties(java.lang.Long pTargetId,
java.util.List<PropertyKeyDataObject> pPropertiesToUpdate)
Updates a Target's properties with the provided data.
|
FdUserDataObject |
patchUser(FdUserDataObject pUserDataObject)
Update User with the provided data.
|
WorkItemDataObject |
patchWorkItem(WorkItemDataObject pPojo)
Patches a WorkItem with the provided data.
|
FdCommentDataObject |
patchWorkItemComment(java.lang.String pCommentId,
java.lang.String pComment)
Update a WorkItem comment with the provided data.
|
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 pBranchId)
Deprecated.
|
void |
rejectManualStepBySnapshotId(java.lang.String pUsername,
java.lang.Long pSnapshotId)
Reject a manual step Human task.
|
void |
rejectManualStepByTaskId(java.lang.String pUsername,
java.lang.Long pTaskId)
Reject a manual step Human task.
|
void |
rejectTask(java.lang.String pUsername,
java.lang.String pTaskIdentifier,
java.lang.String pNotes)
Reject a FlexDeploy Task.
|
void |
rejectTaskById(java.lang.Long pTaskId,
java.lang.String pNotes)
Rejects a FlexDeploy Approval or Scheduled Window task.
|
void |
removeProjectsFromRelease(java.lang.String pReleaseName,
java.util.List<ReleaseProjectsPojo> pReleaseProjects)
Remove FlexDeploy projects from a given release.
|
void |
removeWorkItemsFromRelease(java.lang.Long pReleaseId,
java.lang.Long pInstanceId,
java.util.List<java.lang.String> pWorkItemNumbers,
boolean pRemoveAssociatedProjects)
Remove WorkItems and associated Projects from given Release.
|
java.util.List<FlxWorkItemFieldDataDataObject> |
saveFlxWorkItemFieldData(java.lang.String pWorkItemNumber,
java.lang.String pFieldName,
java.io.Serializable pValue)
Saves FlexWorkItem field data on given WorkItem number, field name and value.
|
java.util.List<FlxWorkItemFieldDataObject> |
saveFlxWorkItemFields(java.util.List<FlxWorkItemFieldDataObject> pPojos,
java.lang.String pGroupCode)
Updates all FlexWorkItem Fields within a group.
|
java.util.List<FlxWorkItemFieldDataDataObject> |
saveWorkItemFieldData(java.lang.String pWorkItemNumber,
java.lang.String pFieldName,
java.io.Serializable pValue) |
PaginatedResponse<ProjectStreamDataObject> |
searchBranches(ProjectStreamDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Branches based provided search parameters and pagination input.
|
PaginatedResponse<SearchResponse> |
searchByTag(java.lang.String pTagName,
java.lang.Boolean pShowInactive,
java.lang.Integer pLimit,
java.lang.Integer pOffset) |
PaginatedResponse<SearchResponse> |
searchByTag(java.lang.String pTagName,
java.lang.Boolean pShowInactive,
java.util.List<FlexDeploySecurityConstants.SecurityObjectType> pSearchEntities,
java.lang.Integer pLimit,
java.lang.Integer pOffset) |
PaginatedResponse<CmsTicketDataObject> |
searchCmsTickets(CmsTicketDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find CMS Ticket based on provided search parameters and pagination input.
|
PaginatedResponse<CredentialDataObject> |
searchCredentials(CredentialDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Credentials based provided search parameters and pagination input.
|
PaginatedResponse<EndpointDataObject> |
searchEndpoints(EndpointDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Endpoints based provided search parameters and pagination input.
|
PaginatedResponse<EnvironmentDataObject> |
searchEnvironments(EnvironmentDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Environments based provided search parameters and pagination input.
|
PaginatedResponse<PropertyKeyGroupDataObject> |
searchFlxWorkItemFieldGroups(PropertyKeyGroupDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find FlexWorkItem Field Groups based provided search parameters and pagination input.
|
PaginatedResponse<FlxWorkItemFieldDataObject> |
searchFlxWorkItemFields(FlxWorkItemFieldDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find FlexWorkItem Fields based provided search parameters and pagination input.
|
PaginatedResponse<FlxWorkItemDataObject> |
searchFlxWorkItems(FlxWorkItemDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find FlexWorkItems based provided search parameters and pagination input.
|
PaginatedResponse<FlxWorkItemStatusDataObject> |
searchFlxWorkItemStatuses(FlxWorkItemStatusDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find FlexWorkItem Statuses based provided search parameters and pagination input.
|
PaginatedResponse<FlxWorkItemTypeDataObject> |
searchFlxWorkItemTypes(FlxWorkItemTypeDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find FlexWorkItem Types based provided search parameters and pagination input.
|
PaginatedResponse<FolderDataObject> |
searchFolders(FolderDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Folders based provided search parameters and pagination input.
|
PaginatedResponse<FdGroupDataObject> |
searchGroups(FdGroupDataObject pGroupObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Groups based provided search parameters and pagination input.
|
PaginatedResponse<ProjectPackageDataObject> |
searchProjectPackages(ProjectPackageDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Packages based provided search parameters and pagination input.
|
PaginatedResponse<ProjectDataObject> |
searchProjects(ProjectDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Projects based provided search parameters and pagination input.
|
PaginatedResponse<ProjectTriggerDataObject> |
searchProjectTriggers(ProjectTriggerDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Project Triggers based provided search parameters and pagination input.
|
PaginatedResponse<ProjectVersionDataObject> |
searchProjectVersions(ProjectVersionDataObject pParameters,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Project Versions based provided search parameters and pagination input.
|
PaginatedResponse<PropertyKeyDefinitionDataObject> |
searchPropertyKeyDefinitions(PropertyKeyDefinitionDataObject pSearchParams,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find property key definitions based provided search parameters and pagination input.
|
PaginatedResponse<PropertySetDataObject> |
searchPropertySets(PropertySetDataObject pSearchParams,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find property sets based provided search parameters and pagination input.
|
PaginatedResponse<RelProjectDataObject> |
searchReleaseProjects(RelProjectDataObject pPojo,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Release Projects based on provided search parameters and pagination input.
|
PaginatedResponse<RelDefinitionDataObject> |
searchReleases(RelDefinitionDataObject pPojo,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Releases based on provided search parameters and pagination input.
|
PaginatedResponse<TargetGroupDataObject> |
searchTargetGroups(TargetGroupDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find TargetGroups based provided search parameters and pagination input.
|
PaginatedResponse<TasksQueryResultPojo> |
searchTasks(TasksQueryResultPojo pPojo,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Tasks based provided search parameters and pagination input.
|
PaginatedResponse<FdUserDataObject> |
searchUsers(FdUserDataObject pUserObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find Users based provided search parameters and pagination input.
|
PaginatedResponse<WorkflowDataObject> |
searchWorkflows(WorkflowDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset) |
PaginatedResponse<WorkItemDataObject> |
searchWorkItems(WorkItemDataObject pCriteriaObject,
java.lang.Integer pLimit,
java.lang.Integer pOffset)
Find WorkItems based on provided search parameters and pagination input.
|
void |
startRelease(java.lang.Long pReleaseId)
Start a FlexDeploy Release.
|
void |
startRelease(java.lang.String pReleaseName)
Start a FlexDeploy Release.
|
void |
unassignGroupFromUser(java.lang.Long pGroupId,
java.lang.Long pUserId)
Unassigns Group from User with the provided data.
|
void |
unassignGroupFromUser(java.lang.String pGroupName,
java.lang.String pUserName)
Unassigns Group from User with the provided data.
|
void |
unassignTag(FlexDeploySecurityConstants.SecurityObjectType pObjectType,
java.lang.Long pObjectId,
java.lang.String pTagName)
Unassigns tag from the object with the provided data.
|
void |
updateBranch(java.lang.Long pProjectId,
java.lang.Long pBranchId,
ProjectStreamPojo pBranch)
Updates a FlexDeploy Branch on a given project.
|
CmsTicketDataObject |
updateCmsTicket(CmsTicketDataObject pCmsTicketDataObject)
Update CMS Ticket based on the CMS Ticket details.
|
CredentialDataObject |
updateCredential(CredentialDataObject pCredentialDataObject)
Update Credential with the provided data.
|
EndpointDataObject |
updateEndpoint(EndpointDataObject pEndpointDataObject)
Update Endpoint based on the Endpoint details.
|
EnvironmentDataObject |
updateEnvironment(EnvironmentDataObject pEnvDataObject)
Update Environment based on the Environment details.
|
FlxWorkItemDataObject |
updateFlxWorkItem(FlxWorkItemDataObject pPojo)
Updates FlexWorkItem based on the provided details.
|
FlxWorkItemDataObject |
updateFlxWorkItemAssignee(java.lang.String pWorkItemNumber,
java.lang.String pUserName)
Updates a FlexWorkItem Assignee.
|
FlxWorkItemFieldDataObject |
updateFlxWorkItemField(FlxWorkItemFieldDataObject pDobj)
Updates FlexWorkItem field based on the FlexWorkItem field details.
|
PropertyKeyGroupDataObject |
updateFlxWorkItemFieldGroup(PropertyKeyGroupDataObject pDobj)
Updates FlexWorkItem field group based on the FlexWorkItem field group details.
|
FlxWorkItemDataObject |
updateFlxWorkItemStatus(java.lang.String pWorkItemNumber,
java.lang.String pStatusName)
Updates a FlexWorkItem status.
|
FlxWorkItemDataObject |
updateFlxWorkItemType(java.lang.String pWorkItemNumber,
java.lang.String pTypeCode)
Updates a FlexWorkItem Type.
|
FolderDataObject |
updateFolder(FolderDataObject pFolderDataObject)
Update Folder based on the Folder details.
|
FdGroupDataObject |
updateGroup(FdGroupDataObject pGroupDataObject)
Update Group based on the Group details.
|
IntegrationInstancePojo |
updateIntegrationInstanceAndProperties(IntegrationInstancePojo pPojo)
Updates an existing Integration instance and its associated properties with the provided data.
|
void |
updatePackage(java.lang.Long pProjectId,
java.lang.String pPackageName,
java.lang.Long pBranchId,
PollingResult pPollingResult)
Updates a given package relative to a PollingResult.
|
void |
updatePackage(java.lang.Long pProjectId,
java.lang.String pPackageName,
java.lang.Long pBranchId,
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.
|
void |
updateProjectProperty(java.lang.Long pProjectId,
java.lang.String pPropertyKeyCode,
java.io.Serializable pNewValue)
Update a project property with the provided property key code and project id.
|
ProjectTriggerDataObject |
updateProjectTrigger(ProjectTriggerDataObject pPojo)
Updates Project Trigger based on the project trigger details.
|
PropertyKeyDefinitionDataObject |
updatePropertyKeyDefinition(PropertyKeyDefinitionDataObject pPojo)
Updates a property key definition with the provided data.
|
RelDefinitionDataObject |
updateRelease(RelDefinitionDataObject pReleasePojo)
Updates a Release with the provided data.
|
RelProjectDataObject |
updateReleaseProject(RelProjectDataObject pRelProjectDataObj)
Updates a Release with the provided data.
|
java.util.List<RelPropertyDataObject> |
updateReleaseProperties(java.lang.Long pReleaseDefinitionId,
java.util.List<RelPropertyDataObject> pInputs)
Updates a Release properties with the provided data.
|
void |
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 pBranchId,
ProjectStreamPojo pStream)
Deprecated.
|
TargetGroupDataObject |
updateTargetGroup(TargetGroupDataObject pTargetGroupDataObj)
Update TargetGroup based on the TargetGroup details.
|
java.util.List<PropertyKeyDataObject> |
updateTargetProperties(java.lang.Long pTargetId,
java.util.List<PropertyKeyDataObject> pPropertiesToUpdate)
Updates a Target's properties with the provided data.
|
FdUserDataObject |
updateUser(FdUserDataObject pUserDataObject)
Update User based on the User details.
|
PropertySetDataObject |
updateWorkflowPropertySet(PropertySetDataObject pPropertySet)
Updates a property set with the provided data.
|
WorkItemDataObject |
updateWorkItem(WorkItemDataObject pPojo)
Updates a WorkItem based on the provided details.
|
FlxWorkItemDataObject |
updateWorkItemAssignee(java.lang.String pWorkItemNumber,
java.lang.String pUserName) |
FlxWorkItemDataObject |
updateWorkItemStatus(java.lang.String pWorkItemNumber,
java.lang.String pStatusName) |
FlxWorkItemDataObject |
updateWorkItemType(java.lang.String pWorkItemNumber,
java.lang.String pTypeCode) |
void |
uploadAttachmentsToIncident(java.lang.String pCMSInstanceCode,
java.lang.String pIncidentNumber,
java.util.Map<java.lang.String,java.io.InputStream> pAttachments)
Uploads attachments to an existing Jira or ServiceNow CMS Incident.
|
void |
uploadAttachmentsToTicket(java.lang.String pCMSInstanceCode,
java.lang.String pTicketNumber,
java.util.Map<java.lang.String,java.io.InputStream> pAttachments)
Uploads attachments to an existing Jira or ServiceNow CMS Ticket.
|
captureSecureValuesForLogFunction, decryptIntegrationInstance, doSimpleGet, findIntegrationInstanceByCode, getLogFunctions, getServerBaseUrl, setScriptRefpublic FlexDeploy2Functions()
public FlexDeploy2Functions(boolean isExecute,
LogFunctions pFLOG)
public PollingResult findLocalChangeLogs(java.lang.String pUrl, java.lang.String pBranch, java.lang.String pCurrentRevision, java.lang.String pFromRevision) throws FlexCheckedException
findLocalChangeLogsfindLocalChangeLogs in interface IFlexDeployFunctionspUrl - Url of the git repository to find logs againstpBranch - Branch to find logs againstpCurrentRevision - Current revision after the pushpFromRevision - Previous revision before the pushFlexDeployValidationException - if an invalid revision is passed.FlexCheckedExceptionpublic PollingResult findLocalChangeLogs(java.lang.String pUrl, java.lang.String pBranch, java.lang.String pCurrentRevision, java.lang.String pFromRevision, boolean pIgnoreTargetBranchMerge) throws FlexCheckedException
findLocalChangeLogsfindLocalChangeLogs in interface IFlexDeployFunctionspUrl - Url of the git repository to find logs againstpBranch - Branch to find logs againstpCurrentRevision - Current revision after the pushpFromRevision - Previous revision before the pushpIgnoreTargetBranchMerge - 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 trueFlexDeployValidationException - if an invalid revision is passed.FlexCheckedExceptionpublic 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
findLocalChangeLogs in interface IFlexDeployFunctionspUrl - Url of the git repository to find logs againstpBranch - Branch to find logs againstpCurrentRevision - Current revision after the pushpFromRevision - Previous revision before the pushpUser - User to use for local credentialspPassword - Password of the userFlexDeployValidationException - if an invalid revision is passed.FlexCheckedExceptionpublic 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
findLocalChangeLogs in interface IFlexDeployFunctionspUrl - Url of the git repository to find logs againstpBranch - Branch to find logs againstpCurrentRevision - Current revision after the pushpFromRevision - Previous revision before the pushpUser - User to use for local credentialspPassword - Password of the userpIgnoreTargetBranchMerge - 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 trueFlexDeployValidationException - if an invalid revision is passed.FlexCheckedExceptionpublic ProjectPojo getProject(java.lang.Long pProjectId) throws FlexDeployRowNotFoundException
getProject in interface IFlexDeployFunctionspProjectId - Project Id of the project to retrieveFlexDeployRowNotFoundException - if no project is found for given pProjectIdpublic java.lang.Long createProject(ProjectPojo pProjectPojo)
createProject in interface IFlexDeployFunctionspProjectPojo - - Object containing project configuration information.public java.lang.Long updateProject(java.lang.Long pProjectId,
ProjectPojo pProjectPojo)
updateProject in interface IFlexDeployFunctionspProjectId - - Id of the project that is to be updated.pProjectPojo- - Object containing project configuration information.FlexDeployRowNotFoundException - if pProjectId does not exist.public java.lang.Long patchProject(java.lang.Long pProjectId,
ProjectPojo pProjectPojo)
patchProject in interface IFlexDeployFunctionspProjectId - - Id of the project that is to be updated.pProjectPojo- - Object containing project configuration information.FlexDeployRowNotFoundException - if pProjectId does not exist.public java.lang.Long updateProjectProperties(java.lang.Long pProjectId,
java.util.List<PropertyValuePojo> pPropertyPojos)
updateProjectProperties in interface IFlexDeployFunctionspProjectId - - Id of the project that is to be updated.pPropertyPojos - - List of property values to be updated on project.public java.lang.Long patchProjectProperties(java.lang.Long pProjectId,
java.util.List<PropertyValuePojo> pPropertyPojos)
patchProjectProperties in interface IFlexDeployFunctionspProjectId - - Id of the project that is to be updated.pPropertyPojos - - List of property values to be updated on project.public void addFilesToPackage(java.lang.Long pProjectId,
java.lang.String pPackageName,
java.util.List<java.lang.String> pFiles)
addFilesToPackage in interface IFlexDeployFunctionspProjectId - Parent project id of the packagepPackageName - Name of the packagepFiles - Filepaths to add to the package.FlexDeployRowNotFoundException - if pPackageName does not exist on project
pProjectId.@Deprecated
public java.lang.Integer populateFiles(java.lang.Long pProjectId,
java.lang.Long pBranchId)
populateFiles in interface IFlexDeployFunctionspublic java.lang.Integer discoverFiles(java.lang.Long pProjectId,
java.lang.Long pBranchId)
discoverFiles in interface IFlexDeployFunctionspProjectId - Project id to populate files for. This should be a project using partial
deployment.pBranchId - Branch id to use when populating.FlexDeployAPIException - if it is message wrapper error.findBranchId(java.lang.Long, java.lang.String)public java.lang.Integer discoverFiles(java.lang.Long pProjectId,
java.lang.Long pBranchId,
boolean pInactivateMissingFiles)
discoverFiles in interface IFlexDeployFunctionspublic void updatePackageStatus(java.lang.Long pProjectId,
java.lang.String pPackageName,
java.lang.String pPackageStatus)
updatePackageStatus in interface IFlexDeployFunctionspProjectId - Parent project id of the packagepPackageName - Name of the packagepPackageStatus} - The updated package status [ACTIVE, COMPLETED, or INACTIVE]FlexDeployRowNotFoundException - if pProjectId is not found or
pPackageName does not exist on projectFlexDeployValidationException - if pPackageStatus is invalidpublic void updatePackage(java.lang.Long pProjectId,
java.lang.String pPackageName,
java.lang.Long pBranchId,
PollingResult pPollingResult)
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.updatePackage in interface IFlexDeployFunctionspProjectId - Parent project id of the packagepPackageName - Name of the packagepBranchId - Branch to use when populating files if new files are foundpPollingResult - PollingResult object to use for finding differencesFlexDeployRowNotFoundException - if pProjectId is not found or
pPackageName does not exist on projectFlexDeployValidationException - if project other than SCM Type GIT is invalid.BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String),
GithubFunctions.getChangeLogs(java.lang.Object)public void updatePackage(java.lang.Long pProjectId,
java.lang.String pPackageName,
java.lang.Long pBranchId,
PollingResult pPollingResult,
boolean pSortFiles)
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.updatePackage in interface IFlexDeployFunctionspProjectId - Parent project id of the packagepPackageName - Name of the packagepBranchId - Branch to use when populating files if new files are foundpPollingResult - PollingResult object to use for finding differencespSortFiles - Sort package files after updateFlexDeployRowNotFoundException - if pProjectId is not found or
pPackageName does not exist on projectFlexDeployValidationException - if project other than SCM Type GIT is invalid.BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String),
GithubFunctions.getChangeLogs(java.lang.Object)public java.lang.Long createPackage(java.lang.Long pProjectId,
java.lang.String pPackageName,
java.lang.String pDescription,
java.util.List<java.lang.String> pFiles)
createPackage in interface IFlexDeployFunctionspProjectId - 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.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)
createDynamicPackage in interface IFlexDeployFunctionspProjectId - 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.public java.lang.Long createPackage(java.lang.Long pProjectId,
java.lang.String pPackageName,
java.lang.String pDescription,
java.lang.Long pBranchId,
PollingResult pPollingResult)
createPackage in interface IFlexDeployFunctionspProjectId - Parent project id of the packagepPackageName - Name of the packagepDescription - Description to give the package.pPollingResult - PollingResult object to use for finding differencesFlexDeployRowNotFoundException - if pProjectId is not found or
pPackageName does not exist on projectFlexDeployValidationException - if project pProjectId is invalid,BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String),
GithubFunctions.getChangeLogs(java.lang.Object)public void deletePackage(java.lang.Long pProjectId,
java.lang.String pPackageName)
deletePackage in interface IFlexDeployFunctionspProjectId - Parent project id package is under.pPackageName - Name of package to delete.public java.lang.Long buildPackage(java.lang.Long pBranchId,
ProjectPackagePojo projectPackage)
PollingResult variantbuildPackage in interface IFlexDeployFunctionspBranchId - Branch to use when building package. See
findBranchId.projectPackage - Wrapper object containing project id and package name to build.FlexDeployRowNotFoundException - if pBranchId not found in project.
if no row found for project.
if default build environment not foundFlexDeployValidationException - if requested project is a utility project.
if requested project is not active.
if no build workflow or target group mapped for the
project.public java.lang.Long buildPackage(java.lang.Long pBranchId,
ProjectPackagePojo projectPackage,
BuildOptions pBuildOptions)
PollingResult variantbuildPackage in interface IFlexDeployFunctionspBranchId - Branch to use when building package. See
findBranchId.projectPackage - Wrapper object containing project id and package name to build.pBuildOptions - Additional build object where optional options can be set.FlexDeployRowNotFoundException - if pBranchId not found in project.
if no row found for project.
if default build environment not foundFlexDeployValidationException - if requested project is a utility project.
if requested project is not active.
if no build workflow or target group mapped for the
project.public java.lang.Long buildPackage(java.lang.Long pBranchId,
ProjectPackagePojo projectPackage,
PollingResult pPollingResult)
buildPackage in interface IFlexDeployFunctionspBranchId - Branch to use when building package. See
findBranchId.projectPackage - Wrapper object containing project id and package name to build.pPollingResult - PollingResult object containing change logs and committer information.FlexDeployRowNotFoundException - if pBranchId not found in project.
if no row found for project.
if default build environment not foundFlexDeployValidationException - if requested project is a utility project.
if requested project is not active.
if no build workflow or target group mapped for the
project.BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String),
GithubFunctions.getChangeLogs(java.lang.Object)public java.lang.Long buildPackage(java.lang.Long pBranchId,
ProjectPackagePojo projectPackage,
PollingResult pPollingResult,
BuildOptions pBuildOptions)
buildPackage in interface IFlexDeployFunctionspBranchId - Branch to use when building package. See
findBranchId.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.FlexDeployRowNotFoundException - if pBranchId not found in project.
if no row found for project.
if default build environment not foundFlexDeployValidationException - if requested project is a utility project.
if requested project is not active.
if no build workflow or target group mapped for the
project.BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String),
GithubFunctions.getChangeLogs(java.lang.Object)public java.lang.Long buildProject(java.lang.Long pBranchId,
java.lang.Long pProjectId)
PollingResult variantbuildProject in interface IFlexDeployFunctionspBranchId - Branch to use when building project. See findBranchId.pProjectId - Project id to build.FlexDeployRowNotFoundException - if pBranchId not found in project.
if no row found for project.
if default build environment not foundFlexDeployValidationException - if requested project is a utility project.
if requested project is not active.
if no build workflow or target group mapped for the
project.public java.lang.Long buildProject(java.lang.Long pBranchId,
java.lang.Long pProjectId,
BuildOptions pBuildOptions)
PollingResult variantbuildProject in interface IFlexDeployFunctionspBranchId - Branch to use when building project. See
findBranchId.pProjectId - Project id to build.pBuildOptions - Additional build object where optional options can be set.FlexDeployRowNotFoundException - if pBranchId not found in project.
if no row found for project.
if default build environment not foundFlexDeployValidationException - if requested project is a utility project.
if requested project is not active.
if no build workflow or target group mapped for the
project.public java.lang.Long buildProject(java.lang.Long pBranchId,
java.lang.Long pProjectId,
PollingResult pPollingResult)
buildProject in interface IFlexDeployFunctionspBranchId - Branch to use when building project. See
findBranchId.pProjectId - Project id to build.pPollingResult - PollingResult object containing change logs and committer information.FlexDeployRowNotFoundException - if pBranchId not found in project.
if no row found for project.
if default build environment not foundFlexDeployValidationException - if requested project is a utility project.
if requested project is not active.
if no build workflow or target group mapped for the
project.BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String),
GithubFunctions.getChangeLogs(java.lang.Object)public java.lang.Long buildProject(java.lang.Long pBranchId,
java.lang.Long pProjectId,
PollingResult pPollingResult,
BuildOptions pBuildOptions)
buildProject in interface IFlexDeployFunctionspBranchId - Branch to use when building project. See
findBranchId.pProjectId - Project id to build.pPollingResult - PollingResult object containing change logs and committer information.pBuildOptions - Additional build object where optional options can be set.Long WorkflowRequest idFlexDeployRowNotFoundException - if pBranchId not found in project.
if no row found for project.
if default build environment not foundFlexDeployValidationException - if requested project is a utility project.
if requested project is not active.
if no build workflow or target group mapped for the
project.BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String),
GithubFunctions.getChangeLogs(java.lang.Object)public java.lang.Long deployPackage(java.lang.Long pProjectId,
java.lang.String pPackageName,
java.lang.String pEnvironmentCode,
DeployOptions pDeployOptions)
deployPackage in interface IFlexDeployFunctionspProjectId - Project id to deploy.pPackageName - Name of packagepEnvironmentCode - Code of the environment.pDeployOptions - Additional deploy object where optional options can be set.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.public java.lang.Long deployProject(java.lang.Long pProjectId,
java.lang.String pEnvironmentCode,
DeployOptions pDeployOptions)
deployProject in interface IFlexDeployFunctionspProjectId - Project id to deploy.pEnvironmentCode - Code of the environment.pDeployOptions - Additional deploy object where optional options can be set.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.public java.util.Set<java.lang.Long> findProjectsForNewBranch(java.lang.String pRepositoryName)
findProjectsForNewBranch in interface IFlexDeployFunctionspRepositoryName - Git repository name with the change. Name is of the form
(username/repo). e.g. toddmotto/public-apispublic java.util.Set<java.lang.Long> findProjectsForNewBranch(java.lang.String pRepositoryName,
PollingResult pPollingResult)
findProjectsForNewBranch.
This function currently only compares against Git repositories and is not compatible with other
scm types.findProjectsForNewBranch in interface IFlexDeployFunctionspRepositoryName - Git repository name with the change. Name is of the form
(username/repo). e.g. toddmotto/public-apispPollingResult - PollingResult object for determining relevant projects.BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String),
GithubFunctions.getChangeLogs(java.lang.Object)public java.util.Set<java.lang.Long> findProjectsForChange(java.lang.String pRepositoryName,
java.lang.String pbranchName,
PollingResult pPollingResult)
findProjectsForChange in interface IFlexDeployFunctionspRepositoryName - Git repository name with the change. Name is of the form
(username/repo). e.g. toddmotto/public-apispbranchName - Branch name for which the change occurred. e.g. 'master'pPollingResult - PollingResult object for determining relevant projects.BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String),
GithubFunctions.getChangeLogs(java.lang.Object)public java.util.Set<java.lang.Long> findProjectsForChange(java.lang.String pRepositoryName,
java.lang.String pbranchName,
java.util.List<java.lang.String> pChangedFiles)
findProjectsForChange in interface IFlexDeployFunctionspRepositoryName - Git repository name with the change. Name is of the form
(username/repo). e.g. toddmotto/public-apispbranchName - 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.BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String),
GithubFunctions.getChangeLogs(java.lang.Object)public java.util.Set<ProjectPackagePojo> findPackagesForChange(java.lang.String pRepositoryName, java.lang.String pbranchName, PollingResult pPollingResult)
findPackagesForChange in interface IFlexDeployFunctionspRepositoryName - Git repository name with the change. Name is of the form
(username/repo). e.g. toddmotto/public-apispbranchName - Branch name for which the change occurred. e.g. 'master'pPollingResult - PollingResult object for determining relevant packages.BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String),
GithubFunctions.getChangeLogs(java.lang.Object)public java.util.Set<ProjectPackagePojo> findPackagesForChange(java.lang.String pRepositoryName, java.lang.String pbranchName, java.util.List<java.lang.String> pChangedFiles)
findPackagesForChange in interface IFlexDeployFunctionspRepositoryName - Git repository name with the change. Name is of the form
(username/repo). e.g. toddmotto/public-apispbranchName - 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.BitbucketFunctions.getChangeLogs(java.lang.Object, java.lang.String, java.lang.String),
GithubFunctions.getChangeLogs(java.lang.Object)public java.lang.Long findProjectId(java.lang.String pProjectName)
findProjectId in interface IFlexDeployFunctionspProjectName - Case sensitive project name to search byFlexDeployRowNotFoundException - if no row found for pProjectName.public ProjectDataObject findProjectWithId(java.lang.Long pProjectId)
findProjectWithId in interface IFlexDeployFunctionspProjectId- - Id of Project to find.FlexDeployRowNotFoundException - if no row found for pProjectId.public java.util.List<ProjectDataObject> findProjectsWithName(java.lang.String pProjectName)
findProjectsWithName in interface IFlexDeployFunctionspProjectName - Case insensitive project name to search bypublic PaginatedResponse<ProjectDataObject> searchProjects(ProjectDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchProjects in interface IFlexDeployFunctionspCriteriaObject - - ProjectDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public java.lang.Long findBranchId(java.lang.Long pProjectId,
java.lang.String pBranchName)
findBranchId in interface IFlexDeployFunctionspProjectId - Project id on which the branch belongs.pBranchName - Name of the branch. e.g. 'feature/JIRA-12', 'master'.FlexDeployRowNotFoundException - if no row found for pBranchName for
pProjectId.public java.lang.Long createBranch(java.lang.Long pProjectId,
java.lang.String pBranchName,
java.lang.String pVersionSyntax)
createBranch in interface IFlexDeployFunctionspProjectId - 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.public java.lang.Long createBranch(java.lang.Long pProjectId,
ProjectStreamPojo pBranch)
createBranch in interface IFlexDeployFunctionspProjectId - Project to create the branch on.pBranch - ProjectStreamDataObject object representing the branch to create.public java.lang.Long createBranch(java.lang.Long pProjectId,
java.lang.String pBranchName)
createBranch in interface IFlexDeployFunctionspProjectId - Project to create the branch on.pBranchName - Branch name to create.public void updateBranch(java.lang.Long pProjectId,
java.lang.Long pBranchId,
ProjectStreamPojo pBranch)
updateBranch in interface IFlexDeployFunctionspProjectId - Project to create the branch on.pBranchId - Id of the branch to update.pBranch - ProjectStreamPojo object representing the branch to update.FlexDeployRowNotFoundException - if pBranchId does not exist for
pProjectId.public void patchBranch(java.lang.Long pProjectId,
java.lang.Long pBranchId,
ProjectStreamDataObject pBranch)
patchBranch in interface IFlexDeployFunctionspProjectId - Project to create the branch on.pBranchId - Id of the branch to update.pBranch - ProjectStreamDataObject object representing the branch to update.FlexDeployRowNotFoundException - if pBranchId does not exist for
pProjectId.public void inactivateBranch(java.lang.Long pProjectId,
java.lang.String pBranchName)
inactivateBranch in interface IFlexDeployFunctionspProjectId - pBranchName - public void activateBranch(java.lang.Long pProjectId,
java.lang.String pBranchName)
activateBranch in interface IFlexDeployFunctionspProjectId - project id for which the branch belongs.pBranchName - Branch name to inactivate.public IntegrationInstancePojo findIntegrationInstance(java.lang.String pIntegrationInstanceCode, java.lang.String pType) throws FlexNotFoundException
findIntegrationInstance in interface IFlexDeployFunctionspIntegrationInstanceCode - Code for the integration instance.pType - Type of the integration instance. {SCM, TEST, ITS, CMS, CLOUD,
ARTIFACTREPO, CISERVER, SCANTOOL, MESSAGING, OTHERTOOLS}.FlexNotFoundException - if no integration instance found for passed code.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)
createSCMInstance in interface IFlexDeployFunctionspSCMInstanceName - - The unique name of the SCM instance.pDescription - - The description of the SCM instance.pIsActive - - Whether 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.FlexDeployValidationException - if an invalid value is passed in pSCMInstancePojo.public java.lang.Long createSCMInstance(SCMInstancePojo pSCMInstancePojo)
createSCMInstance in interface IFlexDeployFunctionspSCMInstancePojo - - The object containing all of the required data for the SCM instance.FlexDeployValidationException - if an invalid value is passed in pSCMInstancePojo.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)
updateSCMInstance in interface IFlexDeployFunctionspSCMInstanceId - - 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 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.FlexDeployValidationException - if an invalid value is passed in pSCMInstancePojo.public java.lang.Long updateSCMInstance(java.lang.Long pSCMInstanceId,
SCMInstancePojo pSCMInstancePojo)
updateSCMInstance in interface IFlexDeployFunctionspSCMInstanceId - - The Id of the instance to be updated.pSCMInstancePojo - - Object containing all of the required data for the SCM instance.FlexDeployValidationException - if an invalid value is passed in pSCMInstancePojo.public IntegrationInstancePojo getIntegrationInstance(java.lang.Long pIntegrationInstanceId, java.lang.String pType)
getIntegrationInstance in interface IFlexDeployFunctionspIntegrationInstanceId - Integration Instance id.pType - Type of the integration instance. {SCM, TEST, ITS, CMS, CLOUD,
ARTIFACTREPO, CISERVER, SCANTOOL, MESSAGING, OTHERTOOLS}.FlexDeployRowNotFoundException - if no integration instance found for
pIntegrationInstanceId.public CMSInstancePojo findCMSInstance(java.lang.String pCMSInstanceCode)
findCMSInstance in interface IFlexDeployFunctionspCMSInstanceCode - Code of the instance you wish to retrieve.FlexDeployRowNotFoundException - if no instance found for pCMSInstanceCode.public CMSInstancePojo getCMSInstance(java.lang.Long pCMSInstanceId)
getCMSInstance in interface IFlexDeployFunctionspCMSInstanceId - Id of the instance you wish to retrieve.FlexDeployRowNotFoundException - if no instance found for pCMSInstanceId.public ChangeManagementSystem getChangeManagementSystemByInstanceCode(java.lang.String pInstanceCode)
getChangeManagementSystemByInstanceCode in interface IFlexDeployFunctionspInstanceCode - Instance code to filter by.FlexDeployRowNotFoundException - If no CMS instance was found given pCode.public ChangeManagementSystem getChangeManagementSystemByInstanceName(java.lang.String pInstanceName)
getChangeManagementSystemByInstanceName in interface IFlexDeployFunctionspInstanceName - Instance name to filter by.FlexDeployRowNotFoundException - If no CMS instance was found givenpName.@Deprecated 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)
createIncidentForWorklowRequest in interface IFlexDeployFunctionspublic CMSObject createIncidentForWorkflowRequest(java.lang.Long pWorkflowRequestId, java.util.Map<java.lang.String,java.io.Serializable> pIncidentFields, java.lang.String pCMSInstanceCode, java.lang.String pCMSInstanceName)
createIncidentForWorkflowRequest in interface IFlexDeployFunctionspWorkflowRequestId - Associated workflow request id .pIncidentFields - Payload fields populated with key value to create an Incident.pCMSInstanceCode - Instance code to filter by.pCMSInstanceName - Instance name to filter by.public CMSObject createIncidentByWorkflowType(java.lang.Long pWorkflowRequestId, java.util.Map<java.lang.String,java.io.Serializable> pIncidentFields)
createIncidentByWorkflowType in interface IFlexDeployFunctionspWorkflowRequestId - Associated workflow request id .pIncidentFields - Payload fields populated with key value to create an Incident.public ChangeManagementSystem getChangeManagementSystemByInstanceId(java.lang.Long pCMSInstanceId)
getChangeManagementSystemByInstanceId in interface IFlexDeployFunctionspCMSInstanceId - Instance id of the implementation you wish to retrieve.FlexDeployRowNotFoundException - If no instance found for pCMSInstanceId.public java.util.List<FDUser> getUsersFromGroupId(java.lang.Long pGroupId)
getUsersFromGroupId in interface IFlexDeployFunctionspGroupId - FlexDeploy Group id to use.public void downloadLogs(java.lang.Long pWorkflowExecutionId,
java.lang.String pDestinationPath)
downloadLogs in interface IFlexDeployFunctionspWorkflowExecutionId - Workflow Execution Id to capture logs for.pDestinationPath - The path where the log files folder will be saved.FlexDeployValidationException - if pDestinationPath is not provided.public java.util.Map<java.lang.Long,java.io.InputStream> getPluginLogInputStreams(java.lang.Long pWorkflowExecutionId)
getPluginLogInputStreams in interface IFlexDeployFunctionspWorkflowExecutionId - Workflow Execution Id to capture logs for.public java.util.Map<java.lang.Long,java.io.InputStream> getPluginLogInputStreams(java.lang.Long pWorkflowExecutionId,
java.lang.Boolean pOnlyError)
getPluginLogInputStreams in interface IFlexDeployFunctionspWorkflowExecutionId - 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.FlexCheckedExceptionpublic PackageDetailsResponsePojo getPackage(java.lang.Long pProjectId, java.lang.String pPackageName)
getPackage in interface IFlexDeployFunctionspProjectId - Parent project id package is under.pPackageName - Name of packageFlexDeployRowNotFoundException - If no project package found for pProjectId and
pPackageName.public java.util.Collection<PluginLogPojo> getPluginLogs(java.lang.Long pWorkflowExecutionId)
getPluginLogs in interface IFlexDeployFunctionspWorkflowExecutionId - Workflow Execution Id to capture logs for.public java.lang.String getFlexDeployBaseUrl()
getFlexDeployBaseUrl in interface IFlexDeployFunctionspublic java.lang.String getGroovyKey()
getGroovyKey in class BaseFunctionspublic void cleanup()
cleanup in class BaseFunctionspublic java.lang.Long executeUtility(java.lang.Long pProjectId,
java.lang.String pEnvironmentCode)
executeUtility in interface IFlexDeployFunctionspProjectId - Project id to execute.pEnvironmentCode - Environment code to use for the utility request.FlexDeployValidationException - if pEnvironmentCode is not provided.public java.lang.Long executeUtility(java.lang.Long pProjectId,
java.lang.String pEnvironmentCode,
ExecuteOptions pExecuteOptions)
executeUtility in interface IFlexDeployFunctionspProjectId - Project id to execute.pEnvironmentCode - Environment code to use for the utility request.pExecuteOptions - Execute options contains list of instances to execute on, with inputs
and flexfieldsFlexDeployValidationException - if pEnvironmentCode is not provided.public java.lang.Long findFolderId(java.lang.String pFolderName)
findFolderId in interface IFlexDeployFunctionspFolderName - Case-sensitive folder name to search byFlexDeployRowNotFoundException - If folder name is not found in FlexDeploypublic FolderDataObject findFolderWithId(java.lang.Long pFolderId)
findFolderWithId in interface IFlexDeployFunctionspFolderId - public java.util.List<FolderDataObject> findFoldersWithName(java.lang.String pFolderName)
findFoldersWithName in interface IFlexDeployFunctionspFolderName - Case-insensitive project name to search bypublic PaginatedResponse<FolderDataObject> searchFolders(FolderDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchFolders in interface IFlexDeployFunctionspCriteriaObject- - FolderDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public PaginatedResponse<ProjectStreamDataObject> searchBranches(ProjectStreamDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchBranches in interface IFlexDeployFunctionspCriteriaObject - - ProjectStreamDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public FdUserDataObject getUser(java.lang.String pUsername)
getUser in interface IFlexDeployFunctionspUsername - - Username of the user to retrieve.public java.lang.Long getCurrentlyDeployedVersionId(java.lang.Long pProjectId,
java.lang.Long pEnvironmentId,
java.lang.Long pTargetGroupId)
getCurrentlyDeployedVersionId in interface IFlexDeployFunctionspProjectId - Project Id of the project to retrieve.pEnvironmentId - - Id of the environment.pTargetGroupId - - Id of the instance.public java.lang.Long getCurrentlyDeployedVersionId(java.lang.Long pProjectId,
java.lang.Long pEnvironmentId,
java.lang.Long pTargetGroupId,
java.lang.String pPackageName)
getCurrentlyDeployedVersionId in interface IFlexDeployFunctionspProjectId - Project Id of the project to retrieve.pEnvironmentId - - Id of the environment.pTargetGroupId - - Id of the instance.pPackageName - - Name of the package.FlexDeployValidationException - if pPackageName is not provided.public java.lang.Long getPreviouslyDeployedVersionId(java.lang.Long pProjectId,
java.lang.Long pEnvironmentId,
java.lang.Long pInstanceId)
getPreviouslyDeployedVersionId in interface IFlexDeployFunctionspProjectId - Project Id of the project to retrieve.pEnvironmentId - - Id of the environment.pInstanceId - - Id of the instance.public java.lang.Long getPreviouslyDeployedVersionId(java.lang.Long pProjectId,
java.lang.Long pEnvironmentId,
java.lang.Long pTargetGroupId,
java.lang.String pPackageName)
getPreviouslyDeployedVersionId in interface IFlexDeployFunctionspProjectId - Project Id of the project to retrieve.pEnvironmentId - - Id of the environment.pTargetGroupId - - Id of the instance.pPackageName - - Name of the package.FlexDeployValidationException - if pPackageName is not provided.@Deprecated
public java.lang.Long createStream(java.lang.Long pProjectId,
ProjectStreamPojo pBranch)
createStream in interface IFlexDeployFunctions@Deprecated
public java.lang.Long createStream(java.lang.Long pProjectId,
java.lang.String pbranchName)
createStream in interface IFlexDeployFunctions@Deprecated
public java.lang.Long createStream(java.lang.Long pProjectId,
java.lang.String pbranchName,
java.lang.String pVersionSyntax)
createStream in interface IFlexDeployFunctions@Deprecated
public java.lang.Long findStreamId(java.lang.Long pProjectId,
java.lang.String pbranchName)
findStreamId in interface IFlexDeployFunctions@Deprecated
public void inactivateStream(java.lang.Long pProjectId,
java.lang.String pbranchName)
inactivateStream in interface IFlexDeployFunctions@Deprecated
public void activateStream(java.lang.Long pProjectId,
java.lang.String pbranchName)
activateStream in interface IFlexDeployFunctions@Deprecated
public void patchStream(java.lang.Long pProjectId,
java.lang.Long pBranchId,
ProjectStreamDataObject pStream)
patchStream in interface IFlexDeployFunctions@Deprecated
public void updateStream(java.lang.Long pProjectId,
java.lang.Long pBranchId,
ProjectStreamPojo pStream)
updateStream in interface IFlexDeployFunctionspublic void updateScanResult(java.lang.Long pProjectId,
java.lang.String pScanId,
ScanResultPojo pScanResultPojo,
boolean pIsStatusSuccess)
updateScanResult in interface IFlexDeployFunctionspProjectId - 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.public ScanResultPojo getScanResultForSonarqube(java.lang.String pBaseUrl, java.lang.String pProjectKey) throws FlexCheckedException
getScanResultForSonarqube in interface IFlexDeployFunctionspBaseUrl - pProjectKey - FlexCheckedExceptionpublic IssueTrackingSystem getIssueTrackingSystemByInstanceCode(java.lang.String pInstanceCode)
getIssueTrackingSystemByInstanceCode in interface IFlexDeployFunctionspInstanceCode - Instance code of the implementation you wish to retrieve.FlexDeployRowNotFoundException - If no instance found for pInstanceCode.public IssueTrackingSystem getIssueTrackingSystemByInstanceName(java.lang.String pInstanceName)
getIssueTrackingSystemByInstanceName in interface IFlexDeployFunctionspInstanceName - Instance Name of the implementation you wish to retrieve.FlexDeployRowNotFoundException - If no instance found for pInstanceName.public IssueTrackingSystem getIssueTrackingSystemByInstanceId(java.lang.Long pITSInstanceId)
getIssueTrackingSystemByInstanceId in interface IFlexDeployFunctionspITSInstanceId - Instance id of the implementation you wish to retrieve.FlexDeployRowNotFoundException - If no instance found for pITSInstanceId.public java.lang.Long getMatchingProjectObjectId(java.lang.Long pProjectId,
java.lang.String pFile)
getMatchingProjectObjectId in interface IFlexDeployFunctionspProjectId - pFile - public PaginatedResponse<ProjectPackageDataObject> searchProjectPackages(ProjectPackageDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchProjectPackages in interface IFlexDeployFunctionspCriteriaObject - - ProjectPackageDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public PaginatedResponse<EnvironmentDataObject> searchEnvironments(EnvironmentDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchEnvironments in interface IFlexDeployFunctionspCriteriaObject - - EnvironmentDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public PaginatedResponse<TargetGroupDataObject> searchTargetGroups(TargetGroupDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchTargetGroups in interface IFlexDeployFunctionspCriteriaObject - - TargetGroupDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public EnvironmentDataObject getEnvironmentById(java.lang.Long pEnvironmentId)
getEnvironmentById in interface IFlexDeployFunctionspEnvironmentId - Environment id of the Environment to retrieveFlexDeployRowNotFoundException - If Environment not found for given pEnvironmentIdpublic EnvironmentDataObject getEnvironmentByCode(java.lang.String pEnvironmentCode)
getEnvironmentByCode in interface IFlexDeployFunctionspEnvironmentCode - Environment code of the Environment to retrieveFlexDeployRowNotFoundException - If Environment not found for given pEnvironmentCodepublic EnvironmentDataObject getEnvironmentByName(java.lang.String pEnvironmentName)
getEnvironmentByName in interface IFlexDeployFunctionspEnvironmentName - Environment name of the Environment to retrieveFlexDeployRowNotFoundException - If Environment not found for given
pEnvironmentNamepublic TargetGroupDataObject getTargetGroupById(java.lang.Long pTargetGroupId)
getTargetGroupById in interface IFlexDeployFunctionspTargetGroupId - FlexDeployRowNotFoundException - If TargetGroup not found for given pTargetGroupIdpublic TargetGroupDataObject getTargetGroupByCode(java.lang.String pTargetGroupCode)
getTargetGroupByCode in interface IFlexDeployFunctionspTargetGroupCode - TargetGroup code of the TargetGroup to retrieveFlexDeployRowNotFoundException - If TargetGroup not found for given pTargetGroupCodepublic TargetGroupDataObject getTargetGroupByName(java.lang.String pTargetGroupName)
getTargetGroupByName in interface IFlexDeployFunctionspTargetGroupName - FlexDeployRowNotFoundException - If TargetGroup not found for given pTargetGroupNamepublic java.util.List<EnvironmentPojo> findEnvironment(java.lang.String pEnvironmentCode)
findEnvironment in interface IFlexDeployFunctionspEnvironmentCode - Code of the environment.FlexDeployRowNotFoundException - If no environment is found for the given environment
codepublic EnvironmentPojo getEnvironment(java.lang.Long pEnvironmentId)
getEnvironment in interface IFlexDeployFunctionspEnvironmentId - Id of the environment.FlexDeployRowNotFoundException - If no environment is found for the given id.public java.util.List<ScmCommitDataObject> getWorkflowExecutionCommits(java.lang.Long pWorkflowExecutionId)
getWorkflowExecutionCommits in interface IFlexDeployFunctionspWorkflowExecutionId - Workflow Execution Id to retrieve associated commit detailspublic java.util.List<WorkItemDataObject> getWorkflowExecutionWorkItems(java.lang.Long pWorkflowExecutionId)
getWorkflowExecutionWorkItems in interface IFlexDeployFunctionspWorkflowExecutionId - Workflow Execution Id to retrieve associated workitem detailspublic java.util.List<WorkflowExecutionDataObject> getWorkflowExecutionByWorkflowRequestId(java.lang.Long pWorkflowRequestId)
getWorkflowExecutionByWorkflowRequestId in interface IFlexDeployFunctionspWorkflowRequestId - Workflow Request Id to retrieve associated workflow execution
details.public WorkflowExecutionDataObject getWorkflowExecutionById(java.lang.Long pWorkflowExecutionId)
getWorkflowExecutionById in interface IFlexDeployFunctionspWorkflowExecutionId - Workflow Execution Id to retrieve associated workflow execution
details.FlexDeployRowNotFoundException - If no workflow execution is found for the given id.public java.util.List<CodeValueInputPOJO> getWorkflowExecutionOutputs(java.lang.Long pWorkflowExecutionId)
getWorkflowExecutionOutputs in interface IFlexDeployFunctionspWorkflowExecutionId - Workflow Execution Id to retrieve associated workflow execution
output details.FlexDeployRowNotFoundExceptionpublic java.util.List<CodeValueInputPOJO> getWorkflowExecutionInputs(java.lang.Long pWorkflowExecutionId)
getWorkflowExecutionInputs in interface IFlexDeployFunctionspWorkflowExecutionId - Workflow Execution Id to retrieve associated workflow execution
input details.FlexDeployRowNotFoundExceptionpublic java.util.List<CodeValueInputPOJO> getWorkflowExecutionFlexfields(java.lang.Long pWorkflowExecutionId)
getWorkflowExecutionFlexfields in interface IFlexDeployFunctionspWorkflowExecutionId - Workflow Execution Id to retrieve associated workflow execution
flexfields details.FlexDeployRowNotFoundExceptionpublic WorkflowExecutionVariables getWorkflowExecutionVariables(java.lang.Long pWorkflowExecutionId)
getWorkflowExecutionVariables in interface IFlexDeployFunctionspWorkflowExecutionId - Workflow Execution Id to retrieve associated workflow execution
variables.FlexDeployRowNotFoundExceptionpublic java.util.List<FlexFieldMetadataDataObject> getActiveBuildFlexfieldMetadata()
getActiveBuildFlexfieldMetadata in interface IFlexDeployFunctionspublic java.util.List<FlexFieldMetadataDataObject> getActiveDeployUtilityFlexfieldMetadata()
getActiveDeployUtilityFlexfieldMetadata in interface IFlexDeployFunctionspublic ProjectVersionDataObject getProjectVersionById(java.lang.Long pProjectVersionId, java.lang.Long pProjectId)
getProjectVersionById in interface IFlexDeployFunctionspProjectVersionId - Project version Id to get the project version data object.pProjectId - Project Id to get the project version data object.FlexDeployRowNotFoundException - If no project version is found for the given project
version id and project id.public PaginatedResponse<ProjectVersionDataObject> searchProjectVersions(ProjectVersionDataObject pParameters, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchProjectVersions in interface IFlexDeployFunctionspParameters - Parameters for the search criteria.pLimit - Limit for the number of rows to be returned.pOffset - Offset number from which the limit starts. Pass 0 to start at beginning of
query result.public java.util.List<TasksQueryResultPojo> getPipelineStageGateTasks(java.lang.Long pPipelineStageExecId)
getPipelineStageGateTasks in interface IFlexDeployFunctionspPipelineStageExecId - pipeline stage execution id to get the Tasks details.public java.util.List<TasksQueryResultPojo> getApprovedPipelineStageGateTasks(java.lang.Long pPipelineStageExecId)
getApprovedPipelineStageGateTasks in interface IFlexDeployFunctionspPipelineStageExecId - pipeline stage execution id to get the Tasks details.public java.util.List<TasksQueryResultPojo> getWorkflowRequestTasks(java.lang.Long pWorkflowRequestId)
getWorkflowRequestTasks in interface IFlexDeployFunctionspWorkflowRequestId - Workflow Request id to get the Tasks details.public ProjectTriggerDataObject createProjectTrigger(ProjectTriggerDataObject pPojo)
createProjectTrigger in interface IFlexDeployFunctionspPojo - Object containing Project trigger details to create the project trigger.public ProjectTriggerDataObject getProjectTriggerById(java.lang.Long pProjectTriggerId) throws FlexDeployRowNotFoundException
getProjectTriggerById in interface IFlexDeployFunctionspProjectTriggerId - Project Trigger Id to retrieve the project trigger details.FlexDeployRowNotFoundException - If no project trigger is found for the given project
trigger idpublic PaginatedResponse<ProjectTriggerDataObject> searchProjectTriggers(ProjectTriggerDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchProjectTriggers in interface IFlexDeployFunctionspCriteriaObject - ProjectTriggerDataObject filled with criteria values.pLimit - Limit for the number of rows to be returned.pOffset - Offset number from which the limit starts. Pass 0 to start at beginning
of query result.public ProjectTriggerDataObject updateProjectTrigger(ProjectTriggerDataObject pPojo)
updateProjectTrigger in interface IFlexDeployFunctionspPojo - Object containing project trigger details to update the project trigger.FlexDeployRowNotFoundException - If no project trigger is found for the given project
trigger details.public ProjectTriggerDataObject patchProjectTrigger(ProjectTriggerDataObject pPojo)
patchProjectTrigger in interface IFlexDeployFunctionspPojo - Object containing Project trigger details to update the project trigger.FlexDeployRowNotFoundException - If no project trigger is found for the given project
trigger details.public void deleteProjectTrigger(java.lang.Long pProjectTriggerId)
deleteProjectTrigger in interface IFlexDeployFunctionspProjectTriggerId - Project trigger Id to delete the respective project trigger.public FlxWorkItemDataObject createFlxWorkItem(FlxWorkItemDataObject pPojo)
createFlxWorkItem in interface IFlexDeployFunctionspPojo - Object containing WorkItem details to create the WorkItem.public FlxWorkItemDataObject updateFlxWorkItem(FlxWorkItemDataObject pPojo)
updateFlxWorkItem in interface IFlexDeployFunctionspPojo - Object containing WorkItem details to update the WorkItem.public FlxWorkItemDataObject patchFlxWorkItem(FlxWorkItemDataObject pPojo)
patchFlxWorkItem in interface IFlexDeployFunctionspPojo - Object containing WorkItem details to update the WorkItem.public FlxWorkItemDataObject findFlxWorkItemByNumber(java.lang.String pWorkItemNumber)
findFlxWorkItemByNumber in interface IFlexDeployFunctionspWorkItemNumber - WorkItem number to get the WorkItem details.FlexDeployRowNotFoundException - If no FlexWorkItem is found for the given WorkItem
number.public FlxWorkItemDataObject updateFlxWorkItemStatus(java.lang.String pWorkItemNumber, java.lang.String pStatusName)
updateFlxWorkItemStatus in interface IFlexDeployFunctionspWorkItemNumber - WorkItem number.pStatusName - WorkItem status Name.public FlxWorkItemDataObject updateFlxWorkItemType(java.lang.String pWorkItemNumber, java.lang.String pTypeCode)
updateFlxWorkItemType in interface IFlexDeployFunctionspWorkItemNumber - WorkItem number.pTypeCode - WorkItem type codepublic FlxWorkItemDataObject updateFlxWorkItemAssignee(java.lang.String pWorkItemNumber, java.lang.String pUserName)
updateFlxWorkItemAssignee in interface IFlexDeployFunctionspWorkItemNumber - WorkItem number.pUserName - user name.public java.util.List<FlxWorkItemTypeDataObject> getFlxWorkItemTypes()
getFlxWorkItemTypes in interface IFlexDeployFunctionspublic java.util.List<FlxWorkItemStatusDataObject> getFlxWorkItemStatuses()
getFlxWorkItemStatuses in interface IFlexDeployFunctionspublic FdCommentDataObject addWorkItemComment(java.lang.String pWorkItemNumber, java.lang.String pComment)
addWorkItemComment in interface IFlexDeployFunctionspWorkItemNumber - WorkItem number.pComment - comment.public java.util.List<WorkItemDataObject> getWorkItemsForSuccessfulExecutions(java.lang.Long pSnapshotId, java.lang.Long pEnvironmentId)
getWorkItemsForSuccessfulExecutions in interface IFlexDeployFunctionspSnapshotId - Id of the snapshot.pEnvironmentId - Id of the environment.public java.util.List<WorkItemDataObject> getWorkItemsForAllExecutions(java.lang.Long pSnapshotId, java.lang.Long pEnvironmentId)
getWorkItemsForAllExecutions in interface IFlexDeployFunctionspSnapshotId - Id of the snapshot.pEnvironmentId - Id of the environment.public java.util.List<WorkItemDataObject> getWorkItemsForFailedExecutions(java.lang.Long pSnapshotId, java.lang.Long pEnvironmentId)
getWorkItemsForFailedExecutions in interface IFlexDeployFunctionspSnapshotId - Id of the snapshot.pEnvironmentId - Id of the environment.public java.util.List<WorkItemDataObject> getWorkItemsForSnapshotVersions(java.lang.Long pSnapshotId)
getWorkItemsForSnapshotVersions in interface IFlexDeployFunctionspSnapshotId - Id of the snapshot.public java.util.List<FlxWorkItemFieldDataDataObject> saveFlxWorkItemFieldData(java.lang.String pWorkItemNumber, java.lang.String pFieldName, java.io.Serializable pValue)
saveFlxWorkItemFieldData in interface IFlexDeployFunctionspWorkItemNumber - WorkItem number.pFieldName - field name.pValue - field value.public java.util.List<FlxWorkItemFieldDataDataObject> getFlxWorkItemFieldData(java.lang.String pWorkItemNumber)
getFlxWorkItemFieldData in interface IFlexDeployFunctionspWorkItemNumber - public java.lang.String parseWorkItemRichText(java.lang.String pWorkItemRichText)
parseWorkItemRichText in interface IFlexDeployFunctionspWorkItemRichText - public java.util.List<FDUser> getUsersFromGroupName(java.lang.String pGroupName)
getUsersFromGroupName in interface IFlexDeployFunctionspGroupName - FlexDeploy Group name to use.public java.util.List<WorkflowExecutionReportDataObject> getReportsByWorkflowExecutionId(java.lang.Long pWorkflowExecutionId)
getReportsByWorkflowExecutionId in interface IFlexDeployFunctionspWorkflowExecutionId - Workflow Execution IDpublic java.io.InputStream getReportDataByWorkflowExecutionReportId(java.lang.Long pWorkflowExecutionReportId)
getReportDataByWorkflowExecutionReportId in interface IFlexDeployFunctionspWorkflowExecutionReportId - Workflow Execution Report IDpublic ProjectStreamDataObject getProjectBranchById(java.lang.Long pBranchId, java.lang.Long pProjectId) throws FlexDeployRowNotFoundException
getProjectBranchById in interface IFlexDeployFunctionspBranchId - pProjectId - FlexDeployRowNotFoundException - If no project branch is found for given branchId and
projectIdpublic EndpointDataObject getEndpointById(java.lang.Long pEndpointId)
getEndpointById in interface IFlexDeployFunctionspEndpointId - - Endpoint id of the Endpoint to retrieve.FlexDeployRowNotFoundException - If Endpoint not found for given pEndpointId.public EndpointDataObject getEndpointByName(java.lang.String pEndpointName)
getEndpointByName in interface IFlexDeployFunctionspEndpointName - - Endpoint name of the Endpoint to retrieve.FlexDeployRowNotFoundException - If Endpoint not found for given pEndpointName.public EndpointDataObject createEndpoint(EndpointDataObject pEndpointDataObject)
createEndpoint in interface IFlexDeployFunctionspEndpointDataObject - - Object containing the Endpoint details to create the Endpoint.public EndpointDataObject updateEndpoint(EndpointDataObject pEndpointDataObject)
updateEndpoint in interface IFlexDeployFunctionspEndpointDataObject - - Object containing the Endpoint details to update the Endpoint.FlexDeployRowNotFoundException - If no Endpoint is found for the given Endpoint details.public EndpointDataObject patchEndpoint(EndpointDataObject pEndpointDataObject)
patchEndpoint in interface IFlexDeployFunctionspEndpointDataObject - - Object containing the Endpoint details to update the Endpoint.FlexDeployRowNotFoundException - If no Endpoint is found for the given Endpoint details.public PaginatedResponse<EndpointDataObject> searchEndpoints(EndpointDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchEndpoints in interface IFlexDeployFunctionspCriteriaObject - - EndpointDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public FdGroupDataObject getGroupById(java.lang.Long pGroupId)
getGroupById in interface IFlexDeployFunctionspGroupId - - Group id of the Group to retrieve.FlexDeployRowNotFoundException - If Group not found for given pGroupId.public FdGroupDataObject getGroupByName(java.lang.String pGroupName)
getGroupByName in interface IFlexDeployFunctionspGroupName - - Group name of the Group to retrieve.FlexDeployRowNotFoundException - If Group not found for given pGroupName.public FdGroupDataObject createGroup(FdGroupDataObject pGroupDataObject)
createGroup in interface IFlexDeployFunctionspGroupDataObject - - Object containing the Group details to create the Group.public FdGroupDataObject patchGroup(FdGroupDataObject pGroupDataObject)
patchGroup in interface IFlexDeployFunctionspGroupDataObject - - Object containing the Group details to update the Group.FlexDeployRowNotFoundException - If no Group is found for the given Group details.public FdGroupDataObject updateGroup(FdGroupDataObject pGroupDataObject)
updateGroup in interface IFlexDeployFunctionspGroupDataObject - - Object containing the Group details to update the Group.FlexDeployRowNotFoundException - If no Group is found for the given Group details.public PaginatedResponse<FdGroupDataObject> searchGroups(FdGroupDataObject pGroupObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchGroups in interface IFlexDeployFunctionspGroupObject - - FdGroupDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at beginning
of query result.public RelSnapshotDataObject getSnapshotDetails(java.lang.Long pSnapshotId)
getSnapshotDetails in interface IFlexDeployFunctionspSnapshotId - Id of the snapshot.public boolean isBotUsername(java.lang.String pUsername)
isBotUsername in interface IFlexDeployFunctionspUsername - public FdUserDataObject getUserById(java.lang.Long pUserId)
getUserById in interface IFlexDeployFunctionspUserId - - User id of the User to retrieve.FlexDeployRowNotFoundException - If User not found for given pUserId.public FdUserDataObject createUser(FdUserDataObject pUserDataObj)
createUser in interface IFlexDeployFunctionspUserDataObj - - Object containing the User details to create the User.public FdUserDataObject patchUser(FdUserDataObject pUserDataObject)
patchUser in interface IFlexDeployFunctionspUserDataObject - - Object containing the User details to update the User.FlexDeployRowNotFoundException - If no User is found for the given User details.public FdUserDataObject updateUser(FdUserDataObject pUserDataObject)
updateUser in interface IFlexDeployFunctionspUserDataObject - - Object containing the User details to update the User.FlexDeployRowNotFoundException - If no User is found for the given User details.public PaginatedResponse<FdUserDataObject> searchUsers(FdUserDataObject pUserObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchUsers in interface IFlexDeployFunctionspUserObject - - FdUserDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at beginning of
query result.public void deleteFlxWorkItem(java.lang.Long pFlexWorkItemId)
deleteFlxWorkItem in interface IFlexDeployFunctionspFlexWorkItemId - - the id of the FlexWorkItempublic PaginatedResponse<FlxWorkItemDataObject> searchFlxWorkItems(FlxWorkItemDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchFlxWorkItems in interface IFlexDeployFunctionspCriteriaObject - - The FlxWorkItemDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public FlxWorkItemStatusDataObject getFlxWorkItemStatusWithId(java.lang.Long pFlexWorkItemStatusId)
getFlxWorkItemStatusWithId in interface IFlexDeployFunctionspFlexWorkItemStatusId - - Id of FlexWorkItem Status to find.FlexDeployRowNotFoundException - if no row found for pFlexWorkItemStatusId.public PaginatedResponse<FlxWorkItemStatusDataObject> searchFlxWorkItemStatuses(FlxWorkItemStatusDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchFlxWorkItemStatuses in interface IFlexDeployFunctionspCriteriaObject - - FlxWorkItemStatusDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public FlxWorkItemTypeDataObject getFlxWorkItemTypeWithCode(java.lang.String pFlexWorkItemTypeCode)
getFlxWorkItemTypeWithCode in interface IFlexDeployFunctionspFlexWorkItemTypeCode - - Code of FlexWorkItem Type to find.FlexDeployRowNotFoundException - if no row found for pFlexWorkItemTypeCode.public PaginatedResponse<FlxWorkItemTypeDataObject> searchFlxWorkItemTypes(FlxWorkItemTypeDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchFlxWorkItemTypes in interface IFlexDeployFunctionspCriteriaObject - - FlexWorkItemTypeDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public FlxWorkItemFieldDataObject getFlxWorkItemFieldWithId(java.lang.Long pFlexWorkItemFieldId)
getFlxWorkItemFieldWithId in interface IFlexDeployFunctionspFlexWorkItemFieldId - - Id of FlexWorkItem Field to find.FlexDeployRowNotFoundException - if no row found for pFlexWorkItemFieldId.public PaginatedResponse<FlxWorkItemFieldDataObject> searchFlxWorkItemFields(FlxWorkItemFieldDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchFlxWorkItemFields in interface IFlexDeployFunctionspCriteriaObject - - FlexWorkItemFieldDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public java.util.List<FlxWorkItemFieldDataObject> saveFlxWorkItemFields(java.util.List<FlxWorkItemFieldDataObject> pPojos, java.lang.String pGroupCode)
saveFlxWorkItemFields in interface IFlexDeployFunctionspPojos - - The FlexWorkItem Fields to be savedpGroupCode - - The code of the group that is being saved topublic FlxWorkItemFieldDataObject patchFlxWorkItemField(FlxWorkItemFieldDataObject pPojo)
patchFlxWorkItemField in interface IFlexDeployFunctionspPojo - Object containing FlexWorkItem Field details to update the FlexWorkItem Field.public PropertyKeyGroupDataObject getFlxWorkItemFieldGroupWithCode(java.lang.String pFlexWorkItemFieldGroupCode)
getFlxWorkItemFieldGroupWithCode in interface IFlexDeployFunctionspFlexWorkItemFieldGroupCode - - Code of FlexWorkItem Field Group to find.FlexDeployRowNotFoundException - if no row found for pFlexWorkItemFieldGroupCode.public PaginatedResponse<PropertyKeyGroupDataObject> searchFlxWorkItemFieldGroups(PropertyKeyGroupDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchFlxWorkItemFieldGroups in interface IFlexDeployFunctionspCriteriaObject - - PropertyKeyGroupDataObject that is filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public PropertyKeyGroupDataObject createFlxWorkItemFieldGroup(PropertyKeyGroupDataObject pDobj)
createFlxWorkItemFieldGroup in interface IFlexDeployFunctionspDobj - - the PropertyKeyDefinitionDataObject with the data to be added to the field grouppublic PropertyKeyGroupDataObject updateFlxWorkItemFieldGroup(PropertyKeyGroupDataObject pDobj)
updateFlxWorkItemFieldGroup in interface IFlexDeployFunctionspDobj - Object containing FlexWorkItem Field Group details to update the FlexWorkItem
Field Group.public PropertyKeyGroupDataObject patchFlxWorkItemFieldGroup(PropertyKeyGroupDataObject pDobj)
patchFlxWorkItemFieldGroup in interface IFlexDeployFunctionspDobj - - the data to use to patch the FlexWorkItem Field Group withpublic void deleteFlxWorkItemFieldGroup(java.lang.String pFlexWorkItemFieldGroupCode)
deleteFlxWorkItemFieldGroup in interface IFlexDeployFunctionspFlexWorkItemFieldGroupCode - - the code of the FlexWorkItem Field Grouppublic FlxWorkItemFieldDataObject createFlxWorkItemField(FlxWorkItemFieldDataObject pDobj)
createFlxWorkItemField in interface IFlexDeployFunctionspDobj - - an object containing the FlexWorkItem Field informationpublic FlxWorkItemFieldDataObject updateFlxWorkItemField(FlxWorkItemFieldDataObject pDobj)
updateFlxWorkItemField in interface IFlexDeployFunctionspDobj - Object containing FlexWorkItem Field details to update the FlexWorkItem Field.public void deleteFlxWorkItemField(java.lang.Long pFlexWorkItemFieldId)
deleteFlxWorkItemField in interface IFlexDeployFunctionspFlexWorkItemFieldId - - The id of the FlexWorkItem Field to deletepublic PropertyKeyDefinitionDataObject createPropertyKeyDefinition(PropertyKeyDefinitionDataObject pPojo)
createPropertyKeyDefinition in interface IFlexDeployFunctionspPojo - - Object containing property key definition information.public PropertyKeyDefinitionDataObject updatePropertyKeyDefinition(PropertyKeyDefinitionDataObject pPojo)
updatePropertyKeyDefinition in interface IFlexDeployFunctionspPojo - - Object containing property key definition information.FlexDeployRowNotFoundException - If no property key is found for the given details.public PropertyKeyDefinitionDataObject patchPropertyKeyDefinition(PropertyKeyDefinitionDataObject pPojo)
patchPropertyKeyDefinition in interface IFlexDeployFunctionspPojo - containing property key definition information.FlexDeployRowNotFoundException - If no property key is found for the given details.public PropertyKeyDefinitionDataObject getPropertyKeyDefinition(java.lang.Long pPropertyKeyDefinitionId)
getPropertyKeyDefinition in interface IFlexDeployFunctionspPropertyKeyDefinitionId - - ID of the property key definition to retrieve.FlexDeployRowNotFoundException - If propkey not found for given pPropertyKeyDefinitionIdpublic PaginatedResponse<PropertyKeyDefinitionDataObject> searchPropertyKeyDefinitions(PropertyKeyDefinitionDataObject pSearchParams, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchPropertyKeyDefinitions in interface IFlexDeployFunctionspSearchParams - - Object containing the search parameters for property key definitions.pLimit - Limit for the number of rows to be returned.pOffset - offset number from which the limit starts. Pass 0 to start at beginning of
query result.public PropertyKeyDefinitionDataObject getPropertyKeyDefinition(java.lang.String pKeyName)
getPropertyKeyDefinition in interface IFlexDeployFunctionspKeyName - - Name of the property key definition to retrieve.FlexDeployRowNotFoundException - If propkey not found for the given pKeyName.public PropertySetDataObject updateWorkflowPropertySet(PropertySetDataObject pPropertySet)
updateWorkflowPropertySet in interface IFlexDeployFunctionspPropertySet - - Object containing property set information.FlexDeployRowNotFoundException - If no property set is found for the given details.public PaginatedResponse<PropertySetDataObject> searchPropertySets(PropertySetDataObject pSearchParams, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchPropertySets in interface IFlexDeployFunctionspSearchParams - - Object containing the search parameters for property sets.pLimit - Limit for the number of rows to be returned.pOffset - offset number from which the limit starts. Pass 0 to start at beginning of
query result.public PropertySetDataObject getPropertySet(java.lang.Long pPropertySetId)
getPropertySet in interface IFlexDeployFunctionspPropertySetId - - ID of the property set to retrieve.FlexDeployRowNotFoundException - If propSet not found for given pPropertySetIdpublic CredentialDataObject getCredentialById(java.lang.Long pCredentialId)
getCredentialById in interface IFlexDeployFunctionspCredentialId - - Credential id of the Credential to retrieve.FlexDeployRowNotFoundException - If Credential not found for given pCredentialId.public CredentialDataObject createCredential(CredentialDataObject pCredentialDataObject)
createCredential in interface IFlexDeployFunctionspCredentialDataObject - - Object containing the Credential details to create the
Credential.public CredentialDataObject patchCredential(CredentialDataObject pCredentialDataObject)
patchCredential in interface IFlexDeployFunctionspCredentialDataObject - - Object containing the Credential details to update the
Credential.FlexDeployRowNotFoundException - If no Credential is found for the given Credential
details.public CredentialDataObject updateCredential(CredentialDataObject pCredentialDataObject)
updateCredential in interface IFlexDeployFunctionspCredentialDataObject - - Object containing the Credential details to update the
Credential.FlexDeployRowNotFoundException - If no Credential is found for the given Credential
details.public PaginatedResponse<CredentialDataObject> searchCredentials(CredentialDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchCredentials in interface IFlexDeployFunctionspCriteriaObject - - CredentialDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public CredentialDataObject getCredentialByName(java.lang.String pCredentialName)
getCredentialByName in interface IFlexDeployFunctionspCredentialName - - Credential id of the Credential to retrieve.FlexDeployRowNotFoundException - If Credential not found for given pCredentialName.public java.lang.String getCredentialSecretTextById(java.lang.Long pCredentialId)
throws FlexCheckedException
getCredentialSecretTextById in interface IFlexDeployFunctionspCredentialId - - Credential id of the value to retrieve.FlexCheckedExceptionpublic java.lang.String getCredentialSecretTextByName(java.lang.String pCredentialName)
throws FlexCheckedException
getCredentialSecretTextByName in interface IFlexDeployFunctionspCredentialName - - Credential Name of the value to retrieve.FlexCheckedExceptionpublic CredentialValuePojo getCredentialValueById(java.lang.Long pCredentialId) throws FlexCheckedException
getCredentialValueById in interface IFlexDeployFunctionspCredentialId - - Credential id of the value to retrieveFlexCheckedExceptionpublic CredentialValuePojo getCredentialValueByName(java.lang.String pCredentialName) throws FlexCheckedException
getCredentialValueByName in interface IFlexDeployFunctionspCredentialName - - Credential name of the value to retrieveFlexCheckedExceptionpublic EnvironmentDataObject createEnvironment(EnvironmentDataObject pEnvDataObject)
createEnvironment in interface IFlexDeployFunctionspEnvDataObject - - Object containing the Environment details to create the Environment.public EnvironmentDataObject patchEnvironment(EnvironmentDataObject pEnvDataObject)
patchEnvironment in interface IFlexDeployFunctionspEnvDataObject - - Object containing the Environment details to update the Environment.FlexDeployRowNotFoundException - If no Environment is found for the given Environment
details.public EnvironmentDataObject updateEnvironment(EnvironmentDataObject pEnvDataObject)
updateEnvironment in interface IFlexDeployFunctionspEnvDataObject - - Object containing the Environment details to update the Environment.FlexDeployRowNotFoundException - If no Environment is found for the given Environment
details.public void deleteEnvironment(java.lang.Long pEnvironmentId)
deleteEnvironment in interface IFlexDeployFunctionspEnvironmentId - - the id of the Environment.public void deleteEndpoint(java.lang.Long pEndpointId)
deleteEndpoint in interface IFlexDeployFunctionspEndpointId - - the id of the Endpoint.public void deleteCredential(java.lang.Long pCredentialId)
deleteCredential in interface IFlexDeployFunctionspCredentialId - - the id of the Credential.
No error is thrown if the credential is not found.public TargetGroupDataObject createTargetGroup(TargetGroupDataObject pTargetGroupDataObj)
createTargetGroup in interface IFlexDeployFunctionspTargetGroupDataObj - - Object containing the TargetGroup details to create the
TargetGroup.public TargetGroupDataObject patchTargetGroup(TargetGroupDataObject pTargetGroupDataObj) throws FlexDeployRowNotFoundException
patchTargetGroup in interface IFlexDeployFunctionspTargetGroupDataObj - - Object containing the TargetGroup details to update the
TargetGroup.FlexDeployRowNotFoundException - If no TargetGroup is found for the given TargetGroup
details.public TargetGroupDataObject updateTargetGroup(TargetGroupDataObject pTargetGroupDataObj) throws FlexDeployRowNotFoundException
updateTargetGroup in interface IFlexDeployFunctionspTargetGroupDataObj - - Object containing the TargetGroup details to update the
TargetGroup.FlexDeployRowNotFoundException - If no TargetGroup is found for the given TargetGroup
details.public void deleteTargetGroup(java.lang.Long pTargetGroupId)
deleteTargetGroup in interface IFlexDeployFunctionspTargetGroupId - - the id of the TargetGroup.
No error is thrown if the target group does not exist.public void assignGroupToUser(java.lang.Long pGroupId,
java.lang.Long pUserId)
throws FlexDeployRowNotFoundException
assignGroupToUser in interface IFlexDeployFunctionspGroupId - - Id of the Group that has to be assigned to the user.pUserId - - Id of the User to which Group has be assigned.FlexDeployRowNotFoundException - If no Group or User is found for the given ids.public void unassignGroupFromUser(java.lang.Long pGroupId,
java.lang.Long pUserId)
throws FlexDeployRowNotFoundException
unassignGroupFromUser in interface IFlexDeployFunctionspGroupId - - Id of the Group that has to be unassigned from the user.pUserId - - Id of the User from which Group has be unassigned.FlexDeployRowNotFoundException - If no Group or User is found for the given details.public void assignGroupToUser(java.lang.String pGroupName,
java.lang.String pUserName)
throws FlexDeployValidationException
assignGroupToUser in interface IFlexDeployFunctionspGroupName - - Name of the Group that has to be assigned to the user.pUserName - - Name of the User to which Group has be assigned.FlexDeployValidationException - If no Group or User is found for the given details.public void unassignGroupFromUser(java.lang.String pGroupName,
java.lang.String pUserName)
throws FlexDeployValidationException
unassignGroupFromUser in interface IFlexDeployFunctionspGroupName - - Name of the Group that has to be unassigned from the user.pUserName - - Name of the User from which Group has be unassigned.FlexDeployValidationException - If no Group or User is found for the given details.public FolderDataObject createFolder(FolderDataObject pFolderDataObject)
createFolder in interface IFlexDeployFunctionspFolderDataObject - - Object containing the Folder details to create the Folder.public FolderDataObject patchFolder(FolderDataObject pFolderDataObject) throws FlexDeployRowNotFoundException
patchFolder in interface IFlexDeployFunctionspFolderDataObject - - Object containing the Folder details to update the Folder.FlexDeployRowNotFoundException - If no Folder is found for the given Folder details.public FolderDataObject updateFolder(FolderDataObject pFolderDataObject) throws FlexDeployRowNotFoundException
updateFolder in interface IFlexDeployFunctionspFolderDataObject - - Object containing the Folder details to update the Folder.FlexDeployRowNotFoundException - If no Folder is found for the given Folder details.public void deleteFolder(java.lang.Long pFolderId)
deleteFolder in interface IFlexDeployFunctionspFolderId - - the id of the Folder.public java.util.List<ReleasePojo> findReleases(java.lang.String pName) throws FlexDeployRowNotFoundException
getRelease this method returns a list of Releases.findReleases in interface IFlexDeployFunctionspName - Name to search byFlexDeployRowNotFoundException - if no releases match the naming criteria pNamepublic java.util.List<ReleasePojo> findReleases(java.lang.String pName, java.lang.Integer pLimit, java.lang.Integer pOffset) throws FlexDeployRowNotFoundException
getRelease this method returns a list of Releases.findReleases in interface IFlexDeployFunctionspName - Name to search bypLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.FlexDeployRowNotFoundException - if no releases match the naming criteria pNamepublic ReleasePojo getRelease(java.lang.Long pId) throws FlexDeployRowNotFoundException
getRelease in interface IFlexDeployFunctionspId - Release IdFlexDeployRowNotFoundException - if no Release is found for the given pIdpublic FdCommentDataObject patchWorkItemComment(java.lang.String pCommentId, java.lang.String pComment)
patchWorkItemComment in interface IFlexDeployFunctionspCommentId - - WorkItem comment id.pComment - - WorkItem comment.public java.lang.Long createRelease(java.lang.Long pFolderId,
java.lang.String pReleaseName,
java.lang.String pPipelineName,
java.lang.String pDescription,
java.lang.String pCronSchedule)
createRelease in interface IFlexDeployFunctionspFolderId - Folder location for the Release.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.FlexDeployValidationException - when creation of release gets failed.public RelDefinitionDataObject updateRelease(RelDefinitionDataObject pReleasePojo) throws FlexDeployRowNotFoundException
updateRelease in interface IFlexDeployFunctionspReleasePojo - - Object containing release information.FlexDeployRowNotFoundException - if no release is found for the given release details.public RelDefinitionDataObject patchRelease(RelDefinitionDataObject pReleasePojo) throws FlexDeployRowNotFoundException
patchRelease in interface IFlexDeployFunctionspReleasePojo - - Object containing release information.FlexDeployRowNotFoundException - if no release is found for the given release details.public java.lang.Long createRelease(java.lang.String pReleaseName,
java.lang.String pPipelineName,
java.lang.String pDescription,
java.lang.String pCronSchedule)
createRelease in interface IFlexDeployFunctionspReleaseName - 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.FlexDeployValidationException - when creation of release gets failed.public java.lang.Long createRelease(java.lang.String pReleaseName,
java.lang.String pPipelineName,
java.lang.String pDescription)
createRelease in interface IFlexDeployFunctionspReleaseName - Name to give Release.pPipelineName - Pipeline name to use for the Release.pDescription - Optional description to give the Release.FlexDeployValidationException - when creation of release gets failed.public void endRelease(java.lang.String pReleaseName)
endRelease in interface IFlexDeployFunctionspReleaseName - Release name to end.public void endRelease(java.lang.Long pReleaseId)
endRelease in interface IFlexDeployFunctionspReleaseId - Release id to end.public void forceEndRelease(java.lang.Long pReleaseId)
forceEndRelease in interface IFlexDeployFunctionspReleaseId - Release id to end.public void forceEndRelease(java.lang.String pReleaseName)
throws FlexDeployRowNotFoundException
forceEndRelease in interface IFlexDeployFunctionspReleaseName - Release name to end.FlexDeployRowNotFoundException - if Release is not foundpublic void pauseRelease(java.lang.String pReleaseName)
throws FlexDeployRowNotFoundException
pauseRelease in interface IFlexDeployFunctionspReleaseName - Release name to pause.FlexDeployRowNotFoundException - if Release is not foundpublic void pauseRelease(java.lang.Long pReleaseId)
throws FlexDeployRowNotFoundException
pauseRelease in interface IFlexDeployFunctionspReleaseId - Release id to pause.FlexDeployRowNotFoundException - if Release is not foundpublic void startRelease(java.lang.String pReleaseName)
throws FlexDeployRowNotFoundException
startRelease in interface IFlexDeployFunctionspReleaseName - Release name to start.FlexDeployRowNotFoundException - if Release is not foundpublic void startRelease(java.lang.Long pReleaseId)
throws FlexDeployRowNotFoundException
startRelease in interface IFlexDeployFunctionspReleaseId - Release id to start.FlexDeployRowNotFoundException - if Release is not foundpublic void addProjectsToRelease(java.lang.String pReleaseName,
java.util.List<ReleaseProjectsPojo> pReleaseProjects)
throws FlexDeployRowNotFoundException
addProjectsToRelease in interface IFlexDeployFunctionspReleaseName - Release name to add projects to.pReleaseProjects - List of ReleaseProjects to add.FlexDeployRowNotFoundException - if Release is not foundpublic void removeProjectsFromRelease(java.lang.String pReleaseName,
java.util.List<ReleaseProjectsPojo> pReleaseProjects)
throws FlexDeployRowNotFoundException
removeProjectsFromRelease in interface IFlexDeployFunctionspReleaseName - Release name to remove projects from.pReleaseProjects - List of ReleaseProjects to remove.FlexDeployRowNotFoundException - if Release is not foundpublic void updateReleaseProperty(java.lang.Long pReleaseDefId,
java.lang.String pPropertyKeyCode,
java.io.Serializable pNewValue)
throws FlexDeployRowNotFoundException
updateReleaseProperty in interface IFlexDeployFunctionspReleaseDefId - - 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.FlexDeployRowNotFoundExceptionpublic java.util.List<ReleaseProjectDetailsPojo> getReleaseProjectInfo(java.lang.Long pReleaseDefId) throws FlexDeployRowNotFoundException
getReleaseProjectInfo in interface IFlexDeployFunctionspReleaseDefId - Release Definition Id.FlexDeployRowNotFoundExceptionpublic void approveTask(java.lang.String pUsername,
java.lang.String pTaskIdentifier,
java.lang.String pNotes)
approveTask in interface IFlexDeployFunctionspUsername - 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.FlexDeploySecurityViolationException - User doesn't have permission to approve it.FlexDeployValidationException - Task not found. It may have already been approved
or rejected.public void rejectTask(java.lang.String pUsername,
java.lang.String pTaskIdentifier,
java.lang.String pNotes)
rejectTask in interface IFlexDeployFunctionspUsername - 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.FlexDeploySecurityViolationException - User doesn't have permission to reject it.FlexDeployValidationException - Task not found. It may have already been approved
or rejected.public void completeManualStepByTaskId(java.lang.String pUsername,
java.lang.Long pTaskId)
completeManualStepByTaskId in interface IFlexDeployFunctionspUsername - - Username to complete the task as.pTaskId - - Task ID of the human task/manual step to approve.FlexDeploySecurityViolationException - User doesn't have permission to approve it.FlexDeployValidationException - Task not found. It may have already been approved
or rejected.public void rejectManualStepByTaskId(java.lang.String pUsername,
java.lang.Long pTaskId)
rejectManualStepByTaskId in interface IFlexDeployFunctionspUsername - - Username to complete the task as.pTaskId - - Task ID of the human task/manual step to reject.FlexDeploySecurityViolationException - User doesn't have permission to reject it.FlexDeployValidationException - Task not found. It may have already been approved
or rejected.public void completeManualStepBySnapshotId(java.lang.String pUsername,
java.lang.Long pSnapshotId)
completeManualStepBySnapshotId in interface IFlexDeployFunctionspUsername - - Username to approve the task as.pSnapshotId - - Snapshot Id which has a manual step waiting to be approved.FlexDeploySecurityViolationException - User doesn't have permission to approve it.FlexDeployValidationException - Task not found. It may have already been approved
or rejected.public void rejectManualStepBySnapshotId(java.lang.String pUsername,
java.lang.Long pSnapshotId)
rejectManualStepBySnapshotId in interface IFlexDeployFunctionspUsername - - Username to reject the task as.pSnapshotId - - Snapshot Id which has a manual step waiting to be rejected.FlexDeploySecurityViolationException - User doesn't have permission to reject it.FlexDeployValidationException - Task not found. It may have already been approved
or rejected.public java.util.List<FDUser> getUsersFromRoleId(java.lang.Long pRoleId)
getUsersFromRoleId in interface IFlexDeployFunctionspRoleId - Pipeline role id.public java.util.List<FDUser> getUsersFromRoleId(java.lang.Long pRoleId, java.lang.Long pRelDefId)
getUsersFromRoleId in interface IFlexDeployFunctionspRoleId - Pipeline role id.pRelDefId - Release definition id.public java.util.List<FdGroupDataObject> getGroupsFromRoleId(java.lang.Long pRoleId)
getGroupsFromRoleId in interface IFlexDeployFunctionspRoleId - Pipeline role id.public java.util.List<FdGroupDataObject> getGroupsFromRoleId(java.lang.Long pRoleId, java.lang.Long pRelDefId)
getGroupsFromRoleId in interface IFlexDeployFunctionspRoleId - Pipeline role id.pRelDefId - Release definition id..public java.lang.Long updateSnapshotVariable(java.lang.Long pSnapshotId,
java.lang.String pVariableCode,
java.io.Serializable pNewValue)
updateSnapshotVariable in interface IFlexDeployFunctionspSnapshotId - - 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 that the variable will be updated to.FlexDeployValidationExceptionpublic java.lang.String getWorkItemStatus(WorkItemDataObject pWorkItem)
getWorkItemStatus in interface IFlexDeployFunctionspWorkItem - Object.public java.lang.Long createSnapshot(java.lang.Long pReleaseId)
createSnapshot in interface IFlexDeployFunctionspReleaseId - Release to create the snapshot for.FlexDeployValidationException - when failing to submit snapshot.FlexCheckedExceptionpublic void downloadSnapshotCommitDetails(java.lang.Long pSnapshotId,
java.lang.String pDestinationPath)
downloadSnapshotCommitDetails in interface IFlexDeployFunctionspSnapshotId - - Id of the snapshot whose commit details will be returned.pDestinationPath - - Path where the csv will be downloaded.FlexDeployValidationException - if pDestinationPath is not provided.public java.io.InputStream getSnapshotCommitDetailInputStreams(java.lang.Long pSnapshotId)
getSnapshotCommitDetailInputStreams in interface IFlexDeployFunctionspSnapshotId - - Id of the snapshot which details will be returnedpublic java.util.List<ReleaseSnapshotCommitDetailsPojo> getSnapshotCommitDetails(java.lang.Long pSnapshotId)
getSnapshotCommitDetails in interface IFlexDeployFunctionspSnapshotId - - Id of the snapshot whose commit details will be returned.public StageExecutionInformation getPipelineStageExecutionInfo(java.lang.Long pStageExecId)
getPipelineStageExecutionInfo in interface IFlexDeployFunctionspStageExecId - Pipeline Stage Execution Id.public StepProjectsRequestPojo getPipelineStepProjectsExecution(java.lang.Long pStageExecId, java.lang.Long pStepId)
getPipelineStepProjectsExecution in interface IFlexDeployFunctionspStageExecId - The pipeline stage execution idpStepId - The pipeline stage step id to get results for.public StepProjectsRequestPojo getPipelineStepProjectsExecution(java.lang.Long pStageExecId, java.lang.String pStepName)
getPipelineStepProjectsExecution in interface IFlexDeployFunctionspStageExecId - The pipeline stage execution idpStepName - The pipeline stage step name to get results for.public java.util.List<WorkflowExecutionDataObject> getBuildWorkflowExecutionsFromProjectVersionIds(java.util.List<java.lang.Long> pProjectVersionIds)
getBuildWorkflowExecutionsFromProjectVersionIds in interface IFlexDeployFunctionspProjectVersionIds - Project version ID(s)public TagAssignmentDataObject assignTag(FlexDeploySecurityConstants.SecurityObjectType pObjectType, java.lang.Long pObjectId, java.lang.String pTagName)
assignTag in interface IFlexDeployFunctionspObjectType - - Type of the object to which the tag has to be assigned.pObjectId - - Id of the object to which the tag has to be assigned.pTagName - - Name of the tag that has to be assigned.public void unassignTag(FlexDeploySecurityConstants.SecurityObjectType pObjectType,
java.lang.Long pObjectId,
java.lang.String pTagName)
unassignTag in interface IFlexDeployFunctionspObjectType - - Type of the object from which the tag has to be unassigned.pObjectId - - Id of the object from which the tag has to be unassigned.pTagName - - Name of the tag that has to be unassigned.public java.lang.Long createSnapshot(java.lang.Long pReleaseId,
java.util.List<SnapshotVersionInputPojo> pVersions,
java.util.List<CodeValueInputPOJO> pInputs)
createSnapshot in interface IFlexDeployFunctionspReleaseId - Release to create the snapshot for.pVersions - Project version details to set while creating the snapshot.pInputs - Inputs to provide while creating the snapshot.public java.util.List<java.lang.String> getEmailAddressesFromRoleId(java.lang.Long pRoleId)
getEmailAddressesFromRoleId in interface IFlexDeployFunctionspRoleId - Pipeline role id.public java.util.List<java.lang.String> getEmailAddressesFromRoleId(java.lang.Long pRoleId,
java.lang.Long pRelDefId)
getEmailAddressesFromRoleId in interface IFlexDeployFunctionspRoleId - Pipeline role id.pRelDefId - Release definition id.public java.util.List<FDUser> getAllUsersFromRoleId(java.lang.Long pRoleId)
getAllUsersFromRoleId in interface IFlexDeployFunctionspRoleId - Pipeline role id.public java.util.List<FDUser> getAllUsersFromRoleId(java.lang.Long pRoleId, java.lang.Long pRelDefId)
getAllUsersFromRoleId in interface IFlexDeployFunctionspRoleId - Pipeline role id.pRelDefId - Release definition id.public TasksQueryExtResultRow getTaskById(java.lang.Long pTaskId)
getTaskById in interface IFlexDeployFunctionspTaskId - id of the task.FlexDeployRowNotFoundException - if no task found for a given pTaskId.public java.util.List<TasksQueryResultPojo> getPendingTasksByChangeTicket(java.lang.String pChangeTicket)
getPendingTasksByChangeTicket in interface IFlexDeployFunctionspChangeTicket - change ticket number.public PaginatedResponse<TasksQueryResultPojo> searchTasks(TasksQueryResultPojo pPojo, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchTasks in interface IFlexDeployFunctionspPojo - - TasksQueryResultPojo filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at beginning of
query result.public void approveTaskById(java.lang.Long pTaskId,
java.lang.String pNotes)
approveTaskById in interface IFlexDeployFunctionspTaskId - Task id to be passed.pNotes - Optional notes to assign to the approval.FlexDeploySecurityViolationException - User doesn't have permission to approve it.FlexDeployValidationException - Task not found. It may have already been approved
or rejected.public void rejectTaskById(java.lang.Long pTaskId,
java.lang.String pNotes)
rejectTaskById in interface IFlexDeployFunctionspTaskId - Task id to be passed.pNotes - Optional notes to assign to the approval.FlexDeploySecurityViolationException - User doesn't have permission to approve it.FlexDeployValidationException - Task not found. It may have already been approved
or rejected.public FdCommentDataObject createComment(FdCommentDataObject pCommentDataObj)
createComment in interface IFlexDeployFunctionspCommentDataObj - - Object containing the Comment details to create the Comment.public FdCommentDataObject patchComment(FdCommentDataObject pCommentDataObj)
patchComment in interface IFlexDeployFunctionspCommentDataObj - - Object containing the Comment details to update the Comment.FlexDeployRowNotFoundException - If no Comment is found for the given Comment details.public void deleteComment(java.lang.Long pCommentId)
deleteComment in interface IFlexDeployFunctionspCommentId - - the id of the Comment.
No error is thrown if the Comment is not found.public RelDefinitionDataObject getReleaseById(java.lang.Long pRelDefinitionId)
getReleaseById in interface IFlexDeployFunctionspRelDefinitionId - - Release definition id of the Release to retrieveFlexDeployRowNotFoundException - If Release not found for given pRelDefinitionIdpublic RelDefinitionDataObject getReleaseByName(java.lang.String pRelDefinitionName)
getReleaseByName in interface IFlexDeployFunctionspRelDefinitionName - - Release name of the Release to retrieveFlexDeployRowNotFoundException - If Release not found for given pRelDefinitionNamepublic java.util.List<RelProjectDataObject> createReleaseProjects(java.lang.Long pReleaseId, java.util.List<RelProjectDataObject> pPojos)
createReleaseProjects in interface IFlexDeployFunctionspReleaseId - - release id to create release projects under.pPojos - - A list containing the Release Projects detail to create the Release
Pojects.public RelProjectDataObject patchReleaseProject(RelProjectDataObject pRelProjectDataObj)
patchReleaseProject in interface IFlexDeployFunctionspRelProjectDataObj - - Object containing release project information.FlexDeployRowNotFoundException - if no release is found for the given release project
details.public RelProjectDataObject updateReleaseProject(RelProjectDataObject pRelProjectDataObj)
updateReleaseProject in interface IFlexDeployFunctionspRelProjectDataObj - - Object containing release project information.FlexDeployRowNotFoundException - if no release is found for the given release project
details.public void deleteReleaseProjects(java.util.List<java.lang.Long> pRelProjectIds)
deleteReleaseProjects in interface IFlexDeployFunctionspRelProjectIds - - A list of ids of the Release projects to be deleted.
No error is thrown if the release project id is not found.public PaginatedResponse<RelDefinitionDataObject> searchReleases(RelDefinitionDataObject pPojo, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchReleases in interface IFlexDeployFunctionspPojo - - RelDefinitionDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at beginning of
query result.public PaginatedResponse<RelProjectDataObject> searchReleaseProjects(RelProjectDataObject pPojo, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchReleaseProjects in interface IFlexDeployFunctionspPojo - - RelProjectDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at beginning of
query result.public void deleteReleaseProject(java.lang.Long pRelProjectId)
deleteReleaseProject in interface IFlexDeployFunctionspRelProjectId - - The id of the Release project to be deleted.
No error is thrown if the release project id is not found.public RelProjectDataObject createReleaseProject(RelProjectDataObject pPojo)
createReleaseProject in interface IFlexDeployFunctionspPojo - - Object containing the Release Project details to create the Release Poject.public RelDefinitionDataObject copyRelease(CopyReleaseInput pCopyReleaseInput)
copyRelease in interface IFlexDeployFunctionspCopyReleaseInput - - Object containing the source Release details to create the Release.public FlxWorkItemDataObject createWorkItem(FlxWorkItemDataObject pPojo)
createWorkItem in interface IFlexDeployFunctionspublic WorkItemDataObject updateWorkItem(WorkItemDataObject pPojo)
updateWorkItem in interface IFlexDeployFunctionspPojo - Object containing WorkItem details to update the WorkItem.public WorkItemDataObject patchWorkItem(WorkItemDataObject pPojo)
patchWorkItem in interface IFlexDeployFunctionspPojo - Object containing WorkItem details to update the WorkItem.public WorkItemDataObject getWorkItemById(java.lang.Long pWorkItemId)
getWorkItemById in interface IFlexDeployFunctionspWorkItemId - WorkItem id to get the WorkItem details.FlexDeployRowNotFoundException - If no WorkItem is found for the given WorkItem id.public FlxWorkItemDataObject updateWorkItemStatus(java.lang.String pWorkItemNumber, java.lang.String pStatusName)
updateWorkItemStatus in interface IFlexDeployFunctionspublic FlxWorkItemDataObject updateWorkItemType(java.lang.String pWorkItemNumber, java.lang.String pTypeCode)
updateWorkItemType in interface IFlexDeployFunctionspublic FlxWorkItemDataObject updateWorkItemAssignee(java.lang.String pWorkItemNumber, java.lang.String pUserName)
updateWorkItemAssignee in interface IFlexDeployFunctionspublic java.util.List<FlxWorkItemTypeDataObject> getWorkItemTypes()
getWorkItemTypes in interface IFlexDeployFunctionspublic java.util.List<FlxWorkItemStatusDataObject> getWorkItemStatuses()
getWorkItemStatuses in interface IFlexDeployFunctionspublic java.util.List<FlxWorkItemFieldDataDataObject> saveWorkItemFieldData(java.lang.String pWorkItemNumber, java.lang.String pFieldName, java.io.Serializable pValue)
saveWorkItemFieldData in interface IFlexDeployFunctionspublic java.util.List<FlxWorkItemFieldDataDataObject> getWorkItemFieldData(java.lang.String pWorkItemNumber)
getWorkItemFieldData in interface IFlexDeployFunctionspublic java.util.List<WorkItemDataObject> getReleaseWorkItems(java.lang.Long pReleaseId)
getReleaseWorkItems in interface IFlexDeployFunctionspReleaseId - - Release Id.public void addWorkItemsToRelease(java.lang.Long pReleaseId,
java.lang.Long pInstanceId,
java.util.List<java.lang.String> pWorkItemNumbers)
addWorkItemsToRelease in interface IFlexDeployFunctionspReleaseId - - Release Definition Id to link workitems to.pInstanceId - - Issue tracking instance for workitems. If not provided, Issue
tracking instances configured on the release's folder will be used.pWorkItemNumbers - - A list of WorkItems Numbers to be added to the Release.public void removeWorkItemsFromRelease(java.lang.Long pReleaseId,
java.lang.Long pInstanceId,
java.util.List<java.lang.String> pWorkItemNumbers,
boolean pRemoveAssociatedProjects)
removeWorkItemsFromRelease in interface IFlexDeployFunctionspReleaseId - - Release Id to remove workitems from.pInstanceId - - Issue tracking instance for workitems. If not provided, all
the workitems that match the input WorkItem Numbers will be
removed.pWorkItemNumbers - - WorkItems Numbers to be removed from the Release.pRemoveAssociatedProjects - - Pass true to remove projects associated with the input
WorkItems.public java.io.File exportConfigurations()
exportConfigurations in interface IFlexDeployFunctionspublic java.io.File exportBuild(java.lang.Long pWorkflowExecutionId)
exportBuild in interface IFlexDeployFunctionspWorkflowExecutionId - WorkflowExecutionId for which build archive is to be exported.public java.io.File exportSnapshot(java.lang.Long pSnapshotId)
exportSnapshot in interface IFlexDeployFunctionspSnapshotId - - SnapshotId for which archive is to be exported.public java.util.List<PropertyValuePojo> getProjectProperties(java.lang.Long pProjectId)
getProjectProperties in interface IFlexDeployFunctionspProjectId - - Id of the Project.FlexDeployValidationException - if no project is found for given project id.public java.io.Serializable getProjectPropertyValue(java.lang.Long pProjectId,
java.lang.String pPropertyKeyCode)
getProjectPropertyValue in interface IFlexDeployFunctionspProjectId - - Id of the project.pPropertyKeyCode - - The code of the property.FlexDeployValidationException - if an invalid Project id and/or Property Key Code passed.public void updateProjectProperty(java.lang.Long pProjectId,
java.lang.String pPropertyKeyCode,
java.io.Serializable pNewValue)
updateProjectProperty in interface IFlexDeployFunctionspProjectId - - Id of the project 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.FlexDeployValidationException - if an invalid Project id and/or Property Key Code passed.public java.util.List<PropertyKeyDataObject> getTargetProperties(java.lang.Long pTargetId)
getTargetProperties in interface IFlexDeployFunctionspTargetId - - Id of the Target.FlexDeployRowNotFoundException - if Target id does not exist.public java.util.List<PropertyKeyDataObject> updateTargetProperties(java.lang.Long pTargetId, java.util.List<PropertyKeyDataObject> pPropertiesToUpdate)
updateTargetProperties in interface IFlexDeployFunctionspTargetId - - Id of the Target that is to be updated.pPropertiesToUpdate - - List of property values to be updated on Target.FlexDeployRowNotFoundException - If Target id does not exist.FlexDeployValidationException - If Property Definition id is not valid.public java.util.List<PropertyKeyDataObject> patchTargetProperties(java.lang.Long pTargetId, java.util.List<PropertyKeyDataObject> pPropertiesToUpdate)
patchTargetProperties in interface IFlexDeployFunctionspTargetId - - Id of the Target that is to be updated.pPropertiesToUpdate - - List of property values to be updated on Target.FlexDeployRowNotFoundException - If Target id does not exist.FlexDeployValidationException - If Property Definition id is not valid.public void uploadAttachmentsToIncident(java.lang.String pCMSInstanceCode,
java.lang.String pIncidentNumber,
java.util.Map<java.lang.String,java.io.InputStream> pAttachments)
throws ApiException
uploadAttachmentsToIncident in interface IFlexDeployFunctionspCMSInstanceCode - The CMS Instance Code.pIncidentNumber - The incident number to which attachments need to be uploaded.pAttachments - The attachments to be uploaded to the CMS Incident. This map should
contain the name of attachment(along with the extension) and the
attachment in the form of InputStream.ApiException - Throws if attachment cannot be uploaded in the CMS Incident.public void uploadAttachmentsToTicket(java.lang.String pCMSInstanceCode,
java.lang.String pTicketNumber,
java.util.Map<java.lang.String,java.io.InputStream> pAttachments)
throws ApiException
uploadAttachmentsToTicket in interface IFlexDeployFunctionspCMSInstanceCode - The CMS Instance Code.pTicketNumber - The ticket number to which attachments need to be uploaded.pAttachments - The attachments to be uploaded to the CMS ticket. This map should
contain the name of attachment(along with the extension) and the
attachment in the form of InputStream.ApiException - Throws if attachment cannot be uploaded in the CMS Ticket.public java.lang.Long createStandaloneRelease(java.lang.Long pProjectId,
java.lang.Long pBranchId,
java.lang.String pReleaseName,
java.lang.Long pBuildEnvironmentId,
java.lang.Long pPipelineId)
createStandaloneRelease in interface IFlexDeployFunctionspProjectId - - Project id for Standalone Release.pBranchId - - Branch id of the project.pReleaseName - - Name of Standalone Release to create.pBuildEnvironmentId - - Build environment id of the project(optional).pPipelineId - - Pipeline id for Standalone Release(optional - It can take default
value from Release settings)..FlexDeployValidationException - If invalid inputs are given.public java.lang.Long createStandaloneRelease(java.lang.Long pProjectId,
java.lang.Long pBranchId,
java.lang.String pPackageName,
java.lang.String pReleaseName,
java.lang.Long pBuildEnvironmentId,
java.lang.Long pPipelineId)
createStandaloneRelease in interface IFlexDeployFunctionspProjectId - - Project id for Standalone Release.pBranchId - - Branch id of the project.pPackageName - - Package name of the project.pReleaseName - - Name of Standalone Release to create.pBuildEnvironmentId - - Build environment id of the project(optional).pPipelineId - - Pipeline id for Standalone Release(optional - It can take default
value from Release settings).FlexDeployValidationException - If invalid inputs are given.public PaginatedResponse<WorkflowDataObject> searchWorkflows(WorkflowDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchWorkflows in interface IFlexDeployFunctionspublic PaginatedResponse<SearchResponse> searchByTag(java.lang.String pTagName, java.lang.Boolean pShowInactive, java.util.List<FlexDeploySecurityConstants.SecurityObjectType> pSearchEntities, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchByTag in interface IFlexDeployFunctionspublic PaginatedResponse<SearchResponse> searchByTag(java.lang.String pTagName, java.lang.Boolean pShowInactive, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchByTag in interface IFlexDeployFunctionspublic CmsTicketDataObject getCmsTicketById(java.lang.Long pCmsTicketId)
getCmsTicketById in interface IFlexDeployFunctionspCmsTicketId - - CMS Ticket id of the CMS Ticket to retrieve.FlexDeployRowNotFoundException - If CMS Ticket not found for given pCmsTicketId.public java.util.List<CmsTicketDataObject> getCmsTicketsByNumber(java.lang.String pCmsTicketNumber)
getCmsTicketsByNumber in interface IFlexDeployFunctionspCmsTicketNumber - - Ticket Number of the CMS Ticket to retrieve.FlexDeployRowNotFoundException - If CMS Ticket not found for given pCmsTicketNumber.public CmsTicketDataObject createCmsTicket(CmsTicketDataObject pCmsTicketDataObject)
createCmsTicket in interface IFlexDeployFunctionspCmsTicketDataObject - - Object containing the CMS Ticket details to create the CMS
Ticket.public CmsTicketDataObject updateCmsTicket(CmsTicketDataObject pCmsTicketDataObject)
updateCmsTicket in interface IFlexDeployFunctionspCmsTicketDataObject - - Object containing the CMS Ticket details to update the CMS
Ticket.FlexDeployRowNotFoundException - If no CMS Ticket is found for the given CMS Ticket
details.public CmsTicketDataObject patchCmsTicket(CmsTicketDataObject pCmsTicketDataObject)
patchCmsTicket in interface IFlexDeployFunctionspCmsTicketDataObject - - Object containing the CMS Ticket details to update the CMS
Ticket.FlexDeployRowNotFoundException - If no CMS Ticket is found for the given CMS Ticket
details.public void deleteCmsTicket(java.lang.Long pCmsTicketId)
deleteCmsTicket in interface IFlexDeployFunctionspCmsTicketId - - the id of the CMS Ticket.public PaginatedResponse<CmsTicketDataObject> searchCmsTickets(CmsTicketDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchCmsTickets in interface IFlexDeployFunctionspCriteriaObject - - CmsTicketDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public java.util.List<WorkItemDataObject> getWorkItemsByNumber(java.lang.String pWorkItemNumber)
getWorkItemsByNumber in interface IFlexDeployFunctionspWorkItemNumber - WorkItem number to get the WorkItem details.public PaginatedResponse<WorkItemDataObject> searchWorkItems(WorkItemDataObject pCriteriaObject, java.lang.Integer pLimit, java.lang.Integer pOffset)
searchWorkItems in interface IFlexDeployFunctionspCriteriaObject - - The WorkItemDataObject filled with criteria values.pLimit - - Limit for the number of rows to be returned.pOffset - - Offset number from which the limit starts. Pass 0 to start at
beginning of query result.public java.util.List<RelPropertyDataObject> getReleaseProperties(java.lang.Long pReleaseDefinitionId)
getReleaseProperties in interface IFlexDeployFunctionspReleaseDefinitionId - - Id of the Release.FlexDeployValidationException - if no Release properties are found for given Release
definition id.public RelPropertyDataObject getReleaseProperty(java.lang.Long pRelDefId, java.lang.String pPropertyKeyCode)
getReleaseProperty in interface IFlexDeployFunctionspRelDefId - - Id of the Release.pPropertyKeyCode - - The code of the release property.FlexDeployValidationException - if an invalid Release definition id and/or Property Key
Code passed.public java.util.List<RelPropertyDataObject> updateReleaseProperties(java.lang.Long pReleaseDefinitionId, java.util.List<RelPropertyDataObject> pInputs)
updateReleaseProperties in interface IFlexDeployFunctionspReleaseDefinitionId - - Id of the Release definition that is to be updated.pInputs - - List of properties to be updated on Release.public IntegrationInstancePojo createIntegrationInstanceAndProperties(IntegrationInstancePojo pPojo)
createIntegrationInstanceAndProperties in interface IFlexDeployFunctionspPojo - - The object containing all the required information for setting up the
Integration instanceFlexDeployAPIExceptionpublic IntegrationInstancePojo updateIntegrationInstanceAndProperties(IntegrationInstancePojo pPojo)
updateIntegrationInstanceAndProperties in interface IFlexDeployFunctionspPojo - - The object containing all of the required data for the Integration instance to
update.FlexDeployAPIExceptionpublic IntegrationInstancePojo patchIntegrationInstanceAndProperties(IntegrationInstancePojo pPojo)
patchIntegrationInstanceAndProperties in interface IFlexDeployFunctionspPojo - - The object containing all of the required data for the Integration instance to
update.FlexDeployAPIException