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

Klasse GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder

java.lang.Object

io.github.primelib.jira4j.restv2.spec.GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder

Umschließende Klasse:

GetDashboardsPaginatedOperationSpec

public static class GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder	accountId(@Nullable String accountId)	User account ID used to return dashboards with the matching owner.accountId.
GetDashboardsPaginatedOperationSpec	build()
GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder	dashboardName(@Nullable String dashboardName)	String used to perform a case-insensitive partial match with name.
GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder	expand(@Nullable String expand)	Use [expand](#expansion) to include additional information about dashboard in the response.
GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder	groupId(@Nullable String groupId)	Group ID used to return dashboards that are shared with a group that matches sharePermissions.group.groupId.
GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder	groupname(@Nullable String groupname)	As a group's name can change, use of groupId is recommended.
GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder	maxResults(@Nullable Integer maxResults)	The maximum number of items to return per page.
GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder	orderBy(@Nullable String orderBy)	[Order](#ordering) the results by a field: * description Sorts by dashboard description.
GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder	owner(@Nullable String owner)	This parameter is deprecated because of privacy changes.
GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder	projectId(@Nullable Long projectId)	Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.
GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder	startAt(@Nullable Long startAt)	The index of the first item to return in a page of results (page offset).
GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder	status(@Nullable String status)	The status to filter by.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methodendetails

dashboardName

public GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder dashboardName(@Nullable
 @Nullable String dashboardName)

String used to perform a case-insensitive partial match with name.

Gibt zurück:

this.

accountId

public GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder 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.

Gibt zurück:

this.

owner

public GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder 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.

Gibt zurück:

this.

groupname

public GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder 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.

Gibt zurück:

this.

groupId

public GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder 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.

Gibt zurück:

this.

projectId

public GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder projectId(@Nullable
 @Nullable Long projectId)

Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.

Gibt zurück:

this.

orderBy

public GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder 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.

Gibt zurück:

this.

startAt

public GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder startAt(@Nullable
 @Nullable Long startAt)

The index of the first item to return in a page of results (page offset).

Gibt zurück:

this.

maxResults

public GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder maxResults(@Nullable
 @Nullable Integer maxResults)

The maximum number of items to return per page.

Gibt zurück:

this.

status

public GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder status(@Nullable
 @Nullable String status)

The status to filter by. It may be active, archived or deleted.

Gibt zurück:

this.

expand

public GetDashboardsPaginatedOperationSpec.GetDashboardsPaginatedOperationSpecBuilder 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.

Gibt zurück:

this.

build

public GetDashboardsPaginatedOperationSpec build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object