org.everit.atlassian.restclient.jiracloud.v3.api

Class ProjectComponentsApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.ProjectComponentsApi

public class ProjectComponentsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Component>	createComponent(Component component, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Create component Creates a component.
io.reactivex.Completable	deleteComponent(String id, Optional<String> moveIssuesTo, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete component Deletes a component.
io.reactivex.Single<Component>	getComponent(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get component Returns a component.
io.reactivex.Single<ComponentIssuesCount>	getComponentRelatedIssues(String id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get component issues count Returns the counts of issues assigned to the component.
io.reactivex.Single<List<Component>>	getProjectComponents(String projectIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project components Returns all components in a project.
io.reactivex.Single<PageBeanComponentWithIssueCount>	getProjectComponentsPaginated(String projectIdOrKey, Optional<Long> startAt, Optional<Integer> maxResults, Optional<String> orderBy, Optional<String> query, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project components paginated Returns a [paginated](#pagination) list of all components in a project.
io.reactivex.Single<Component>	updateComponent(String id, Component component, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Update component Updates a component.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectComponentsApi

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

Method Detail

createComponent

public io.reactivex.Single<Component> createComponent(Component component,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Create component Creates a component. Use components to provide containers for issues within a project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the component is created or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

component - (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<Component>

deleteComponent

public io.reactivex.Completable deleteComponent(String id,
                                                Optional<String> moveIssuesTo,
                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete component Deletes a component. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the component. (required)

moveIssuesTo - The ID of the component to replace the deleted component. If this value is null no replacement is made. (optional)

restRequestEnhancer -

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

Returns:

Completable

getComponent

public io.reactivex.Single<Component> getComponent(String id,
                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get component Returns a component. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for project containing the component.

Parameters:

id - The ID of the component. (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<Component>

getComponentRelatedIssues

public io.reactivex.Single<ComponentIssuesCount> getComponentRelatedIssues(String id,
                                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get component issues count Returns the counts of issues assigned to the component. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None.

Parameters:

id - The ID of the component. (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<ComponentIssuesCount>

getProjectComponents

public io.reactivex.Single<List<Component>> getProjectComponents(String projectIdOrKey,
                                                                 Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project components Returns all components in a project. See the [Get project components paginated](#api-rest-api-3-project-projectIdOrKey-component-get) resource if you want to get a full list of components with pagination. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.

Parameters:

projectIdOrKey - The project ID or project key (case sensitive). (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<List<Component>>

getProjectComponentsPaginated

public io.reactivex.Single<PageBeanComponentWithIssueCount> getProjectComponentsPaginated(String projectIdOrKey,
                                                                                          Optional<Long> startAt,
                                                                                          Optional<Integer> maxResults,
                                                                                          Optional<String> orderBy,
                                                                                          Optional<String> query,
                                                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project components paginated Returns a [paginated](#pagination) list of all components in a project. See the [Get project components](#api-rest-api-3-project-projectIdOrKey-components-get) resource if you want to get a full list of versions without pagination. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.

Parameters:

projectIdOrKey - The project ID or project key (case sensitive). (required)

startAt - The index of the first item to return in a page of results (page offset). (optional, default to 0l)

maxResults - The maximum number of items to return per page. (optional, default to 50)

orderBy - [Order](#ordering) the results by a field: * `description` Sorts by the component description. * `issueCount` Sorts by the count of issues associated with the component. * `lead` Sorts by the user key of the component's project lead. * `name` Sorts by component name. (optional)

query - Filter the results using a literal string. Components with a matching `name` or `description` are returned (case insensitive). (optional)

restRequestEnhancer -

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

Returns:

Single<PageBeanComponentWithIssueCount>

updateComponent

public io.reactivex.Single<Component> updateComponent(String id,
                                                      Component component,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Update component Updates a component. Any fields included in the request are overwritten. If `leadAccountId` is an empty string (\"\") the component lead is removed. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the component. (required)

component - (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<Component>