public class

CommitsRequest

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

Summary

Nested Classes
class CommitsRequest.Builder  
Constants
int UNLIMITED_MESSAGE_SIZE
Public Methods
@Nonnull String getCommitId()
int getMaxMessageLength()
@Nonnull Set<String> getPaths()
Retrieves an optional path which is used to control which commit is returned.
@Nonnull Set<String> getPropertyKeys()
@Nonnull Repository getRepository()
boolean isFollowingRenames()
Whether or not the commit history will attempt to follow renames.
@Deprecated Boolean isIgnoringMissing()
This method is deprecated. in 4.5. This return type will change to boolean in 5.0.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int UNLIMITED_MESSAGE_SIZE

Constant Value: -1 (0xffffffff)

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

public int getMaxMessageLength ()

Returns
  • the maximum length of a commit message. -1 for unlimited length

@Nonnull public Set<String> getPaths ()

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.

@Nonnull public Repository getRepository ()

Returns
  • the repository the commit should be loaded from

public boolean isFollowingRenames ()

Whether or not the commit history will attempt to follow renames. This is only applicable for individual file paths

Returns
  • true if renames are followed, false otherwise

@Deprecated public Boolean isIgnoringMissing ()

This method is deprecated.
in 4.5. This return type will change to boolean in 5.0.

Returns
  • whether or not to ignore missing commits, or null to let the application figure out whether to do so.