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

Class Filter

java.lang.Object

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

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

Details about a filter.

Constructor Summary

Constructors

Constructor and Description
Filter()

Method Summary

Modifier and Type	Method and Description
Filter	addSharePermissionsItem(SharePermission sharePermissionsItem)
Filter	description(String description)
boolean	equals(Object o)
Filter	favourite(Boolean favourite)
String	getDescription() A description of the filter.
Boolean	getFavourite() Whether the filter is selected as a favorite.
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.
UserList	getSharedUsers() A paginated list of the users that the filter is shared with.
List<SharePermission>	getSharePermissions() The groups and projects that the filter is shared with.
FilterSubscriptionsList	getSubscriptions() A paginated list of 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()
Filter	jql(String jql)
Filter	name(String name)
void	setDescription(String description)
void	setFavourite(Boolean favourite)
void	setJql(String jql)
void	setName(String name)
void	setSharePermissions(List<SharePermission> sharePermissions)
Filter	sharePermissions(List<SharePermission> sharePermissions)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

public Filter()

Method Detail

getSelf

public URI getSelf()

The URL of the filter.

Returns:

self

getId

public String getId()

The unique identifier for the filter.

Returns:

id

name

public Filter name(String name)

getName

public String getName()

The name of the filter. Must be unique.

Returns:

name

setName

public void setName(String name)

description

public Filter description(String description)

getDescription

public String getDescription()

A description of the filter.

Returns:

description

setDescription

public void setDescription(String description)

getOwner

public User getOwner()

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

Returns:

owner

jql

public Filter jql(String jql)

getJql

public String getJql()

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

Returns:

jql

setJql

public void setJql(String jql)

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

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

favourite

public Filter favourite(Boolean favourite)

getFavourite

public Boolean getFavourite()

Whether the filter is selected as a favorite.

Returns:

favourite

setFavourite

public void setFavourite(Boolean favourite)

getFavouritedCount

public Long getFavouritedCount()

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

Returns:

favouritedCount

sharePermissions

public Filter sharePermissions(List<SharePermission> sharePermissions)

addSharePermissionsItem

public Filter addSharePermissionsItem(SharePermission sharePermissionsItem)

getSharePermissions

public List<SharePermission> getSharePermissions()

The groups and projects that the filter is shared with.

Returns:

sharePermissions

setSharePermissions

public void setSharePermissions(List<SharePermission> sharePermissions)

getSharedUsers

public UserList getSharedUsers()

A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with.

Returns:

sharedUsers

getSubscriptions

public FilterSubscriptionsList getSubscriptions()

A paginated list of the users that are subscribed to the filter.

Returns:

subscriptions

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