Class WorkflowScheme.WorkflowSchemeBuilder
java.lang.Object
io.github.primelib.jira4j.restv3.model.WorkflowScheme.WorkflowSchemeBuilder
- Enclosing class:
- WorkflowScheme
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
defaultWorkflow
(String defaultWorkflow) The name of the default workflow for the workflow scheme.description
(String description) The description of the workflow scheme.Whether the workflow scheme is a draft or not.The ID of the workflow scheme.issueTypeMappings
(Map<String, String> issueTypeMappings) The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair.issueTypes
(Map<String, IssueTypeDetails> issueTypes) The issue types available in Jira.lastModified
(String lastModified) The date-time that the draft workflow scheme was last modified.lastModifiedUser
(WorkflowSchemeLastModifiedUser lastModifiedUser) The name of the workflow scheme.originalDefaultWorkflow
(String originalDefaultWorkflow) For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme.originalIssueTypeMappings
(Map<String, String> originalIssueTypeMappings) For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair.toString()
updateDraftIfNeeded
(Boolean updateDraftIfNeeded) Whether to create or update a draft workflow scheme when updating an active workflow scheme.
-
Method Details
-
defaultWorkflow
The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. IfdefaultWorkflow
is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*.- Returns:
this
.
-
description
The description of the workflow scheme.- Returns:
this
.
-
draft
Whether the workflow scheme is a draft or not.- Returns:
this
.
-
id
The ID of the workflow scheme.- Returns:
this
.
-
issueTypeMappings
The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.- Returns:
this
.
-
issueTypes
The issue types available in Jira.- Returns:
this
.
-
lastModified
The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.- Returns:
this
.
-
lastModifiedUser
public WorkflowScheme.WorkflowSchemeBuilder lastModifiedUser(WorkflowSchemeLastModifiedUser lastModifiedUser) - Returns:
this
.
-
name
The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.- Returns:
this
.
-
originalDefaultWorkflow
For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira.- Returns:
this
.
-
originalIssueTypeMappings
public WorkflowScheme.WorkflowSchemeBuilder originalIssueTypeMappings(Map<String, String> originalIssueTypeMappings) For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.- Returns:
this
.
-
self
- Returns:
this
.
-
updateDraftIfNeeded
Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works: * Update an active workflow scheme withupdateDraftIfNeeded
set totrue
: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created. * Update an active workflow scheme withupdateDraftIfNeeded
set tofalse
: An error is returned, as active workflow schemes cannot be updated. * Update an inactive workflow scheme withupdateDraftIfNeeded
set totrue
: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update. Defaults tofalse
.- Returns:
this
.
-
build
-
toString
-