cz.encircled.jira.reactive

Class ReactiveJiraClient

cz.encircled.jira.reactive.ReactiveJiraClient

public class ReactiveJiraClient

Jira client base class

TODO wiremock testing

Constructor Summary

Constructors

Constructor and Description
ReactiveJiraClient(java.lang.String baseUrl, java.lang.String username, java.lang.String password, java.util.List<java.lang.String> defaultIssueFields) Jira client base class

Method Summary

Modifier and Type	Method and Description
ReactiveJiraClient	customFieldAlias(java.lang.String customFieldName, java.lang.String alias) Add a meaningful alias for issue custom field, which can be used instead of "customfield_123" in all methods (ReactiveJiraClient.getIssue, ReactiveJiraClient.searchIssues etc) and in Issue.fields
reactor.core.publisher.Flux<cz.encircled.jira.reactive.model.SprintReport>	getActiveSprints(int rapidBoardId) Find active sprints which belong to rapid view with given rapidBoardId
reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.JiraFilter>	getFilter(int id) Fetch jira filter by id
reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.Issue>	getIssue(java.lang.String key, java.util.List<java.lang.String> includedFields) Fetch jira issue by key
reactor.core.publisher.Flux<cz.encircled.jira.reactive.model.Issue>	getIssues(java.util.List<java.lang.String> keys, java.util.List<java.lang.String> includedFields) Fetch multiple jira issues by keys
reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.SprintReport>	getSprintReport(int rapidBoardId, int sprintId) Fetch particular sprint report for given rapidBoardId and sprintId
reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.SearchResult>	searchIssues(java.lang.String jql, java.util.List<java.lang.String> includedFields, int maxResults) Fetch multiple jira issues by JQL

Constructor Detail

ReactiveJiraClient

public ReactiveJiraClient(java.lang.String baseUrl,
                          java.lang.String username,
                          java.lang.String password,
                          java.util.List<java.lang.String> defaultIssueFields)

Jira client base class

TODO wiremock testing

Method Detail

customFieldAlias

public ReactiveJiraClient customFieldAlias(java.lang.String customFieldName,
                                           java.lang.String alias)

Add a meaningful alias for issue custom field, which can be used instead of "customfield_123" in all methods (ReactiveJiraClient.getIssue, ReactiveJiraClient.searchIssues etc) and in Issue.fields

See Also:

ReactiveJiraClient.getIssue, ReactiveJiraClient.searchIssues

getIssue

public reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.Issue> getIssue(java.lang.String key,
                                                                                    java.util.List<java.lang.String> includedFields)

Fetch jira issue by key

Parameters:

includedFields - issue fields to be fetched, default is all. Default can be overriden during client creation

getIssues

public reactor.core.publisher.Flux<cz.encircled.jira.reactive.model.Issue> getIssues(java.util.List<java.lang.String> keys,
                                                                                     java.util.List<java.lang.String> includedFields)

Fetch multiple jira issues by keys

Parameters:

includedFields - issue fields to be fetched, default is all. Default can be overriden during client creation

getFilter

public reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.JiraFilter> getFilter(int id)

Fetch jira filter by id

searchIssues

public reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.SearchResult> searchIssues(java.lang.String jql,
                                                                                               java.util.List<java.lang.String> includedFields,
                                                                                               int maxResults)

Fetch multiple jira issues by JQL

Parameters:

includedFields - issue fields to be fetched, default is all. Default can be overriden during client creation

maxResults - max result size

getActiveSprints

public reactor.core.publisher.Flux<cz.encircled.jira.reactive.model.SprintReport> getActiveSprints(int rapidBoardId)

Find active sprints which belong to rapid view with given rapidBoardId

Parameters:

rapidBoardId - id of target rapid view

getSprintReport

public reactor.core.publisher.Mono<cz.encircled.jira.reactive.model.SprintReport> getSprintReport(int rapidBoardId,
                                                                                                  int sprintId)

Fetch particular sprint report for given rapidBoardId and sprintId

Parameters:

rapidBoardId - id of target rapid view

sprintId - id of target sprint