FileEditHookRequest (Bitbucket Server - API 9.6.0 API)

java.lang.Object

com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest

com.atlassian.bitbucket.content.FileEditHookRequest

All Implemented Interfaces:: RepositoryHookRequest

public class FileEditHookRequest extends AbstractRepositoryHookRequest

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

Since:

5.0

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

FileEditHookRequest.Builder

Nested classes/interfaces inherited from class com.atlassian.bitbucket.hook.repository.AbstractRepositoryHookRequest
AbstractRepositoryHookRequest.AbstractBuilder<B extends AbstractRepositoryHookRequest.AbstractBuilder<B>>
Method Summary

Modifier and Type

Method

Description

Branch

getBranch()

InputSupplier<InputStream>

getContent()

Optional<String>

getMessage()

String

getPath()

Collection<RefChange>

getRefChanges()

Optional<String>

getSourceCommitId()

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 Details
- getBranch
  
  @Nonnull public Branch getBranch()
  
  Returns:
  
  the branch on which the edit operation would happen
- getContent
  
  @Nonnull public InputSupplier<InputStream> getContent()
  
  Returns:
  
  a supplier providing access to the file content
- 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().
- getMessage
  
  @Nonnull public Optional<String> getMessage()
  
  Returns:
  
  the commit message. Can be Optional.empty() if this is a dry-run request.
- getPath
  
  @Nonnull public String getPath()
  
  Returns:
  
  the path of the edited or created file
- getSourceCommitId
  
  @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