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

Class FoundFilter

java.lang.Object

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2019-09-05T12:17:30.184+02:00[Europe/Prague]")
public class FoundFilter
extends Object

Details of a filter identified as part of a search.

Constructor Summary

Constructors

Constructor and Description
FoundFilter()

Method Summary

Modifier and Type	Method and Description
FoundFilter	addSharePermissionsItem(SharePermission sharePermissionsItem)
FoundFilter	description(String description)
boolean	equals(Object o)
String	getDescription() A description of the filter.
Boolean	getFavourite() Indicates 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()
FoundFilter	name(String name)
void	setDescription(String description)
void	setName(String name)
void	setSharePermissions(List<SharePermission> sharePermissions)
FoundFilter	sharePermissions(List<SharePermission> sharePermissions)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FoundFilter

public FoundFilter()

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 FoundFilter 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 FoundFilter 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

getJql

public String getJql()

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

Returns:

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

getFavourite

public Boolean getFavourite()

Indicates 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

sharePermissions

public FoundFilter sharePermissions(List<SharePermission> sharePermissions)

addSharePermissionsItem

public FoundFilter 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

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