public class

CommitsRequest

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

Class Overview

Defines a request to retrieve commits which are ancestors of a given starting commit.

Summary

Nested Classes
class CommitsRequest.Builder  
Constants
int UNLIMITED_MESSAGE_SIZE This constant is deprecated. in 4.6 for removal in 5.0. Use UNLIMITED_MESSAGE_LENGTH instead.
[Expand]
Inherited Constants
From class com.atlassian.bitbucket.commit.AbstractCommitsRequest
Public Methods
@Nonnull String getCommitId()
int getMaxMessageLength()
@Nonnull Set<String> getPaths()
Retrieves paths, which may identify directories or files within the repository, which are used to limit returned commits.
@Nonnull Set<String> getPropertyKeys()
Retrieves the keys of index properties to load for returned commits.
@Nonnull Repository getRepository()
boolean isFollowingRenames()
Whether or not the commit history will attempt to follow renames.
@Deprecated @Nullable Boolean isIgnoringMissing()
This method is deprecated. in 4.5. This return type will change to boolean in 5.0.
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.commit.AbstractCommitsRequest
From class java.lang.Object

Constants

public static final int UNLIMITED_MESSAGE_SIZE

This constant is deprecated.
in 4.6 for removal in 5.0. Use UNLIMITED_MESSAGE_LENGTH instead.

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

@Nonnull public Set<String> getPaths ()

Retrieves paths, which may identify directories or files within the repository, which are used to limit returned commits. When multiple paths are provided, commits which modify any of the specified paths may be returned.

Returns
  • a set containing zero or more paths

@Nonnull public Set<String> getPropertyKeys ()

Retrieves the keys of index properties to load for returned commits.

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

@Nonnull public Repository getRepository ()

Returns
  • the repository the commits 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 @Nullable 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.