com.atlassian.bitbucket.hook.repository

Interface MergeHookRequest

All Superinterfaces:

RepositoryHookRequest

All Known Subinterfaces:

PullRequestMergeHookRequest

All Known Implementing Classes:

SimpleMergeHookRequest, SimplePullRequestMergeHookRequest

public interface MergeHookRequest
extends RepositoryHookRequest

Request that is provided to repository-hook plugin modules when two branches are merged in a repository.

Since:

5.0

See Also:

StandardRepositoryHookTrigger.MERGE

Method Summary

Modifier and Type	Method and Description
RepositoryRef	getFromRef()
Optional<String>	getMergeHash()
Optional<String>	getMessage()
Optional<String>	getStrategyId()
RepositoryRef	getToRef()
boolean	isCrossRepository()

Methods inherited from interface com.atlassian.bitbucket.hook.repository.RepositoryHookRequest

getContext, getRefChanges, getRepository, getScmHookDetails, getTrigger, isDryRun

Method Detail

getFromRef

@Nonnull
RepositoryRef getFromRef()

Returns:

the branch or tag being merged into the target branch

getMergeHash

@Nonnull
Optional<String> getMergeHash()

Returns:

the merge commit hash. Can be Optional.empty() if this is a dry-run request.

getMessage

@Nonnull
Optional<String> getMessage()

Returns:

the commit message. Can be Optional.empty() if this is a dry-run request.

getStrategyId

@Nonnull
Optional<String> getStrategyId()

Returns:

the merge strategy ID

Since:

5.5

getToRef

@Nonnull
RepositoryRef getToRef()

Returns:

the target branch

isCrossRepository

boolean isCrossRepository()

Returns:

true if the from-ref and the to-ref are in different repositories, otherwise false