@Deprecated public class

CommitCommentAnchorSearchRequest

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

This class is deprecated.
in 4.11 to be removed in 5.0. The Comment API is going through a maintenance cycle. For more details see the API Changelog

Class Overview

Request for searching for commit comment anchors. The purpose and behaviour of each field is described on its accessor.

Summary

Nested Classes
class CommitCommentAnchorSearchRequest.Builder  
Public Methods
@Nonnull String getCommitId()
@Nonnull Optional<String> getParentId()
This method is deprecated. in 4.10 for removal in 5.0; use getSinceId() instead
@Nonnull String getPath()
@Nonnull Optional<Long> getPullRequestId()
For comments made on a pull request commit the pull request ID can be used to identify the pull request.
@Nonnull Repository getRepository()
@Nonnull Optional<String> getSinceId()
For comments made on a range of commits on a pull request, the ID of the since commit can be used to specify which diff the anchor should be from.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

@Nonnull public String getCommitId ()

Returns
  • the ID of the commit within the repository

@Nonnull public Optional<String> getParentId ()

This method is deprecated.
in 4.10 for removal in 5.0; use getSinceId() instead

For merge commits which have diffs to multiple parents the parent ID can be used to specify which diff the anchor should be on.

Returns
  • the ID for a parent commit

@Nonnull public String getPath ()

Returns
  • the path of the file on which the anchors must be

@Nonnull public Optional<Long> getPullRequestId ()

For comments made on a pull request commit the pull request ID can be used to identify the pull request. If no ID is provided only anchors for comments which were not made on any pull request will be retrieved.

Returns
  • the ID of a pull request on which the anchor was created

@Nonnull public Repository getRepository ()

Returns
  • the repository containing the commit

@Nonnull public Optional<String> getSinceId ()

For comments made on a range of commits on a pull request, the ID of the since commit can be used to specify which diff the anchor should be from. If no ID is provided then only anchors for comments which were made on just the commit will be retrieved.

Returns
  • the ID for the since commit