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

Class ProjectRoleActorsApi

java.lang.Object

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

public class ProjectRoleActorsApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<ProjectRole>	addActorUsers(String projectIdOrKey, Long id, ActorsMap actorsMap, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add actors to project role Adds actors to a project role for the project.
io.reactivex.Single<ProjectRole>	addProjectRoleActorsToRole(Long id, ActorInputBean actorInputBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add default actors to project role Adds [default actors](#api-rest-api-2-resolution-get) to a role.
io.reactivex.Completable	deleteActor(String projectIdOrKey, Long id, Optional<String> user, Optional<String> group, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete actors from project role Deletes actors from a project role for the project.
io.reactivex.Single<ProjectRole>	deleteProjectRoleActorsFromRole(Long id, Optional<String> user, Optional<String> group, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete default actors from project role Deletes the [default actors](#api-rest-api-2-resolution-get) from a project role.
io.reactivex.Single<ProjectRole>	getProjectRoleActorsForRole(Long id, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get default actors for project role Returns the [default actors](#api-rest-api-2-resolution-get) for the project role.
io.reactivex.Single<ProjectRole>	setActors(String projectIdOrKey, Long id, ProjectRoleActorsUpdateBean projectRoleActorsUpdateBean, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set actors for project role Sets the actors for a project role for a project, replacing all existing actors.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectRoleActorsApi

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

Method Detail

addActorUsers

public io.reactivex.Single<ProjectRole> addActorUsers(String projectIdOrKey,
                                                      Long id,
                                                      ActorsMap actorsMap,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add actors to project role Adds actors to a project role for the project. To replace all actors for the project, use [Set actors for project role](#api-rest-api-2-project-projectIdOrKey-role-id-put). This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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

id - The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. (required)

actorsMap - The groups or users to associate with the project role for this project. Provide the user account ID or group name. (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<ProjectRole>

addProjectRoleActorsToRole

public io.reactivex.Single<ProjectRole> addProjectRoleActorsToRole(Long id,
                                                                   ActorInputBean actorInputBean,
                                                                   Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add default actors to project role Adds [default actors](#api-rest-api-2-resolution-get) to a role. You may add groups or users, but you cannot add groups and users in the same request. Changing a project role's default actors does not affect project role members for projects already created. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. (required)

actorInputBean - (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<ProjectRole>

deleteActor

public io.reactivex.Completable deleteActor(String projectIdOrKey,
                                            Long id,
                                            Optional<String> user,
                                            Optional<String> group,
                                            Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete actors from project role Deletes actors from a project role for the project. To remove default actors from the project role, use [Delete default actors from project role](#api-rest-api-2-role-id-actors-delete). This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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

id - The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. (required)

user - The user account ID of the user to remove from the project role. (optional)

group - The name of the group to remove from the project role. (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

deleteProjectRoleActorsFromRole

public io.reactivex.Single<ProjectRole> deleteProjectRoleActorsFromRole(Long id,
                                                                        Optional<String> user,
                                                                        Optional<String> group,
                                                                        Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete default actors from project role Deletes the [default actors](#api-rest-api-2-resolution-get) from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request. Changing a project role's default actors does not affect project role members for projects already created. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. (required)

user - The user account ID of the user to remove as a default actor. (optional)

group - The group name of the group to be removed as a default actor. (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<ProjectRole>

getProjectRoleActorsForRole

public io.reactivex.Single<ProjectRole> getProjectRoleActorsForRole(Long id,
                                                                    Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get default actors for project role Returns the [default actors](#api-rest-api-2-resolution-get) for the project role. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

id - The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. (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<ProjectRole>

setActors

public io.reactivex.Single<ProjectRole> setActors(String projectIdOrKey,
                                                  Long id,
                                                  ProjectRoleActorsUpdateBean projectRoleActorsUpdateBean,
                                                  Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set actors for project role Sets the actors for a project role for a project, replacing all existing actors. To add actors to the project without overwriting the existing list, use [Add actors to project role](#api-rest-api-2-project-projectIdOrKey-role-id-post). **[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

Parameters:

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

id - The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role IDs. (required)

projectRoleActorsUpdateBean - The groups or users to associate with the project role for this project. Provide the user account ID or group name. (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<ProjectRole>