public class

CommitRequest

extends Object
java.lang.Object
   ↳ com.atlassian.bitbucket.commit.CommitRequest

Class Overview

Describes a request for a single commit. If no path is provided, the specified commit will be the one returned. If a path is provided, the commit returned will be the first commit in the ancestry of the specified commit which modifies that path.

Summary

Nested Classes
class CommitRequest.Builder  
Public Methods
@Nonnull String getCommitId()
@Nullable String getPath()
Retrieves an optional path which is used to control which commit is returned.
@Nonnull Set<String> getPropertyKeys()
@Nonnull Repository getRepository()
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

@Nonnull public String getCommitId ()

Returns
  • the ID of the commit to load, which may be a branch or tag name or a commit ID

@Nullable public String getPath ()

Retrieves an optional path which is used to control which commit is returned. When a path is provided, the commit ID is used as a starting point and may not actually be the commit that ultimately gets returned. Instead, the first commit which modifies the specified path will be returned. If none of the commits in the ancestry of the starting commit modify the specified path, no commit is returned.

Returns
  • an optional path

@Nonnull public Set<String> getPropertyKeys ()

Returns
  • a set of property keys to load, which may be empty but never null (Until 4.0, this will load Commit#getAttributes() attributes as well)

@Nonnull public Repository getRepository ()

Returns
  • the repository the commit should be loaded from