Interface CommentsForPullRequest.Builder

    • Method Detail

      • pullRequestId

        CommentsForPullRequest.Builder pullRequestId​(String pullRequestId)

        The system-generated ID of the pull request.

        Parameters:
        pullRequestId - The system-generated ID of the pull request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • repositoryName

        CommentsForPullRequest.Builder repositoryName​(String repositoryName)

        The name of the repository that contains the pull request.

        Parameters:
        repositoryName - The name of the repository that contains the pull request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • beforeCommitId

        CommentsForPullRequest.Builder beforeCommitId​(String beforeCommitId)

        The full commit ID of the commit that was the tip of the destination branch when the pull request was created. This commit is superceded by the after commit in the source branch when and if you merge the source branch into the destination branch.

        Parameters:
        beforeCommitId - The full commit ID of the commit that was the tip of the destination branch when the pull request was created. This commit is superceded by the after commit in the source branch when and if you merge the source branch into the destination branch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • afterCommitId

        CommentsForPullRequest.Builder afterCommitId​(String afterCommitId)

        The full commit ID of the commit that was the tip of the source branch at the time the comment was made.

        Parameters:
        afterCommitId - The full commit ID of the commit that was the tip of the source branch at the time the comment was made.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • beforeBlobId

        CommentsForPullRequest.Builder beforeBlobId​(String beforeBlobId)

        The full blob ID of the file on which you want to comment on the destination commit.

        Parameters:
        beforeBlobId - The full blob ID of the file on which you want to comment on the destination commit.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • afterBlobId

        CommentsForPullRequest.Builder afterBlobId​(String afterBlobId)

        The full blob ID of the file on which you want to comment on the source commit.

        Parameters:
        afterBlobId - The full blob ID of the file on which you want to comment on the source commit.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • location

        CommentsForPullRequest.Builder location​(Location location)

        Location information about the comment on the pull request, including the file name, line number, and whether the version of the file where the comment was made is BEFORE (destination branch) or AFTER (source branch).

        Parameters:
        location - Location information about the comment on the pull request, including the file name, line number, and whether the version of the file where the comment was made is BEFORE (destination branch) or AFTER (source branch).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • comments

        CommentsForPullRequest.Builder comments​(Collection<Comment> comments)

        An array of comment objects. Each comment object contains information about a comment on the pull request.

        Parameters:
        comments - An array of comment objects. Each comment object contains information about a comment on the pull request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • comments

        CommentsForPullRequest.Builder comments​(Comment... comments)

        An array of comment objects. Each comment object contains information about a comment on the pull request.

        Parameters:
        comments - An array of comment objects. Each comment object contains information about a comment on the pull request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • comments

        CommentsForPullRequest.Builder comments​(Consumer<Comment.Builder>... comments)

        An array of comment objects. Each comment object contains information about a comment on the pull request.

        This is a convenience method that creates an instance of the Comment.Builder avoiding the need to create one manually via Comment.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #comments(List).

        Parameters:
        comments - a consumer that will call methods on Comment.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #comments(java.util.Collection)