Class ProjectComponent.ProjectComponentBuilder
java.lang.Object
io.github.primelib.jira4j.restv2.model.ProjectComponent.ProjectComponentBuilder
- Enclosing class:
- ProjectComponent
-
Method Summary
Modifier and TypeMethodDescriptionCompass component's ID.assignee
(ProjectComponentAssignee assignee) assigneeType
(ProjectComponent.AssigneeTypeEnum assigneeType) The nominal user type used to determine the assignee for issues created with this component.build()
description
(String description) The description for the component.The unique identifier for the component.isAssigneeTypeValid
(Boolean isAssigneeTypeValid) Whether a user is associated withassigneeType
.lead
(ProjectComponentLead lead) leadAccountId
(String leadAccountId) The accountId of the component's lead user.leadUserName
(String leadUserName) This property is no longer available and will be removed from the documentation soon.Compass component's metadata.The unique name for the component in the project.The key of the project the component is assigned to.The ID of the project the component is assigned to.realAssignee
(ProjectComponentRealAssignee realAssignee) realAssigneeType
(ProjectComponent.RealAssigneeTypeEnum realAssigneeType) The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from theassigneeType
.The URL of the component.toString()
-
Method Details
-
ari
Compass component's ID. Can't be updated. Not required for creating a Project Component.- Returns:
this
.
-
assignee
- Returns:
this
.
-
assigneeType
public ProjectComponent.ProjectComponentBuilder assigneeType(ProjectComponent.AssigneeTypeEnum assigneeType) The nominal user type used to determine the assignee for issues created with this component. SeerealAssigneeType
for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values: *PROJECT_LEAD
the assignee to any issues created with this component is nominally the lead for the project the component is in. *COMPONENT_LEAD
the assignee to any issues created with this component is nominally the lead for the component. *UNASSIGNED
an assignee is not set for issues created with this component. *PROJECT_DEFAULT
the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Default value:PROJECT_DEFAULT
. Optional when creating or updating a component.- Returns:
this
.
-
description
The description for the component. Optional when creating or updating a component.- Returns:
this
.
-
id
The unique identifier for the component.- Returns:
this
.
-
isAssigneeTypeValid
Whether a user is associated withassigneeType
. For example, if theassigneeType
is set toCOMPONENT_LEAD
but the component lead is not set, thenfalse
is returned.- Returns:
this
.
-
lead
- Returns:
this
.
-
leadAccountId
The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.- Returns:
this
.
-
leadUserName
This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.- Returns:
this
.
-
metadata
Compass component's metadata. Can't be updated. Not required for creating a Project Component.- Returns:
this
.
-
name
The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.- Returns:
this
.
-
project
The key of the project the component is assigned to. Required when creating a component. Can't be updated.- Returns:
this
.
-
projectId
The ID of the project the component is assigned to.- Returns:
this
.
-
realAssignee
public ProjectComponent.ProjectComponentBuilder realAssignee(ProjectComponentRealAssignee realAssignee) - Returns:
this
.
-
realAssigneeType
public ProjectComponent.ProjectComponentBuilder realAssigneeType(ProjectComponent.RealAssigneeTypeEnum realAssigneeType) The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from theassigneeType
. For example,assigneeType
is set toCOMPONENT_LEAD
but no component lead is set. This property is set to one of the following values: *PROJECT_LEAD
whenassigneeType
isPROJECT_LEAD
and the project lead has permission to be assigned issues in the project that the component is in. *COMPONENT_LEAD
whenassignee
Type isCOMPONENT_LEAD
and the component lead has permission to be assigned issues in the project that the component is in. *UNASSIGNED
whenassigneeType
isUNASSIGNED
and Jira is configured to allow unassigned issues. *PROJECT_DEFAULT
when none of the preceding cases are true.- Returns:
this
.
-
self
The URL of the component.- Returns:
this
.
-
build
-
toString
-