StashClient (stash-java-client-api 2.3.10 API)

```
public interface StashClient
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`StashClient.PullRequestDirection` the direction relative to the specified repository.
`static class`	`StashClient.PullRequestsOrder` the order to return pull requests in, either OLDEST (as in: "oldest first") or NEWEST.
`static class`	`StashClient.PullRequestStateFilter` used to filter pull requests by state.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`addProjectGroupPermission(String projectKey, String groupName, ProjectPermission permission)` Sets Permissions for the given group
`boolean`	`addProjectUserPermission(String projectKey, String userName, ProjectPermission permission)` Sets Permissions for the given user
`Comment`	`addPullRequestGeneralComment(String projectKey, String repositorySlug, long pullRequestId, String text)` adds general comment to a pull request
`boolean`	`addRepositoryKey(String projectKey, String repositorySlug, String publicKey, String keyLabel, Permission keyPermission)` Adds to the repository a new access key (SSH public key) with given permission
`boolean`	`addRepositoryUserPermission(String projectKey, String repositorySlug, String userName, Permission permission)` Sets permission for specified user on specified repository.
`Task`	`addTask(TaskAnchor anchor, String text)` Create new task
`boolean`	`addUserKey(String publicKey, String keyLabel)` Adds to current user a new access key (SSH public key)
`PullRequestMergeability`	`canMergePullRequest(String projectKey, String repositorySlug, long pullRequestId)` Test whether a pull request can be merged.
`boolean`	`createCodeAnnotations(String projectKey, String repositorySlug, String revision, String reportKey, Iterable<CodeAnnotation> codeAnnotations)` Creates multiple code annotations for a given code insights report.
`boolean`	`createProject(String projectKey, String name, String type, String description)` Adds a project
`default PullRequestStatus`	`createPullRequest(String title, String description, PullRequestRef fromRef, PullRequestRef toRef, Iterable<String> reviewers)` Creates a new pull request between two branches.
`PullRequestStatus`	`createPullRequest(String title, String description, PullRequestRef fromRef, PullRequestRef toRef, Iterable<String> reviewers, AvatarRequest avatarRequest)` Creates a new pull request between two branches.
`Report`	`createReport(String projectKey, String repositorySlug, String revision, Report report)` Create a code insights report for a given revision in a repository.
`boolean`	`createRepository(String projectKey, String name, String scmId, boolean forkable)` Adds a repository to project
`void`	`deleteCodeAnnotation(String projectKey, String repositorySlug, String revision, String reportKey, String externalId)` Deletes a single code annotation identified by an external Id fora given code insights report.
`void`	`deleteCodeAnnotations(String projectKey, String repositorySlug, String revision, String reportKey)` Deletes all code annotations for a given code insights report.
`boolean`	`deleteProject(String projectKey)` Deletes a project of given projectKey
`void`	`deleteReport(String projectKey, String repositorySlug, String revision, String key)` Deletes a code insights report identified by the given `key` for a given revision in a repository.
`boolean`	`deleteRepository(String projectKey, String repositorySlug)` Deletes a repository
`Repository`	`forkRepository(String sourceProjectKey, String sourceRepositorySlug, String targetProjectKey, String targetRepositorySlug)` Create a new repository forked from an existing repository.
`Page<Project>`	`getAccessibleProjects(long start, long limit)` Get a list of all projects the user can see.
`ApplicationProperties`	`getApplicationProperties()` Retrieves version information and other application properties.
`List<CodeAnnotation>`	`getCodeAnnotations(String projectKey, String repositorySlug, String revision)` Obtain a full list of code annotations for a given revision in a repository.
`Page<UserSshKey>`	`getCurrentUserKeys(long start, long limit)` Retrieves access keys (SSH public keys) for current user
`Optional<Permission>`	`getCurrentUserRepositoryPermission(String projectKey, String repositorySlug)` Retrieves user permission to given repository.
`MirrorServer`	`getMirror(String mirrorId)` Returns mirror details.
`Page<ProjectGroupPermission>`	`getProjectGroupPermissions(String projectKey, String filter, long start, long limit)` Retrieve a page of groups that have been granted at least one permission for the specified project.
`Page<Repository>`	`getProjectRepositories(String projectKey, long start, long limit)` Get a list of all repositories of a project
`Page<ProjectUserPermission>`	`getProjectUserPermissions(String projectKey, String filter, long start, long limit)` Retrieve a page of users that have been granted at least one permission for the specified project.
`default Page<PullRequestStatus>`	`getPullRequestsByRepository(String projectKey, String repositorySlug, String branchName, StashClient.PullRequestDirection direction, StashClient.PullRequestStateFilter stateFilter, StashClient.PullRequestsOrder order, long start, long limit)` Retrieve a page of pull requests to or from the specified repository.
`Page<PullRequestStatus>`	`getPullRequestsByRepository(String projectKey, String repositorySlug, String branchName, StashClient.PullRequestDirection direction, StashClient.PullRequestStateFilter stateFilter, StashClient.PullRequestsOrder order, long start, long limit, AvatarRequest avatarRequest)` Retrieve a page of pull requests to or from the specified repository.
`Optional<Report>`	`getReport(String projectKey, String repositorySlug, String revision, String key)` Obtains a code insights report identified by the given `key` for a given revision in a repository.
`Page<Report>`	`getReports(String projectKey, String repositorySlug, String revision, long start, long limit)` Obtain a paginated list of code insights report for a given revision in a repository.
`Page<Repository>`	`getRepositories(String projectName, String query, long start, long limit)` Search for repositories the user can see.
`Repository`	`getRepository(String projectKey, String repositorySlug)` Retrieve a specific repository object
`Page<Branch>`	`getRepositoryBranches(String projectKey, String repositorySlug, String query, long start, long limit)` Search for the branches for a specific repository
`Branch`	`getRepositoryDefaultBranch(String projectKey, String repositorySlug)` Retrieves default branch for a specific repository
`Page<RepositorySshKey>`	`getRepositoryKeys(String projectKey, String repositorySlug, long start, long limit)` Retrieves access keys (SSH public keys) for given repository
`Page<MirrorServer>`	`getRepositoryMirrors(long repositoryId, long start, long limit)` Returns a page of mirrors for a repository.
`Page<Tag>`	`getRepositoryTags(String projectKey, String repositorySlug, String query, long start, long limit)` Search for the tags for a specific repository
`Page<User>`	`getUsers(String filterForUsername, long start, long limit)` Retrieve a List of users.
`boolean`	`isRepositoryKey(String projectKey, String repositorySlug, String publicKey)` Checks if provided access key (SSH public key) is already registered as a repository key on Stash server
`boolean`	`isUserKey(String publicKey)` Checks if provided access key (SSH public key) is already registered as a user key on Stash server
`default PullRequestStatus`	`mergePullRequest(String projectKey, String repositorySlug, long pullRequestId, long version)` Merge specified pull request.
`PullRequestStatus`	`mergePullRequest(String projectKey, String repositorySlug, long pullRequestId, long version, AvatarRequest avatarRequest)` Merge specified pull request.
`boolean`	`projectExists(String projectKey)` Checks if the given project exists.
`boolean`	`removeUserKey(long keyId)` Removes user key by it's id
`boolean`	`removeUserKey(String publicKey)` Removes user key by key content and label
`boolean`	`updateCodeAnnotation(String projectKey, String repositorySlug, String revision, String reportKey, String externalId, CodeAnnotation codeAnnotation)` Creates or updates a single code annotation identified by an external Id for a given code insights report.
`boolean`	`updateProject(String projectKey, String newProjectKey, String name, String description)` Edits an existing project
`default Task`	`updateTask(long taskId, String text)` Updates state of a task.
`default Task`	`updateTask(long taskId, TaskState taskState)` Updates state of a task.
`Task`	`updateTask(long taskId, TaskState taskState, String text)` Updates state and/or text of a task.

Method Detail

getUsers
```
@Nonnull
Page<User> getUsers(@Nullable
                             String filterForUsername,
                             long start,
                             long limit)
```
Retrieve a List of users.

Parameters:

filterForUsername - if specified only users with usernames, display name or email addresses containing the supplied string will be returned

start - index of the first result to retrieve (for paging)

limit - total number of results to retrieve after start (for Paging)

Returns:

a page of users

getAccessibleProjects
```
@Nonnull
Page<Project> getAccessibleProjects(long start,
                                             long limit)
```
Get a list of all projects the user can see.

Parameters:

start - index of the first result to retrieve (for paging)

limit - total number of results to retrieve after start (for Paging)

Returns:

A page of Stash projects

Throws:

StashException

StashRestException

getRepositories

@Nonnull
Page<Repository> getRepositories(@Nullable
                                          String projectName,
                                          @Nullable
                                          String query,
                                          long start,
                                          long limit)

Search for repositories the user can see. Repositories contain project information.

Parameters:: projectName - optional. Filter by an individual project; query - Search term to filter repositories by; start - index of the first result to retrieve (for paging); limit - total number of results to retrieve after start (for Paging)
Returns:: A page of Stash repositories
Throws:: StashException; StashRestException

getProjectRepositories
```
@Nonnull
Page<Repository> getProjectRepositories(@Nonnull
                                                 String projectKey,
                                                 long start,
                                                 long limit)
```
Get a list of all repositories of a project

Parameters:

projectKey - repositories belong to

start - index of the first result to retrieve (for paging)

limit - total number of results to retrieve after start (for Paging)

Returns:

A page of Stash repositories

Throws:

StashException

StashRestException

getRepository

@Nullable
Repository getRepository(@Nonnull
                                   String projectKey,
                                   @Nonnull
                                   String repositorySlug)

Retrieve a specific repository object

Parameters:: projectKey - of the project the repo is in; repositorySlug - slugified version of the repo name
Returns:: A Stash repository or null if not found
Throws:: StashException; StashRestException

getRepositoryBranches

@Nonnull
Page<Branch> getRepositoryBranches(@Nonnull
                                            String projectKey,
                                            @Nonnull
                                            String repositorySlug,
                                            @Nullable
                                            String query,
                                            long start,
                                            long limit)

Search for the branches for a specific repository

Parameters:: projectKey - the repository belongs to; repositorySlug - repository (this is the slugified version of the repository name, not the raw repository name); query - search term for branch name; start - index of the first result to retrieve (for paging); limit - total number of results to retrieve after start (for Paging)
Returns:: A page of the repository branches
Throws:: StashException; StashRestException

getRepositoryTags

Page<Tag> getRepositoryTags(@Nonnull
                            String projectKey,
                            @Nonnull
                            String repositorySlug,
                            @Nullable
                            String query,
                            long start,
                            long limit)

Search for the tags for a specific repository

Parameters:: projectKey - the repository belongs to; repositorySlug - repository (this is the slugified version of the repository name, not the raw repository name); query - search term for tag name; start - index of the first result to retrieve (for paging); limit - total number of results to retrieve after start (for Paging)
Returns:: A page of the repository tags
Throws:: StashException; StashRestException

getRepositoryMirrors
```
@Nonnull
Page<MirrorServer> getRepositoryMirrors(long repositoryId,
                                                 long start,
                                                 long limit)
```
Returns a page of mirrors for a repository. This resource will return all mirrors along with authorized links to the mirror's repository REST resource. To determine if a repository is available on the mirror, the returned URL needs to be called.

Parameters:

repositoryId - repository id

start - index of the first result to retrieve (for paging)

limit - total number of results to retrieve after start (for Paging)

Returns:

A page of the repository mirrors

Throws:

StashException

StashRestException

getMirror
```
@Nullable
MirrorServer getMirror(@Nonnull
                                 String mirrorId)
```
Returns mirror details. This resource will return mirror along with authorized links to the mirror's repository REST resource.

Parameters:

mirrorId - mirror id

Returns:

A mirror details

Throws:

StashException

StashRestException

getRepositoryDefaultBranch

@Nullable
Branch getRepositoryDefaultBranch(@Nonnull
                                            String projectKey,
                                            @Nonnull
                                            String repositorySlug)

Retrieves default branch for a specific repository

Parameters:: projectKey - the repository belongs to; repositorySlug - repository (this is the slugified version of the repository name, not the raw repository name)
Returns:: repository branch

getRepositoryKeys

@Nonnull
Page<RepositorySshKey> getRepositoryKeys(@Nonnull
                                                  String projectKey,
                                                  @Nonnull
                                                  String repositorySlug,
                                                  long start,
                                                  long limit)

Retrieves access keys (SSH public keys) for given repository

Parameters:: projectKey - project key; repositorySlug - repository key; start - index of the first result to retrieve (for paging); limit - total number of results to retrieve after start (for Paging)
Returns:: A page of repository access keys
Throws:: StashException; StashRestException

addRepositoryKey

boolean addRepositoryKey(@Nonnull
                         String projectKey,
                         @Nonnull
                         String repositorySlug,
                         @Nonnull
                         String publicKey,
                         @Nullable
                         String keyLabel,
                         @Nonnull
                         Permission keyPermission)

Adds to the repository a new access key (SSH public key) with given permission

Parameters:: projectKey - project key; repositorySlug - repository key; publicKey - access key value; keyLabel - label stored with access key; keyPermission - type of permission given by public key
Returns:: true on success
Throws:: StashException; StashRestException; StashUnauthorizedRestException

isRepositoryKey
```
boolean isRepositoryKey(@Nonnull
                        String projectKey,
                        @Nonnull
                        String repositorySlug,
                        @Nonnull
                        String publicKey)
```
Checks if provided access key (SSH public key) is already registered as a repository key on Stash server

Parameters:

projectKey - project key

repositorySlug - repository key

publicKey - Access key (SSH public key) value

Returns:

true if key is already available on server, false if no key is provided or provided key is not registered as repository key on server

Throws:

StashException

StashRestException

getCurrentUserKeys
```
@Nonnull
Page<UserSshKey> getCurrentUserKeys(long start,
                                             long limit)
```
Retrieves access keys (SSH public keys) for current user

Parameters:

start - index of the first result to retrieve (for paging)

limit - total number of results to retrieve after start (for Paging)

Returns:

A page of user access keys

Throws:

StashException

StashRestException

isUserKey
```
boolean isUserKey(@Nonnull
                  String publicKey)
```
Checks if provided access key (SSH public key) is already registered as a user key on Stash server

Parameters:

publicKey - Access key (SSH public key) value

Returns:

true if key is already available on server, false if no key is provided or provided key is not registered as user key on server

Throws:

StashException

StashRestException

addUserKey
```
boolean addUserKey(@Nonnull
                   String publicKey,
                   @Nullable
                   String keyLabel)
```
Adds to current user a new access key (SSH public key)

Parameters:

publicKey - access key value

keyLabel - label stored with access key

Returns:

true on success

Throws:

StashException

StashRestException

removeUserKey
```
boolean removeUserKey(@Nonnull
                      String publicKey)
```
Removes user key by key content and label

Parameters:

publicKey - public key to remove

Returns:

true on success

removeUserKey
```
boolean removeUserKey(long keyId)
```
Removes user key by it's id

Parameters:

keyId -

Returns:

true on success

projectExists
```
boolean projectExists(@Nonnull
                      String projectKey)
```
Checks if the given project exists. If the user has insufficient permissions, an exception is thrown such that this case can be distinguished.

Parameters:

projectKey - project key to identify the project

Returns:

true if the project exists

createProject

boolean createProject(@Nonnull
                      String projectKey,
                      @Nonnull
                      String name,
                      @Nonnull
                      String type,
                      @Nonnull
                      String description)

Adds a project

Parameters:: projectKey - project key to identify the project; name - display name of the project; type - project type, can be "NORMAL" or "PERSONAL"; description - project description
Returns:: true on success

updateProject

boolean updateProject(@Nonnull
                      String projectKey,
                      @Nonnull
                      String newProjectKey,
                      @Nonnull
                      String name,
                      @Nullable
                      String description)

Edits an existing project

Parameters:: projectKey - project key to identify the project; newProjectKey - new value for project key; name - display name of the project; description - project description
Returns:: true on success

getProjectGroupPermissions

Page<ProjectGroupPermission> getProjectGroupPermissions(@Nonnull
                                                        String projectKey,
                                                        @Nullable
                                                        String filter,
                                                        long start,
                                                        long limit)

Retrieve a page of groups that have been granted at least one permission for the specified project.

Parameters:: projectKey - project key to identify the project; filter - if specified only group names containing the supplied string will be returned; start - index of the first result to retrieve (for paging); limit - total number of results to retrieve after start (for Paging)
Returns:: A Page of groups with their permissions on the project

addProjectGroupPermission

boolean addProjectGroupPermission(@Nonnull
                                  String projectKey,
                                  @Nonnull
                                  String groupName,
                                  @Nonnull
                                  ProjectPermission permission)

Sets Permissions for the given group

Parameters:: projectKey - project key to identify the project; groupName - name of the affected group; permission - permission level to set
Returns:: true on success

getProjectUserPermissions

Page<ProjectUserPermission> getProjectUserPermissions(@Nonnull
                                                      String projectKey,
                                                      @Nullable
                                                      String filter,
                                                      long start,
                                                      long limit)

Retrieve a page of users that have been granted at least one permission for the specified project.

Parameters:: projectKey - project key to identify the project; filter - if specified only user names containing the supplied string will be returned; start - index of the first result to retrieve (for paging); limit - total number of results to retrieve after start (for Paging)
Returns:: A Page of userNames with their permissions on the project

addProjectUserPermission

boolean addProjectUserPermission(@Nonnull
                                 String projectKey,
                                 @Nonnull
                                 String userName,
                                 @Nonnull
                                 ProjectPermission permission)

Sets Permissions for the given user

Parameters:: projectKey - project key to identify the project; userName - name of the affected user; permission - permission level to set
Returns:: true on success

createRepository

boolean createRepository(@Nonnull
                         String projectKey,
                         @Nonnull
                         String name,
                         @Nonnull
                         String scmId,
                         boolean forkable)

Adds a repository to project

Parameters:: projectKey - repository owning project key; name - name of the repository; forkable - true if repository should be forkable
Returns:: true on success

deleteProject
```
boolean deleteProject(@Nonnull
                      String projectKey)
```
Deletes a project of given projectKey

Parameters:

projectKey - key of the project to delete

Returns:

true on success

deleteRepository

boolean deleteRepository(@Nonnull
                         String projectKey,
                         @Nonnull
                         String repositorySlug)

Deletes a repository

Parameters:: projectKey - owning project key; repositorySlug - repository slug
Returns:: true on success

getApplicationProperties
```
@Nonnull
ApplicationProperties getApplicationProperties()
```
Retrieves version information and other application properties.

Returns:

application properties

getCurrentUserRepositoryPermission

Optional<Permission> getCurrentUserRepositoryPermission(@Nonnull
                                                        String projectKey,
                                                        @Nonnull
                                                        String repositorySlug)

Retrieves user permission to given repository. Current limitation is that we can only detect following states: - REPO_ADMIN - REPO_READ - none

Parameters:: projectKey - project key; repositorySlug - repository key
Returns:: Current user's permission for specified repository or null if user has no permissions

addRepositoryUserPermission

boolean addRepositoryUserPermission(@Nonnull
                                    String projectKey,
                                    @Nonnull
                                    String repositorySlug,
                                    @Nonnull
                                    String userName,
                                    @Nonnull
                                    Permission permission)

Sets permission for specified user on specified repository.

Parameters:: projectKey - project key to set permission on; repositorySlug - repository slug to set permission on; userName - name of the user to set permission for; permission - permission to be set
Returns:: true on success

createPullRequest

@Nonnull
PullRequestStatus createPullRequest(@Nonnull
                                             String title,
                                             @Nullable
                                             String description,
                                             @Nonnull
                                             PullRequestRef fromRef,
                                             @Nonnull
                                             PullRequestRef toRef,
                                             @Nonnull
                                             Iterable<String> reviewers,
                                             @Nullable
                                             AvatarRequest avatarRequest)

Creates a new pull request between two branches.

Parameters:: title - pull request title; description - pull request description; fromRef - reference of the branch to be merged from; toRef - reference of the branch to be merged to; reviewers - collection of reviewers, each identified by user name; avatarRequest - if provided remote Stash/Bitbucket will return avatars data as requested
Returns:: status of newly created pull request
Throws:: StashException; StashRestException

createPullRequest

@Nonnull
default PullRequestStatus createPullRequest(@Nonnull
                                                     String title,
                                                     @Nullable
                                                     String description,
                                                     @Nonnull
                                                     PullRequestRef fromRef,
                                                     @Nonnull
                                                     PullRequestRef toRef,
                                                     @Nonnull
                                                     Iterable<String> reviewers)

Creates a new pull request between two branches. No returned avatar data requested.

Parameters:: title - pull request title; description - pull request description; fromRef - reference of the branch to be merged from; toRef - reference of the branch to be merged to; reviewers - collection of reviewers, each identified by user name
Returns:: status of newly created pull request
Throws:: StashException; StashRestException

getPullRequestsByRepository

@Nonnull
Page<PullRequestStatus> getPullRequestsByRepository(@Nonnull
                                                             String projectKey,
                                                             @Nonnull
                                                             String repositorySlug,
                                                             @Nullable
                                                             String branchName,
                                                             @Nullable
                                                             StashClient.PullRequestDirection direction,
                                                             @Nullable
                                                             StashClient.PullRequestStateFilter stateFilter,
                                                             @Nullable
                                                             StashClient.PullRequestsOrder order,
                                                             long start,
                                                             long limit,
                                                             @Nullable
                                                             AvatarRequest avatarRequest)

Retrieve a page of pull requests to or from the specified repository. No returned avatar data requested.

Parameters:: projectKey - repository project key; repositorySlug - repository slug; branchName - a fully-qualified branch ID to find pull requests to or from, such as refs/heads/master. Might be null to get pull requests for every branches.; direction - the direction relative to the specified repository. Might be null.; stateFilter - Supply ALL to return pull request in any state. If a state is supplied only pull requests in the specified state will be returned. Might be null.; order - the order to return pull requests in, either OLDEST (as in: "oldest first") or NEWEST. Might be null.; start - index of the first result to retrieve (for paging); limit - total number of results to retrieve after start (for Paging); avatarRequest - if provided remote Stash/Bitbucket will return avatars data as requested
Returns:: page of pull requests matching the criteria
Throws:: StashException; StashRestException

getPullRequestsByRepository

@Nonnull
default Page<PullRequestStatus> getPullRequestsByRepository(@Nonnull
                                                                     String projectKey,
                                                                     @Nonnull
                                                                     String repositorySlug,
                                                                     @Nullable
                                                                     String branchName,
                                                                     @Nullable
                                                                     StashClient.PullRequestDirection direction,
                                                                     @Nullable
                                                                     StashClient.PullRequestStateFilter stateFilter,
                                                                     @Nullable
                                                                     StashClient.PullRequestsOrder order,
                                                                     long start,
                                                                     long limit)

Retrieve a page of pull requests to or from the specified repository. Note, as of BBS 4.10-4.12, the PullRequestStatus.getMergeOutcome() property might be missing if BBS has not yet determined the mergeability of this pull request, as only cached value is returned if exists, no actual check is being triggered by this call. In order to find out actual mergeability state consider calling canMergePullRequest(String, String, long). See also StashVersions.REPORTS_PR_MERGE_STATUS.

Parameters:: projectKey - repository project key; repositorySlug - repository slug; branchName - a fully-qualified branch ID to find pull requests to or from, such as refs/heads/master. Might be null; direction - the direction relative to the specified repository. Might be null; stateFilter - Supply ALL to return pull request in any state. If a state is supplied only pull requests in the specified state will be returned. Might be null.; order - the order to return pull requests in, either OLDEST (as in: "oldest first") or NEWEST. Might be null.; start - index of the first result to retrieve (for paging); limit - total number of results to retrieve after start (for Paging)
Returns:: page of pull requests matching the criteria
Throws:: StashException; StashRestException

mergePullRequest

@Nonnull
PullRequestStatus mergePullRequest(@Nonnull
                                            String projectKey,
                                            @Nonnull
                                            String repositorySlug,
                                            long pullRequestId,
                                            long version,
                                            @Nullable
                                            AvatarRequest avatarRequest)

Merge specified pull request.

Parameters:: projectKey - repository project key; repositorySlug - repository slug; pullRequestId - pull request id; version - pull request version, version of the data the decision to merge was based upon.; avatarRequest - if provided remote Stash/Bitbucket will return avatars data as requested
Returns:: merged pull request data if merge was successful, exception otherwise.
Throws:: StashException; StashRestException

mergePullRequest

@Nonnull
default PullRequestStatus mergePullRequest(@Nonnull
                                                    String projectKey,
                                                    @Nonnull
                                                    String repositorySlug,
                                                    long pullRequestId,
                                                    long version)

Merge specified pull request. No returned avatar data requested.

Parameters:: projectKey - repository project key; repositorySlug - repository slug; pullRequestId - pull request id; version - pull request version, version of the data the decision to merge was based upon.
Returns:: merged pull request data if merge was successful, exception otherwise.
Throws:: StashException; StashRestException

canMergePullRequest

@Nonnull
PullRequestMergeability canMergePullRequest(@Nonnull
                                                     String projectKey,
                                                     @Nonnull
                                                     String repositorySlug,
                                                     long pullRequestId)

Test whether a pull request can be merged.

Parameters:: projectKey - repository project key; repositorySlug - repository slug; pullRequestId - pull request id
Returns:: expected outcome of merge operation if one was issued.
Throws:: StashException; StashRestException

forkRepository

@Nonnull
Repository forkRepository(@Nonnull
                                   String sourceProjectKey,
                                   @Nonnull
                                   String sourceRepositorySlug,
                                   @Nonnull
                                   String targetProjectKey,
                                   @Nonnull
                                   String targetRepositorySlug)

Create a new repository forked from an existing repository.

Parameters:: sourceProjectKey - key of the project where source repository belongs to; sourceRepositorySlug - source repository to be forked from; targetProjectKey - key of the project where forked repository will be created.; targetRepositorySlug - target repositor to be created
Returns:: details of the forked repository

addPullRequestGeneralComment

@Nonnull
Comment addPullRequestGeneralComment(@Nonnull
                                              String projectKey,
                                              @Nonnull
                                              String repositorySlug,
                                              long pullRequestId,
                                              @Nonnull
                                              String text)

adds general comment to a pull request

Parameters:: projectKey - project key; repositorySlug - repository slug; pullRequestId - pull request id; text - comment text
Returns:: created comment

addTask

@Nonnull
Task addTask(@Nonnull
                      TaskAnchor anchor,
                      @Nonnull
                      String text)

Create new task

Parameters:: anchor - the anchor of the task, such as a pull request's comment; text - task text
Returns:: created task

updateTask
```
@Nonnull
Task updateTask(long taskId,
                         @Nullable
                         TaskState taskState,
                         @Nullable
                         String text)
```
Updates state and/or text of a task. At least state or text need to be provided.

Parameters:

taskId - task id

taskState - optional state, if provided it will be updated to requested value.

text - optional text, if provided task text will be updated to requested value.

Returns:

updated task.

Throws:

StashException

StashRestException

updateTask

@Nonnull
default Task updateTask(long taskId,
                                 @Nonnull
                                 TaskState taskState)

Updates state of a task.

Parameters:: taskId - task id.; taskState - desired state value.
Returns:: updated task.
Throws:: StashException; StashRestException

updateTask

@Nonnull
default Task updateTask(long taskId,
                                 @Nonnull
                                 String text)

Updates state of a task.

Parameters:: taskId - task id.; text - desired text value.
Returns:: updated task.
Throws:: StashException; StashRestException

getReports

@Nonnull
Page<Report> getReports(@Nonnull
                                 String projectKey,
                                 @Nonnull
                                 String repositorySlug,
                                 @Nonnull
                                 String revision,
                                 long start,
                                 long limit)

Obtain a paginated list of code insights report for a given revision in a repository.

Parameters:: projectKey - project key; repositorySlug - repository slug; revision - commit hash; start - pagination start (offset); limit - pagination limit (results count)
Returns:: a page of found reports

getReport

@Nonnull
Optional<Report> getReport(@Nonnull
                                    String projectKey,
                                    @Nonnull
                                    String repositorySlug,
                                    @Nonnull
                                    String revision,
                                    @Nonnull
                                    String key)

Obtains a code insights report identified by the given key for a given revision in a repository.

Parameters:: projectKey - project key; repositorySlug - repository slug; revision - commit hash; key - unique key of the report
Returns:: the report if found
See Also:: Report.getKey()

createReport

@Nonnull
Report createReport(@Nonnull
                             String projectKey,
                             @Nonnull
                             String repositorySlug,
                             @Nonnull
                             String revision,
                             @Nonnull
                             Report report)

Create a code insights report for a given revision in a repository. If a report already exists with a given key then all it's configuration will be updated.

Parameters:: projectKey - project key; repositorySlug - repository slug; revision - commit hash; report - report to create or update
Returns:: created report which may contain additional data (e.g. some defaults)

deleteReport

void deleteReport(@Nonnull
                  String projectKey,
                  @Nonnull
                  String repositorySlug,
                  @Nonnull
                  String revision,
                  @Nonnull
                  String key)

Deletes a code insights report identified by the given key for a given revision in a repository. Does nothing if the report doesn't exist.

Parameters:: projectKey - project key; repositorySlug - repository slug; revision - commit hash; key - unique key of the report
See Also:: Report.getKey()

getCodeAnnotations

@Nonnull
List<CodeAnnotation> getCodeAnnotations(@Nonnull
                                                 String projectKey,
                                                 @Nonnull
                                                 String repositorySlug,
                                                 @Nonnull
                                                 String revision)

Obtain a full list of code annotations for a given revision in a repository.

Parameters:: projectKey - project key; repositorySlug - repository slug; revision - commit hash
Returns:: complete list of code annotations from all code insights reports associated with the revision

createCodeAnnotations

boolean createCodeAnnotations(@Nonnull
                              String projectKey,
                              @Nonnull
                              String repositorySlug,
                              @Nonnull
                              String revision,
                              @Nonnull
                              String reportKey,
                              @Nonnull
                              Iterable<CodeAnnotation> codeAnnotations)

Creates multiple code annotations for a given code insights report.

Parameters:: projectKey - project key; repositorySlug - repository slug; revision - commit hash; reportKey - unique key of the report; codeAnnotations - a collection of code annotations to create
Returns:: true if annotations have been created, false when the number of annotations in the report has exceeded an allowed limit

updateCodeAnnotation

boolean updateCodeAnnotation(@Nonnull
                             String projectKey,
                             @Nonnull
                             String repositorySlug,
                             @Nonnull
                             String revision,
                             @Nonnull
                             String reportKey,
                             @Nonnull
                             String externalId,
                             @Nonnull
                             CodeAnnotation codeAnnotation)

Creates or updates a single code annotation identified by an external Id for a given code insights report.

Parameters:: projectKey - project key; repositorySlug - repository slug; revision - commit hash; reportKey - unique key of the report; externalId - external Id of the annotation; codeAnnotation - the code annotation to create or update
Returns:: true if the annotation has been created or updated, false when the number of annotations in the report has exceeded an allowed limit
See Also:: CodeAnnotation.getExternalId()

deleteCodeAnnotation

void deleteCodeAnnotation(@Nonnull
                          String projectKey,
                          @Nonnull
                          String repositorySlug,
                          @Nonnull
                          String revision,
                          @Nonnull
                          String reportKey,
                          @Nonnull
                          String externalId)

Deletes a single code annotation identified by an external Id fora given code insights report. Does nothing if an annotation does not exist.

Parameters:: projectKey - project key; repositorySlug - repository slug; revision - commit hash; reportKey - unique key of the report; externalId - external Id of the annotation
See Also:: CodeAnnotation.getExternalId()

deleteCodeAnnotations

void deleteCodeAnnotations(@Nonnull
                           String projectKey,
                           @Nonnull
                           String repositorySlug,
                           @Nonnull
                           String revision,
                           @Nonnull
                           String reportKey)

Deletes all code annotations for a given code insights report. Does nothing if no annotations exist in the report.

Parameters:: projectKey - project key; repositorySlug - repository slug; revision - commit hash; reportKey - unique key of the report

Interface StashClient

Nested Class Summary

Method Summary

Method Detail

getUsers

getAccessibleProjects

getRepositories

getProjectRepositories

getRepository

getRepositoryBranches

getRepositoryTags

getRepositoryMirrors

getMirror

getRepositoryDefaultBranch

getRepositoryKeys

addRepositoryKey

isRepositoryKey

getCurrentUserKeys

isUserKey

addUserKey

removeUserKey

removeUserKey

projectExists

createProject

updateProject

getProjectGroupPermissions

addProjectGroupPermission

getProjectUserPermissions

addProjectUserPermission

createRepository

deleteProject

deleteRepository

getApplicationProperties

getCurrentUserRepositoryPermission

addRepositoryUserPermission

createPullRequest

createPullRequest

getPullRequestsByRepository

getPullRequestsByRepository

mergePullRequest

mergePullRequest

canMergePullRequest

forkRepository

addPullRequestGeneralComment

addTask

updateTask

updateTask

updateTask

getReports

getReport

createReport

deleteReport

getCodeAnnotations

createCodeAnnotations

updateCodeAnnotation

deleteCodeAnnotation

deleteCodeAnnotations