Package io.github.primelib.jira4j.restv2.spec

Class GetDashboardsPaginatedOperationSpec

java.lang.Object
io.github.primelib.jira4j.restv2.spec.GetDashboardsPaginatedOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class GetDashboardsPaginatedOperationSpec extends Object
GetDashboardsPaginatedSpec

Specification for the GetDashboardsPaginated operation.

Search for dashboards

  • Field Details

    • VALIDATION_ENABLED

      @Experimental public static Boolean VALIDATION_ENABLED
      allows to disable validation of the spec, use with care!

  • Constructor Details

    • GetDashboardsPaginatedOperationSpec

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

    • GetDashboardsPaginatedOperationSpec

      @Internal public GetDashboardsPaginatedOperationSpec(String dashboardName, String accountId, String owner, String groupname, String groupId, Long projectId, String orderBy, Long startAt, Integer maxResults, String status, String expand)
      Constructs a validated instance of GetDashboardsPaginatedOperationSpec.

      NOTE: This constructor is not considered stable and may change if the operation is updated.

      Parameters:
      dashboardName - String used to perform a case-insensitive partial match with name.
      accountId - User account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter.
      owner - This parameter is deprecated because of privacy changes. Use accountId instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching owner.name. This parameter cannot be used with the accountId parameter.
      groupname - As a group's name can change, use of groupId is recommended. Group name used to return dashboards that are shared with a group that matches sharePermissions.group.name. This parameter cannot be used with the groupId parameter.
      groupId - Group ID used to return dashboards that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter.
      projectId - Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.
      orderBy - [Order](#ordering) the results by a field: * description Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use. * favourite_count Sorts by dashboard popularity. * id Sorts by dashboard ID. * is_favourite Sorts by whether the dashboard is marked as a favorite. * name Sorts by dashboard name. * owner Sorts by dashboard owner name.
      startAt - The index of the first item to return in a page of results (page offset).
      maxResults - The maximum number of items to return per page.
      status - The status to filter by. It may be active, archived or deleted.
      expand - Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include: * description Returns the description of the dashboard. * owner Returns the owner of the dashboard. * viewUrl Returns the URL that is used to view the dashboard. * favourite Returns isFavourite, an indicator of whether the user has set the dashboard as a favorite. * favouritedCount Returns popularity, a count of how many users have set this dashboard as a favorite. * sharePermissions Returns details of the share permissions defined for the dashboard. * editPermissions Returns details of the edit permissions defined for the dashboard. * isWritable Returns whether the current user has permission to edit the dashboard.

    • GetDashboardsPaginatedOperationSpec

      protected GetDashboardsPaginatedOperationSpec()

  • Method Details

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Throws:
      NullPointerException

    • builder

      public static GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder builder()

    • dashboardName

      @Nullable public @Nullable String dashboardName()
      String used to perform a case-insensitive partial match with name.

    • accountId

      @Nullable public @Nullable String accountId()
      User account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter.

    • owner

      @Nullable public @Nullable String owner()
      This parameter is deprecated because of privacy changes. Use accountId instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching owner.name. This parameter cannot be used with the accountId parameter.

    • groupname

      @Nullable public @Nullable String groupname()
      As a group's name can change, use of groupId is recommended. Group name used to return dashboards that are shared with a group that matches sharePermissions.group.name. This parameter cannot be used with the groupId parameter.

    • groupId

      @Nullable public @Nullable String groupId()
      Group ID used to return dashboards that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter.

    • projectId

      @Nullable public @Nullable Long projectId()
      Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.

    • orderBy

      @Nullable public @Nullable String orderBy()
      [Order](#ordering) the results by a field: * description Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use. * favourite_count Sorts by dashboard popularity. * id Sorts by dashboard ID. * is_favourite Sorts by whether the dashboard is marked as a favorite. * name Sorts by dashboard name. * owner Sorts by dashboard owner name.

    • startAt

      @Nullable public @Nullable Long startAt()
      The index of the first item to return in a page of results (page offset).

    • maxResults

      @Nullable public @Nullable Integer maxResults()
      The maximum number of items to return per page.

    • status

      @Nullable public @Nullable String status()
      The status to filter by. It may be active, archived or deleted.

    • expand

      @Nullable public @Nullable String expand()
      Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include: * description Returns the description of the dashboard. * owner Returns the owner of the dashboard. * viewUrl Returns the URL that is used to view the dashboard. * favourite Returns isFavourite, an indicator of whether the user has set the dashboard as a favorite. * favouritedCount Returns popularity, a count of how many users have set this dashboard as a favorite. * sharePermissions Returns details of the share permissions defined for the dashboard. * editPermissions Returns details of the edit permissions defined for the dashboard. * isWritable Returns whether the current user has permission to edit the dashboard.

    • dashboardName

      public GetDashboardsPaginatedOperationSpec dashboardName(@Nullable @Nullable String dashboardName)
      String used to perform a case-insensitive partial match with name.
      Returns:
      this.

    • accountId

      public GetDashboardsPaginatedOperationSpec accountId(@Nullable @Nullable String accountId)
      User account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter.
      Returns:
      this.

    • owner

      public GetDashboardsPaginatedOperationSpec owner(@Nullable @Nullable String owner)
      This parameter is deprecated because of privacy changes. Use accountId instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching owner.name. This parameter cannot be used with the accountId parameter.
      Returns:
      this.

    • groupname

      public GetDashboardsPaginatedOperationSpec groupname(@Nullable @Nullable String groupname)
      As a group's name can change, use of groupId is recommended. Group name used to return dashboards that are shared with a group that matches sharePermissions.group.name. This parameter cannot be used with the groupId parameter.
      Returns:
      this.

    • groupId

      public GetDashboardsPaginatedOperationSpec groupId(@Nullable @Nullable String groupId)
      Group ID used to return dashboards that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter.
      Returns:
      this.

    • projectId

      public GetDashboardsPaginatedOperationSpec projectId(@Nullable @Nullable Long projectId)
      Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.
      Returns:
      this.

    • orderBy

      public GetDashboardsPaginatedOperationSpec orderBy(@Nullable @Nullable String orderBy)
      [Order](#ordering) the results by a field: * description Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use. * favourite_count Sorts by dashboard popularity. * id Sorts by dashboard ID. * is_favourite Sorts by whether the dashboard is marked as a favorite. * name Sorts by dashboard name. * owner Sorts by dashboard owner name.
      Returns:
      this.

    • startAt

      public GetDashboardsPaginatedOperationSpec startAt(@Nullable @Nullable Long startAt)
      The index of the first item to return in a page of results (page offset).
      Returns:
      this.

    • maxResults

      public GetDashboardsPaginatedOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return per page.
      Returns:
      this.

    • status

      public GetDashboardsPaginatedOperationSpec status(@Nullable @Nullable String status)
      The status to filter by. It may be active, archived or deleted.
      Returns:
      this.

    • expand

      public GetDashboardsPaginatedOperationSpec expand(@Nullable @Nullable String expand)
      Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include: * description Returns the description of the dashboard. * owner Returns the owner of the dashboard. * viewUrl Returns the URL that is used to view the dashboard. * favourite Returns isFavourite, an indicator of whether the user has set the dashboard as a favorite. * favouritedCount Returns popularity, a count of how many users have set this dashboard as a favorite. * sharePermissions Returns details of the share permissions defined for the dashboard. * editPermissions Returns details of the edit permissions defined for the dashboard. * isWritable Returns whether the current user has permission to edit the dashboard.
      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