org.everit.atlassian.restclient.jiracloud.v3.model

Class Component

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.model.Component

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2020-10-28T14:12:40.546+01:00[Europe/Prague]")
public class Component
extends Object

Details about a project component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Component.AssigneeTypeEnum The nominal user type used to determine the assignee for issues created with this component.
static class	Component.RealAssigneeTypeEnum The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`.

Constructor Summary

Constructors

Constructor and Description
Component()

Method Summary

Modifier and Type	Method and Description
Component	assigneeType(Component.AssigneeTypeEnum assigneeType)
Component	description(String description)
boolean	equals(Object o)
User	getAssignee() The details of the user associated with `assigneeType`, if any.
Component.AssigneeTypeEnum	getAssigneeType() The nominal user type used to determine the assignee for issues created with this component.
String	getDescription() The description for the component.
String	getId() The unique identifier for the component.
Boolean	getIsAssigneeTypeValid() Whether a user is associated with `assigneeType`.
User	getLead() The user details for the component's lead user.
String	getLeadAccountId() The accountId of the component's lead user.
String	getLeadUserName() This property is no longer available and will be removed from the documentation soon.
String	getName() The unique name for the component in the project.
String	getProject() The key of the project the component is assigned to.
Long	getProjectId() The ID of the project the component is assigned to.
User	getRealAssignee() The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.
Component.RealAssigneeTypeEnum	getRealAssigneeType() The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`.
URI	getSelf() The URL of the component.
int	hashCode()
Component	leadAccountId(String leadAccountId)
Component	leadUserName(String leadUserName)
Component	name(String name)
Component	project(String project)
void	setAssigneeType(Component.AssigneeTypeEnum assigneeType)
void	setDescription(String description)
void	setLeadAccountId(String leadAccountId)
void	setLeadUserName(String leadUserName)
void	setName(String name)
void	setProject(String project)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Component

public Component()

Method Detail

getSelf

public URI getSelf()

The URL of the component.

Returns:

self

getId

public String getId()

The unique identifier for the component.

Returns:

id

name

public Component name(String name)

getName

public String getName()

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:

name

setName

public void setName(String name)

description

public Component description(String description)

getDescription

public String getDescription()

The description for the component. Optional when creating or updating a component.

Returns:

description

setDescription

public void setDescription(String description)

getLead

public User getLead()

The user details for the component's lead user.

Returns:

lead

leadUserName

public Component leadUserName(String leadUserName)

getLeadUserName

public String getLeadUserName()

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:

leadUserName

setLeadUserName

public void setLeadUserName(String leadUserName)

leadAccountId

public Component leadAccountId(String leadAccountId)

getLeadAccountId

public String getLeadAccountId()

The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.

Returns:

leadAccountId

setLeadAccountId

public void setLeadAccountId(String leadAccountId)

assigneeType

public Component assigneeType(Component.AssigneeTypeEnum assigneeType)

getAssigneeType

public Component.AssigneeTypeEnum getAssigneeType()

The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` 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:

assigneeType

setAssigneeType

public void setAssigneeType(Component.AssigneeTypeEnum assigneeType)

getAssignee

public User getAssignee()

The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.

Returns:

assignee

getRealAssigneeType

public Component.RealAssigneeTypeEnum getRealAssigneeType()

The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values: * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in. * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in. * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues. * `PROJECT_DEFAULT` when none of the preceding cases are true.

Returns:

realAssigneeType

getRealAssignee

public User getRealAssignee()

The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.

Returns:

realAssignee

getIsAssigneeTypeValid

public Boolean getIsAssigneeTypeValid()

Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.

Returns:

isAssigneeTypeValid

project

public Component project(String project)

getProject

public String getProject()

The key of the project the component is assigned to. Required when creating a component. Can't be updated.

Returns:

project

setProject

public void setProject(String project)

getProjectId

public Long getProjectId()

The ID of the project the component is assigned to.

Returns:

projectId

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object