org.everit.atlassian.restclient.jiracloud.v2.model

Class FilterDetails

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.model.FilterDetails

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-11-13T15:26:36.903+01:00[Europe/Prague]")
public class FilterDetails
extends Object

Details of a filter.

Constructor Summary

Constructors

Constructor and Description
FilterDetails()

Method Summary

Modifier and Type	Method and Description
FilterDetails	addEditPermissionsItem(SharePermission editPermissionsItem)
FilterDetails	addSharePermissionsItem(SharePermission sharePermissionsItem)
FilterDetails	description(String description)
FilterDetails	editPermissions(List<SharePermission> editPermissions)
boolean	equals(Object o)
String	getDescription() The description of the filter.
List<SharePermission>	getEditPermissions() The groups and projects that can edit the filter.
String	getExpand() Expand options that include additional filter details in the response.
Boolean	getFavourite() Whether the filter is selected as a favorite by any users, not including the filter owner.
Long	getFavouritedCount() The count of how many users have selected this filter as a favorite, including the filter owner.
String	getId() The unique identifier for the filter.
String	getJql() The JQL query for the filter.
String	getName() The name of the filter.
User	getOwner() The user who owns the filter.
URI	getSearchUrl() A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-2-filter-search-get) operation with the filter's JQL string to return the filter results.
URI	getSelf() The URL of the filter.
List<SharePermission>	getSharePermissions() The groups and projects that the filter is shared with.
List<FilterSubscription>	getSubscriptions() The users that are subscribed to the filter.
URI	getViewUrl() A URL to view the filter results in Jira, using the ID of the filter.
int	hashCode()
FilterDetails	name(String name)
void	setDescription(String description)
void	setEditPermissions(List<SharePermission> editPermissions)
void	setName(String name)
void	setSharePermissions(List<SharePermission> sharePermissions)
FilterDetails	sharePermissions(List<SharePermission> sharePermissions)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterDetails

public FilterDetails()

Method Detail

description

public FilterDetails description(String description)

getDescription

public String getDescription()

The description of the filter.

Returns:

description

setDescription

public void setDescription(String description)

editPermissions

public FilterDetails editPermissions(List<SharePermission> editPermissions)

addEditPermissionsItem

public FilterDetails addEditPermissionsItem(SharePermission editPermissionsItem)

getEditPermissions

public List<SharePermission> getEditPermissions()

The groups and projects that can edit the filter. This can be specified when updating a filter, but not when creating a filter.

Returns:

editPermissions

setEditPermissions

public void setEditPermissions(List<SharePermission> editPermissions)

getExpand

public String getExpand()

Expand options that include additional filter details in the response.

Returns:

expand

getFavourite

public Boolean getFavourite()

Whether the filter is selected as a favorite by any users, not including the filter owner.

Returns:

favourite

getFavouritedCount

public Long getFavouritedCount()

The count of how many users have selected this filter as a favorite, including the filter owner.

Returns:

favouritedCount

getId

public String getId()

The unique identifier for the filter.

Returns:

id

getJql

public String getJql()

The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*.

Returns:

jql

name

public FilterDetails name(String name)

getName

public String getName()

The name of the filter.

Returns:

name

setName

public void setName(String name)

getOwner

public User getOwner()

The user who owns the filter. Defaults to the creator of the filter, however, Jira administrators can change the owner of a shared filter in the admin settings.

Returns:

owner

getSearchUrl

public URI getSearchUrl()

A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-2-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/2/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.

Returns:

searchUrl

getSelf

public URI getSelf()

The URL of the filter.

Returns:

self

sharePermissions

public FilterDetails sharePermissions(List<SharePermission> sharePermissions)

addSharePermissionsItem

public FilterDetails addSharePermissionsItem(SharePermission sharePermissionsItem)

getSharePermissions

public List<SharePermission> getSharePermissions()

The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter.

Returns:

sharePermissions

setSharePermissions

public void setSharePermissions(List<SharePermission> sharePermissions)

getSubscriptions

public List<FilterSubscription> getSubscriptions()

The users that are subscribed to the filter.

Returns:

subscriptions

getViewUrl

public URI getViewUrl()

A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*.

Returns:

viewUrl

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