Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns comments made on a pull request.
This operation returns paginated results.
- getCommentsForPullRequest :: Text -> GetCommentsForPullRequest
- data GetCommentsForPullRequest
- gcfprAfterCommitId :: Lens' GetCommentsForPullRequest (Maybe Text)
- gcfprNextToken :: Lens' GetCommentsForPullRequest (Maybe Text)
- gcfprBeforeCommitId :: Lens' GetCommentsForPullRequest (Maybe Text)
- gcfprRepositoryName :: Lens' GetCommentsForPullRequest (Maybe Text)
- gcfprMaxResults :: Lens' GetCommentsForPullRequest (Maybe Int)
- gcfprPullRequestId :: Lens' GetCommentsForPullRequest Text
- getCommentsForPullRequestResponse :: Int -> GetCommentsForPullRequestResponse
- data GetCommentsForPullRequestResponse
- gcfprrsCommentsForPullRequestData :: Lens' GetCommentsForPullRequestResponse [CommentsForPullRequest]
- gcfprrsNextToken :: Lens' GetCommentsForPullRequestResponse (Maybe Text)
- gcfprrsResponseStatus :: Lens' GetCommentsForPullRequestResponse Int
Creating a Request
getCommentsForPullRequest Source #
Creates a value of GetCommentsForPullRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gcfprAfterCommitId
- The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made.gcfprNextToken
- An enumeration token that when provided in a request, returns the next batch of the results.gcfprBeforeCommitId
- 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.gcfprRepositoryName
- The name of the repository that contains the pull request.gcfprMaxResults
- A non-negative integer used to limit the number of returned results. The default is 100 comments. You can return up to 500 comments with a single request.gcfprPullRequestId
- The system-generated ID of the pull request. To get this ID, useListPullRequests
.
data GetCommentsForPullRequest Source #
See: getCommentsForPullRequest
smart constructor.
Request Lenses
gcfprAfterCommitId :: Lens' GetCommentsForPullRequest (Maybe Text) Source #
The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made.
gcfprNextToken :: Lens' GetCommentsForPullRequest (Maybe Text) Source #
An enumeration token that when provided in a request, returns the next batch of the results.
gcfprBeforeCommitId :: Lens' GetCommentsForPullRequest (Maybe Text) Source #
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.
gcfprRepositoryName :: Lens' GetCommentsForPullRequest (Maybe Text) Source #
The name of the repository that contains the pull request.
gcfprMaxResults :: Lens' GetCommentsForPullRequest (Maybe Int) Source #
A non-negative integer used to limit the number of returned results. The default is 100 comments. You can return up to 500 comments with a single request.
gcfprPullRequestId :: Lens' GetCommentsForPullRequest Text Source #
The system-generated ID of the pull request. To get this ID, use ListPullRequests
.
Destructuring the Response
getCommentsForPullRequestResponse Source #
Creates a value of GetCommentsForPullRequestResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gcfprrsCommentsForPullRequestData
- An array of comment objects on the pull request.gcfprrsNextToken
- An enumeration token that can be used in a request to return the next batch of the results.gcfprrsResponseStatus
- -- | The response status code.
data GetCommentsForPullRequestResponse Source #
See: getCommentsForPullRequestResponse
smart constructor.
Response Lenses
gcfprrsCommentsForPullRequestData :: Lens' GetCommentsForPullRequestResponse [CommentsForPullRequest] Source #
An array of comment objects on the pull request.
gcfprrsNextToken :: Lens' GetCommentsForPullRequestResponse (Maybe Text) Source #
An enumeration token that can be used in a request to return the next batch of the results.
gcfprrsResponseStatus :: Lens' GetCommentsForPullRequestResponse Int Source #
- - | The response status code.