com.atlassian.bitbucket.event.branch

Class BranchCreationHookRequest

java.lang.Object

com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest

com.atlassian.bitbucket.event.branch.BranchHookRequest

com.atlassian.bitbucket.event.branch.BranchCreationHookRequest

All Implemented Interfaces:

RepositoryHookRequest

public class BranchCreationHookRequest
extends BranchHookRequest

A hook request that is raised just before a branch is created using the UI or REST. Branches created by pushing will trigger a standard RepositoryHookRequest and not this specific type.

Since:

5.0

See Also:

StandardRepositoryHookTrigger.BRANCH_CREATE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BranchCreationHookRequest.Builder

Nested classes/interfaces inherited from class com.atlassian.bitbucket.event.branch.BranchHookRequest

BranchHookRequest.AbstractBuilder<B extends BranchHookRequest.AbstractBuilder<B>>

Method Summary

Modifier and Type	Method and Description
Collection<RefChange>	getRefChanges()

Methods inherited from class com.atlassian.bitbucket.event.branch.BranchHookRequest

getBranch

Methods inherited from class com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest

getContext, getRepository, getScmHookDetails, getTrigger, isDryRun

Methods inherited from class java.lang.Object

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

Method Detail

getRefChanges

@Nonnull
public Collection<RefChange> getRefChanges()

Specified by:

getRefChanges in interface RepositoryHookRequest

Overrides:

getRefChanges in class AbstractRepositoryHookRequest

Returns:

the proposed ref changes. Can be empty for some dry-run requests where the target hash is not yet known because the relevant commit hasn't been created yet. As an example, this is the case for merge requests. In these cases, the specialized request type should provide sufficient information about the proposed change. For MergeHookRequest, this would be MergeHookRequest.getFromRef() and MergeHookRequest.getToRef().