Class PostCommentForPullRequestRequest

    • Method Detail

      • pullRequestId

        public final String pullRequestId()

        The system-generated ID of the pull request. To get this ID, use ListPullRequests.

        Returns:
        The system-generated ID of the pull request. To get this ID, use ListPullRequests.
      • repositoryName

        public final String repositoryName()

        The name of the repository where you want to post a comment on a pull request.

        Returns:
        The name of the repository where you want to post a comment on a pull request.
      • beforeCommitId

        public final String beforeCommitId()

        The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.

        Returns:
        The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.
      • afterCommitId

        public final String afterCommitId()

        The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.

        Returns:
        The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.
      • location

        public final Location location()

        The location of the change where you want to post your comment. If no location is provided, the comment is posted as a general comment on the pull request difference between the before commit ID and the after commit ID.

        Returns:
        The location of the change where you want to post your comment. If no location is provided, the comment is posted as a general comment on the pull request difference between the before commit ID and the after commit ID.
      • content

        public final String content()

        The content of your comment on the change.

        Returns:
        The content of your comment on the change.
      • clientRequestToken

        public final String clientRequestToken()

        A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.

        Returns:
        A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object