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

Class ComponentApi

java.lang.Object

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

public class ComponentApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ComponentApi(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<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

ComponentApi

public ComponentApi(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 required: Administer projects project permission for the project in which the component is created or Administer Jira global permission.

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 required: Administer projects project permission for the project containing the component or Administer Jira global permission.

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 required: Browse projects project permission 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 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>

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 required: Administer projects project permission for the project containing the component or Administer Jira global permission.

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>