public class


extends AbstractCommitRequest
   ↳ com.atlassian.bitbucket.commit.AbstractCommitRequest
     ↳ 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.


Nested Classes
class CommitRequest.Builder  
Inherited Constants
From class com.atlassian.bitbucket.commit.AbstractCommitRequest
Public Methods
@Nonnull String getCommitId()
int getMaxMessageLength()
@Nullable String getPath()
Retrieves an optional path which is used to control which commit is returned.
@Nonnull Set<String> getPropertyKeys()
@Nonnull Repository getRepository()
Inherited Methods
From class com.atlassian.bitbucket.commit.AbstractCommitRequest
From class java.lang.Object

Public Methods

@Nonnull public String getCommitId ()


public int getMaxMessageLength ()

  • the max message length to be processed for any of the commits, which may be UNLIMITED_MESSAGE_LENGTH to include the full commit message regardless of length

@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.

  • an optional path

@Nonnull public Set<String> getPropertyKeys ()

  • a set of property keys to load, which may be empty but never null

@Nonnull public Repository getRepository ()

  • the repository the commit should be loaded from