Amazonka.CodeCommit.Types.CommentsForPullRequest

Documentation

data CommentsForPullRequest

Returns information about comments on a pull request.

See: newCommentsForPullRequest smart constructor.

Constructors

CommentsForPullRequest'

Fields

• afterBlobId :: Maybe Text

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

• afterCommitId :: Maybe Text

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

• beforeBlobId :: Maybe Text

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

• beforeCommitId :: Maybe Text

  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.

• comments :: Maybe [Comment]

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

• location :: Maybe 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).

• pullRequestId :: Maybe Text

  The system-generated ID of the pull request.

• repositoryName :: Maybe Text

  The name of the repository that contains the pull request.

Instances

FromJSON CommentsForPullRequest

Defined in Amazonka.CodeCommit.Types.CommentsForPullRequest

Methods

parseJSON :: Value -> Parser CommentsForPullRequest

parseJSONList :: Value -> Parser [CommentsForPullRequest]

Generic CommentsForPullRequest

Defined in Amazonka.CodeCommit.Types.CommentsForPullRequest

Associated Types

type Rep CommentsForPullRequest :: Type -> Type

Methods

from :: CommentsForPullRequest -> Rep CommentsForPullRequest x

to :: Rep CommentsForPullRequest x -> CommentsForPullRequest

Read CommentsForPullRequest

Defined in Amazonka.CodeCommit.Types.CommentsForPullRequest

Methods

readsPrec :: Int -> ReadS CommentsForPullRequest

readList :: ReadS [CommentsForPullRequest]

readPrec :: ReadPrec CommentsForPullRequest

readListPrec :: ReadPrec [CommentsForPullRequest]

Show CommentsForPullRequest

Defined in Amazonka.CodeCommit.Types.CommentsForPullRequest

Methods

showsPrec :: Int -> CommentsForPullRequest -> ShowS

show :: CommentsForPullRequest -> String

showList :: [CommentsForPullRequest] -> ShowS

NFData CommentsForPullRequest

Defined in Amazonka.CodeCommit.Types.CommentsForPullRequest

Methods

rnf :: CommentsForPullRequest -> ()

Eq CommentsForPullRequest

Defined in Amazonka.CodeCommit.Types.CommentsForPullRequest

Methods

(==) :: CommentsForPullRequest -> CommentsForPullRequest -> Bool

(/=) :: CommentsForPullRequest -> CommentsForPullRequest -> Bool

Hashable CommentsForPullRequest

Defined in Amazonka.CodeCommit.Types.CommentsForPullRequest

Methods

hashWithSalt :: Int -> CommentsForPullRequest -> Int

hash :: CommentsForPullRequest -> Int

type Rep CommentsForPullRequest

Defined in Amazonka.CodeCommit.Types.CommentsForPullRequest

type Rep CommentsForPullRequest = D1 ('MetaData "CommentsForPullRequest" "Amazonka.CodeCommit.Types.CommentsForPullRequest" "amazonka-codecommit-2.0-974g5LOhuTPG9HgUSx02zG" 'False) (C1 ('MetaCons "CommentsForPullRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "afterBlobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "afterCommitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "beforeBlobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "beforeCommitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "comments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Comment])) :*: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Location))) :*: (S1 ('MetaSel ('Just "pullRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newCommentsForPullRequest :: CommentsForPullRequest

Create a value of CommentsForPullRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:afterBlobId:CommentsForPullRequest', commentsForPullRequest_afterBlobId - The full blob ID of the file on which you want to comment on the source commit.

$sel:afterCommitId:CommentsForPullRequest', commentsForPullRequest_afterCommitId - The full commit ID of the commit that was the tip of the source branch at the time the comment was made.

$sel:beforeBlobId:CommentsForPullRequest', commentsForPullRequest_beforeBlobId - The full blob ID of the file on which you want to comment on the destination commit.

$sel:beforeCommitId:CommentsForPullRequest', commentsForPullRequest_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.

$sel:comments:CommentsForPullRequest', commentsForPullRequest_comments - An array of comment objects. Each comment object contains information about a comment on the pull request.

$sel:location:CommentsForPullRequest', commentsForPullRequest_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).

$sel:pullRequestId:CommentsForPullRequest', commentsForPullRequest_pullRequestId - The system-generated ID of the pull request.

$sel:repositoryName:CommentsForPullRequest', commentsForPullRequest_repositoryName - The name of the repository that contains the pull request.

commentsForPullRequest_afterBlobId :: Lens' CommentsForPullRequest (Maybe Text)

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

commentsForPullRequest_afterCommitId :: Lens' CommentsForPullRequest (Maybe Text)

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

commentsForPullRequest_beforeBlobId :: Lens' CommentsForPullRequest (Maybe Text)

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

commentsForPullRequest_beforeCommitId :: Lens' CommentsForPullRequest (Maybe Text)

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.

commentsForPullRequest_comments :: Lens' CommentsForPullRequest (Maybe [Comment])

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

commentsForPullRequest_location :: Lens' CommentsForPullRequest (Maybe 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).

commentsForPullRequest_pullRequestId :: Lens' CommentsForPullRequest (Maybe Text)

The system-generated ID of the pull request.

commentsForPullRequest_repositoryName :: Lens' CommentsForPullRequest (Maybe Text)

The name of the repository that contains the pull request.