Issues (jira-infra 8.10.0 API)

com.adaptavist.hapi.jira.issues.Issues

@com.adaptavist.hapi.platform.analytics.Tracked
class Issues
extends java.lang.Object

Constructor Summary

Constructors
Constructor and description
`Issues()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static long`	`count(java.lang.String jql)` Returns the number of matching issues.
	`static long`	`count(com.atlassian.query.Query query)` Returns the number of matching issues.
	`static long`	`count(com.atlassian.jira.issue.search.SearchRequest searchRequest)` Returns the number of matching issues.
	`static long`	`count(com.atlassian.jira.issue.search.SearchQuery searchQuery)` Returns the number of matching issues.
	`static long`	`countOverrideSecurity(java.lang.String jql)` Returns the number of matching issues, overriding security
	`static long`	`countOverrideSecurity(com.atlassian.query.Query query)` Returns the number of matching issues, overriding security
	`static long`	`countOverrideSecurity(com.atlassian.jira.issue.search.SearchRequest searchRequest)` Executes a filter and returns a count of the matching issues, overriding security
	`static com.atlassian.jira.issue.Issue`	`create(java.lang.String projectKey, java.lang.String issueType, groovy.lang.Closure<?> specification)` Creates an issue of a given type in a project found by project key, example usage: Issues.create('SR', 'Task') { summary = 'Hello world' }
	`static com.atlassian.jira.issue.Issue`	`create(java.lang.String projectKey, int issueTypeId, groovy.lang.Closure<?> specification)` Creates an issue of a given type in a project found by project key, example usage: Issues.create('SR', 1001) { summary = 'Hello world' }
	`static com.atlassian.jira.issue.Issue`	`create(com.atlassian.jira.project.Project project, com.atlassian.jira.issue.issuetype.IssueType issueType, groovy.lang.Closure<?> specification)` Creates an issue of a given type in a project, example usage: Issues.create(Projects.getByKey('SR'), IssueTypes.getByName('Task')) { summary = 'Hello world' }
	`static com.atlassian.jira.issue.Issue`	`getByKey(java.lang.String issueKey)` Gets an issue by its current key
	`static IssueIterator`	`search(java.lang.String jql)` Executes the jql and returns matching issues.
	`static IssueIterator`	`search(com.atlassian.query.Query query)` Executes a Query and returns matching issues.
	`static IssueIterator`	`search(com.atlassian.jira.issue.search.SearchQuery searchQuery)` Executes a SearchQuery and returns matching issues.
	`static IssueIterator`	`search(com.atlassian.jira.issue.search.SearchRequest searchRequest)` Executes a filter and returns the matching issues.
	`static IssueIterator`	`searchOverrideSecurity(java.lang.String jql)` Executes the jql and returns matching issues, overriding security.
	`static IssueIterator`	`searchOverrideSecurity(com.atlassian.query.Query query)` Executes the Query and returns matching issues, overriding security.
	`static IssueIterator`	`searchOverrideSecurity(com.atlassian.jira.issue.search.SearchRequest searchRequest)` Executes a filter and returns matching issues, overriding security.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - Issues()
- Method Detail
  - static long count(java.lang.String jql)
    
    Returns the number of matching issues.
    throws:
    com.atlassian.jira.jql.parser.JqlParseException if the provided JQL could not be parsed
    
    Parameters:
    jql - A jql query
    Returns:
    the number of matching issues
  - static long count(com.atlassian.query.Query query)
    
    Returns the number of matching issues.
    Parameters:
    query - query to find issues that will be counted
    Returns:
    the number of matching issues
  - static long count(com.atlassian.jira.issue.search.SearchRequest searchRequest)
    
    Returns the number of matching issues.
    Parameters:
    searchRequest - the SearchRequest object representing the filter See: Filters.getById
    Returns:
    the number of matching issues
  - static long count(com.atlassian.jira.issue.search.SearchQuery searchQuery)
    
    Returns the number of matching issues.
    Parameters:
    searchQuery - searchQuery to find issues that will be counted
    Returns:
    the number of matching issues
  - static long countOverrideSecurity(java.lang.String jql)
    
    Returns the number of matching issues, overriding security
    throws:
    com.atlassian.jira.jql.parser.JqlParseException if the provided JQL could not be parsed
    
    Parameters:
    jql - A jql query
    Returns:
    the number of matching issues
  - static long countOverrideSecurity(com.atlassian.query.Query query)
    
    Returns the number of matching issues, overriding security
    Parameters:
    query - query to find issues that will be counted
    Returns:
    the number of matching issues
  - static long countOverrideSecurity(com.atlassian.jira.issue.search.SearchRequest searchRequest)
    
    Executes a filter and returns a count of the matching issues, overriding security
    Parameters:
    searchRequest - the SearchRequest object representing the filter See: Filters.getById
    Returns:
    the number of matching issues
  - static com.atlassian.jira.issue.Issue create(java.lang.String projectKey, java.lang.String issueType, @groovy.lang.DelegatesTo(value: IssueCreationDelegate)
    groovy.lang.Closure<?> specification)
    
    Creates an issue of a given type in a project found by project key, example usage:
```
 Issues.create('SR', 'Task') {
     summary = 'Hello world'
 }
```
    throws:
    com.adaptavist.hapi.jira.issues.exceptions.IssueCreationValidationException if validation fails
    throws:
    com.adaptavist.hapi.jira.issues.exceptions.IssueCreationException if issue creation fails
    throws:
    com.adaptavist.hapi.jira.issues.exceptions.InvalidIssueTypeException if no issue type can be found by name
    
    Parameters:
    projectKey - project key of the project to create the issue in
    issueType - issue type for the issue
    specification - closure containing parameters to set on the created issue
    Returns:
    the created issue
  - static com.atlassian.jira.issue.Issue create(java.lang.String projectKey, int issueTypeId, @groovy.lang.DelegatesTo(value: IssueCreationDelegate)
    groovy.lang.Closure<?> specification)
    
    Creates an issue of a given type in a project found by project key, example usage:
```
 Issues.create('SR', 1001) {
     summary = 'Hello world'
 }
```
    throws:
    com.adaptavist.hapi.jira.issues.exceptions.IssueCreationValidationException if validation fails
    throws:
    com.adaptavist.hapi.jira.issues.exceptions.IssueCreationException if issue creation fails
    throws:
    com.adaptavist.hapi.jira.issues.exceptions.InvalidIssueTypeException if no issue type can be found by ID
    
    Parameters:
    projectKey - project key of the project to create the issue in
    issueTypeId - issue type ID for the issue
    specification - closure containing parameters to set on the created issue
    Returns:
    the created issue
  - static com.atlassian.jira.issue.Issue create(com.atlassian.jira.project.Project project, com.atlassian.jira.issue.issuetype.IssueType issueType, @groovy.lang.DelegatesTo(value: IssueCreationDelegate)
    groovy.lang.Closure<?> specification)
    
    Creates an issue of a given type in a project, example usage:
```
 Issues.create(Projects.getByKey('SR'), IssueTypes.getByName('Task')) {
     summary = 'Hello world'
 }
```
    throws:
    com.adaptavist.hapi.jira.issues.exceptions.IssueCreationValidationException if validation fails
    throws:
    com.adaptavist.hapi.jira.issues.exceptions.IssueCreationException if issue creation fails
    
    Parameters:
    project - project to create the issue in
    issueType - issue type for the issue
    specification - closure containing parameters to set on the created issue
    Returns:
    the created issue
  - static com.atlassian.jira.issue.Issue getByKey(java.lang.String issueKey)
    
    Gets an issue by its current key
    throws:
    com.adaptavist.hapi.jira.issues.exceptions.IssueRetrievalException if there is an error retrieving the issue
    
    Parameters:
    issueKey - issue key
    Returns:
    the found issue
  - static IssueIterator search(java.lang.String jql)
    
    Executes the jql and returns matching issues. You can iterate over the issues in the response, for example to edit or transition each one:
```
 Issues.search('project = FOO').each {
     // do something with it
 }
```
    Or filter them further:
```
 Issues.search('project = FOO').findAll {
     // condition
 }
```
    If you only need the top N:
```
 Issues.search('project = FOO').take(10)
```
    DO NOT attempt to convert a potentially unlimited set to a List, e.g.:
```
 Issues.search('project = FOO').toList()
 
```
    as this could potentially consume a large amount of memory. If you need a list then limit it to the top N:
```
 Issues.search('project = FOO').take(100).toList()
 
```
    throws:
    com.atlassian.jira.jql.parser.JqlParseException if the provided JQL could not be parsed
    
    Parameters:
    jql - A jql query
    Returns:
    an Iterable of Issue objects
  - static IssueIterator search(com.atlassian.query.Query query)
    
    Executes a Query and returns matching issues.
    Parameters:
    query - query to find issues
    Returns:
    an Iterable of Issue objects
  - static IssueIterator search(com.atlassian.jira.issue.search.SearchQuery searchQuery)
    
    Executes a SearchQuery and returns matching issues.
    Parameters:
    searchQuery - searchQuery to find issues
    Returns:
    an Iterable of Issue objects
  - static IssueIterator search(com.atlassian.jira.issue.search.SearchRequest searchRequest)
    
    Executes a filter and returns the matching issues.
    Parameters:
    searchRequest - the SearchRequest object representing the filter See: Filters.getById
    Returns:
    an Iterable of Issue objects
  - static IssueIterator searchOverrideSecurity(java.lang.String jql)
    
    Executes the jql and returns matching issues, overriding security.
    throws:
    com.atlassian.jira.jql.parser.JqlParseException if the provided JQL could not be parsed
    
    Parameters:
    jql - A jql query
    Returns:
    an Iterable of Issue objects
  - static IssueIterator searchOverrideSecurity(com.atlassian.query.Query query)
    
    Executes the Query and returns matching issues, overriding security.
    Parameters:
    query - query to find issues
    Returns:
    an Iterable of Issue objects
  - static IssueIterator searchOverrideSecurity(com.atlassian.jira.issue.search.SearchRequest searchRequest)
    
    Executes a filter and returns matching issues, overriding security.
    Parameters:
    searchRequest - the SearchRequest object representing the filter See: Filters.getById
    Returns:
    an Iterable of Issue objects

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class Issues

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Issues()

Method Detail

static long count(java.lang.String jql)

static long count(com.atlassian.query.Query query)

static long count(com.atlassian.jira.issue.search.SearchRequest searchRequest)

static long count(com.atlassian.jira.issue.search.SearchQuery searchQuery)

static long countOverrideSecurity(java.lang.String jql)

static long countOverrideSecurity(com.atlassian.query.Query query)

static long countOverrideSecurity(com.atlassian.jira.issue.search.SearchRequest searchRequest)

static com.atlassian.jira.issue.Issue create(java.lang.String projectKey, java.lang.String issueType, @groovy.lang.DelegatesTo(value: IssueCreationDelegate)
groovy.lang.Closure<?> specification)

static com.atlassian.jira.issue.Issue create(java.lang.String projectKey, int issueTypeId, @groovy.lang.DelegatesTo(value: IssueCreationDelegate)
groovy.lang.Closure<?> specification)

static com.atlassian.jira.issue.Issue create(com.atlassian.jira.project.Project project, com.atlassian.jira.issue.issuetype.IssueType issueType, @groovy.lang.DelegatesTo(value: IssueCreationDelegate)
groovy.lang.Closure<?> specification)

static com.atlassian.jira.issue.Issue getByKey(java.lang.String issueKey)

static IssueIterator search(java.lang.String jql)

static IssueIterator search(com.atlassian.query.Query query)

static IssueIterator search(com.atlassian.jira.issue.search.SearchQuery searchQuery)

static IssueIterator search(com.atlassian.jira.issue.search.SearchRequest searchRequest)

static IssueIterator searchOverrideSecurity(java.lang.String jql)

static IssueIterator searchOverrideSecurity(com.atlassian.query.Query query)

static IssueIterator searchOverrideSecurity(com.atlassian.jira.issue.search.SearchRequest searchRequest)

[Groovy] Class Issues

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Issues()

Method Detail

static long count(java.lang.String jql)

static long count(com.atlassian.query.Query query)

static long count(com.atlassian.jira.issue.search.SearchRequest searchRequest)

static long count(com.atlassian.jira.issue.search.SearchQuery searchQuery)

static long countOverrideSecurity(java.lang.String jql)

static long countOverrideSecurity(com.atlassian.query.Query query)

static long countOverrideSecurity(com.atlassian.jira.issue.search.SearchRequest searchRequest)

static com.atlassian.jira.issue.Issue create(java.lang.String projectKey, java.lang.String issueType, @groovy.lang.DelegatesTo(value: IssueCreationDelegate)groovy.lang.Closure<?> specification)

static com.atlassian.jira.issue.Issue create(java.lang.String projectKey, int issueTypeId, @groovy.lang.DelegatesTo(value: IssueCreationDelegate)groovy.lang.Closure<?> specification)

static com.atlassian.jira.issue.Issue create(com.atlassian.jira.project.Project project, com.atlassian.jira.issue.issuetype.IssueType issueType, @groovy.lang.DelegatesTo(value: IssueCreationDelegate)groovy.lang.Closure<?> specification)

static com.atlassian.jira.issue.Issue getByKey(java.lang.String issueKey)

static IssueIterator search(java.lang.String jql)

static IssueIterator search(com.atlassian.query.Query query)

static IssueIterator search(com.atlassian.jira.issue.search.SearchQuery searchQuery)

static IssueIterator search(com.atlassian.jira.issue.search.SearchRequest searchRequest)

static IssueIterator searchOverrideSecurity(java.lang.String jql)

static IssueIterator searchOverrideSecurity(com.atlassian.query.Query query)

static IssueIterator searchOverrideSecurity(com.atlassian.jira.issue.search.SearchRequest searchRequest)

static com.atlassian.jira.issue.Issue create(java.lang.String projectKey, java.lang.String issueType, @groovy.lang.DelegatesTo(value: IssueCreationDelegate)
groovy.lang.Closure<?> specification)

static com.atlassian.jira.issue.Issue create(java.lang.String projectKey, int issueTypeId, @groovy.lang.DelegatesTo(value: IssueCreationDelegate)
groovy.lang.Closure<?> specification)

static com.atlassian.jira.issue.Issue create(com.atlassian.jira.project.Project project, com.atlassian.jira.issue.issuetype.IssueType issueType, @groovy.lang.DelegatesTo(value: IssueCreationDelegate)
groovy.lang.Closure<?> specification)