public class

FileEditHookRequest

extends AbstractRepositoryHookRequest
java.lang.Object
   ↳ com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest
     ↳ com.atlassian.bitbucket.content.FileEditHookRequest

Class Overview

Request that is provided to repository-hook plugin modules when a file is edited.

See Also

Summary

Nested Classes
class FileEditHookRequest.Builder  
Public Methods
@Nonnull Branch getBranch()
@Nonnull InputSupplier<InputStream> getContent()
@Nonnull Optional<String> getMessage()
@Nonnull String getPath()
@Nonnull Collection<RefChange> getRefChanges()
@Nonnull Optional<String> getSourceCommitId()
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest
From class java.lang.Object
From interface com.atlassian.bitbucket.hook.repository.RepositoryHookRequest

Public Methods

@Nonnull public Branch getBranch ()

Returns
  • the branch on which the edit operation would happen

@Nonnull public InputSupplier<InputStream> getContent ()

Returns
  • a supplier providing access to the file content

@Nonnull public Optional<String> getMessage ()

Returns

@Nonnull public String getPath ()

Returns
  • the path of the edited or created file

@Nonnull public Collection<RefChange> getRefChanges ()

@Nonnull public Optional<String> getSourceCommitId ()

Returns
  • the commit ID of the existing file in the repository, or Optional#empty if this is a new file