Package com.atlassian.bitbucket.pull.automerge

Interface AutoMergeSettingsService

public interface AutoMergeSettingsService

Service for managing pull request auto-merge settings.

Since:

8.15

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	AUTO_MERGE_GLOBAL_ENABLED	Whether auto-merge is globally enabled.

Method Summary

Modifier and Type	Method	Description
void	delete(Scope scope)	Deletes the pull request auto-merge settings associated with a particular scope.
AutoMergeSettings	getOrDefault(Scope scope)	Retrieves the pull request auto-merge settings for a particular scope.
AutoMergeSettings	set(AutoMergeSettingsCreateRequest request)	Creates or updates the pull request auto-merge settings for a particular repository scope or project scope.

Field Details

AUTO_MERGE_GLOBAL_ENABLED

static final boolean AUTO_MERGE_GLOBAL_ENABLED

Whether auto-merge is globally enabled.

See Also:

• Constant Field Values

Method Details

delete

void delete(@Nonnull
 Scope scope)

Deletes the pull request auto-merge settings associated with a particular scope.

Parameters:

scope - a repository scope or project scope

Throws:

AuthorisationException - when the currently authenticated user does not have at least admin permission for the provided scope, e.g. Permission.REPO_ADMIN for a RepositoryScope or Permission.PROJECT_ADMIN for a ProjectScope

ArgumentValidationException - if the provided scope is global scope

ForbiddenException - if the repository's project has restricted its auto-merge settings

getOrDefault

@Nonnull
AutoMergeSettings getOrDefault(@Nonnull
 Scope scope)

Retrieves the pull request auto-merge settings for a particular scope. If no settings are found, inherited settings are returned if they exist. Otherwise, global pull request auto-merge settings are returned. If the provided scope is a repository scope and the repository's project has restricted its auto-merge settings, then the project's auto-merge settings will be returned.

Parameters:

scope - a repository scope or project scope

Returns:

pull request auto-merge settings for the provided scope

Throws:

AuthorisationException - when the currently authenticated user does not have at least read permission for the provided scope, e.g. Permission.REPO_READ for a RepositoryScope or Permission.PROJECT_VIEW for a ProjectScope

set

@Nonnull
AutoMergeSettings set(@Nonnull
 AutoMergeSettingsCreateRequest request)

Creates or updates the pull request auto-merge settings for a particular repository scope or project scope.

Parameters:

request - the request containing the pull request auto-merge settings

Returns:

the created or updated pull request auto-merge settings

Throws:

AuthorisationException - when the currently authenticated user does not have at least admin permission for the provided scope, e.g. Permission.REPO_ADMIN for a RepositoryScope or Permission.PROJECT_ADMIN for a ProjectScope

ForbiddenException - if the repository's project has restricted its auto-merge settings