Package io.github.primelib.jira4j.restv3.model

Class ProjectComponent

java.lang.Object
io.github.primelib.jira4j.restv3.model.ProjectComponent
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class ProjectComponent extends Object
ProjectComponent

  • Field Details

    • ari

      protected String ari
      Compass component's ID. Can't be updated. Not required for creating a Project Component.

    • assignee

      protected ProjectComponentAssignee assignee

    • assigneeType

      protected ProjectComponent.AssigneeTypeEnum assigneeType
      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.

    • description

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

    • id

      protected String id
      The unique identifier for the component.

    • isAssigneeTypeValid

      protected Boolean isAssigneeTypeValid
      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.

    • lead

      protected ProjectComponentLead lead

    • leadAccountId

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

    • leadUserName

      protected String 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.

    • metadata

      protected Map<String,String> metadata
      Compass component's metadata. Can't be updated. Not required for creating a Project Component.

    • name

      protected String 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.

    • project

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

    • projectId

      protected Long projectId
      The ID of the project the component is assigned to.

    • realAssignee

      protected ProjectComponentRealAssignee realAssignee

    • realAssigneeType

      protected ProjectComponent.RealAssigneeTypeEnum realAssigneeType
      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 assigneeType 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.

    • self

      protected URI self
      The URL of the component.

  • Constructor Details

    • ProjectComponent

      public ProjectComponent(Consumer<ProjectComponent> spec)
      Constructs a validated instance of ProjectComponent.
      Parameters:
      spec - the specification to process

    • ProjectComponent

      @Internal public ProjectComponent(String ari, ProjectComponentAssignee assignee, ProjectComponent.AssigneeTypeEnum assigneeType, String description, String id, Boolean isAssigneeTypeValid, ProjectComponentLead lead, String leadAccountId, String leadUserName, Map<String,String> metadata, String name, String project, Long projectId, ProjectComponentRealAssignee realAssignee, ProjectComponent.RealAssigneeTypeEnum realAssigneeType, URI self)
      Constructs a validated instance of ProjectComponent.

      NOTE: This constructor is not considered stable and may change if the model is updated. Consider using ProjectComponent(Consumer) instead.

      Parameters:
      ari - Compass component's ID. Can't be updated. Not required for creating a Project Component.
      assignee - assignee
      assigneeType - 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.
      description - The description for the component. Optional when creating or updating a component.
      id - The unique identifier for the component.
      isAssigneeTypeValid - 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.
      lead - lead
      leadAccountId - The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
      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.
      metadata - Compass component's metadata. Can't be updated. Not required for creating a Project Component.
      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.
      project - The key of the project the component is assigned to. Required when creating a component. Can't be updated.
      projectId - The ID of the project the component is assigned to.
      realAssignee - realAssignee
      realAssigneeType - 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 assigneeType 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.
      self - The URL of the component.

    • ProjectComponent

      protected ProjectComponent()

  • Method Details

    • builder

      public static ProjectComponent.ProjectComponentBuilder builder()

    • ari

      public String ari()
      Compass component's ID. Can't be updated. Not required for creating a Project Component.

    • assignee

      public ProjectComponentAssignee assignee()

    • assigneeType

      public ProjectComponent.AssigneeTypeEnum assigneeType()
      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.

    • description

      public String description()
      The description for the component. Optional when creating or updating a component.

    • id

      public String id()
      The unique identifier for the component.

    • isAssigneeTypeValid

      public Boolean isAssigneeTypeValid()
      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.

    • lead

      public ProjectComponentLead lead()

    • leadAccountId

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

    • leadUserName

      public String 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.

    • metadata

      public Map<String,String> metadata()
      Compass component's metadata. Can't be updated. Not required for creating a Project Component.

    • name

      public String 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.

    • project

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

    • projectId

      public Long projectId()
      The ID of the project the component is assigned to.

    • realAssignee

      public ProjectComponentRealAssignee realAssignee()

    • realAssigneeType

      public ProjectComponent.RealAssigneeTypeEnum realAssigneeType()
      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 assigneeType 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.

    • self

      public URI self()
      The URL of the component.

    • ari

      public ProjectComponent ari(String ari)
      Compass component's ID. Can't be updated. Not required for creating a Project Component.
      Returns:
      this.

    • assignee

      public ProjectComponent assignee(ProjectComponentAssignee assignee)
      Returns:
      this.

    • assigneeType

      public ProjectComponent assigneeType(ProjectComponent.AssigneeTypeEnum assigneeType)
      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:
      this.

    • description

      public ProjectComponent description(String description)
      The description for the component. Optional when creating or updating a component.
      Returns:
      this.

    • id

      public ProjectComponent id(String id)
      The unique identifier for the component.
      Returns:
      this.

    • isAssigneeTypeValid

      public ProjectComponent isAssigneeTypeValid(Boolean isAssigneeTypeValid)
      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:
      this.

    • lead

      public ProjectComponent lead(ProjectComponentLead lead)
      Returns:
      this.

    • leadAccountId

      public ProjectComponent leadAccountId(String 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

      public ProjectComponent leadUserName(String 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

      public ProjectComponent metadata(Map<String,String> metadata)
      Compass component's metadata. Can't be updated. Not required for creating a Project Component.
      Returns:
      this.

    • name

      public ProjectComponent name(String 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

      public ProjectComponent project(String project)
      The key of the project the component is assigned to. Required when creating a component. Can't be updated.
      Returns:
      this.

    • projectId

      public ProjectComponent projectId(Long projectId)
      The ID of the project the component is assigned to.
      Returns:
      this.

    • realAssignee

      public ProjectComponent realAssignee(ProjectComponentRealAssignee realAssignee)
      Returns:
      this.

    • realAssigneeType

      public ProjectComponent 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 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 assigneeType 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:
      this.

    • self

      public ProjectComponent self(URI self)
      The URL of the component.
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object