org.everit.atlassian.restclient.jiracloud.v2.api

Class LicenseMetricsApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.LicenseMetricsApi

public class LicenseMetricsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
LicenseMetricsApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<LicenseMetric>	getApproximateApplicationLicenseCount(String applicationKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get approximate application license count Returns the total approximate number of user accounts for a single Jira license.
io.reactivex.Single<LicenseMetric>	getApproximateLicenseCount(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get approximate license count Returns the approximate number of user accounts across all Jira licenses.
io.reactivex.Single<License>	getLicense(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get license Returns licensing information about the Jira instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LicenseMetricsApi

public LicenseMetricsApi(org.everit.http.restclient.RestClient restClient)

Method Detail

getApproximateApplicationLicenseCount

public io.reactivex.Single<LicenseMetric> getApproximateApplicationLicenseCount(String applicationKey,
                                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get approximate application license count Returns the total approximate number of user accounts for a single Jira license. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

applicationKey - The ID of the application, represents a specific version of Jira. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<LicenseMetric>

getApproximateLicenseCount

public io.reactivex.Single<LicenseMetric> getApproximateLicenseCount(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get approximate license count Returns the approximate number of user accounts across all Jira licenses. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<LicenseMetric>

getLicense

public io.reactivex.Single<License> getLicense(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get license Returns licensing information about the Jira instance. **[Permissions](#permissions) required:** None.

Parameters:

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<License>