public interface

PullRequestMergeabilityPropertyProvider

com.atlassian.bitbucket.pull.PullRequestMergeabilityPropertyProvider

Class Overview

Provides properties to PullRequestMergeability.

NOTE: Property values must be convertible to JSON (e.g. extend from RestMapEntity), or otherwise REST requests to entities owning the properties will fail.

Summary

Public Methods
@Nonnull Map<String, Object> provideProperties(PullRequest pullRequest, PullRequestMergeability mergeability)
Provide properties for the provided pull request and mergeability.

Public Methods

@Nonnull public Map<String, Object> provideProperties (PullRequest pullRequest, PullRequestMergeability mergeability)

Provide properties for the provided pull request and mergeability. Plugins should prefix property keys with a unique identifier (e.g. the plugin key) to avoid conflicts.

Parameters
pullRequest the pull request
mergeability the pull request mergeability
Returns
  • a Map of properties to be added to mergeability. Can be empty, but not null.