libZSservicesZSamazonka-codecommitZSamazonka-codecommit
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodeCommit.Types.PullRequest

Description

 
Synopsis

Documentation

data PullRequest Source #

Returns information about a pull request.

See: newPullRequest smart constructor.

Constructors

PullRequest' 

Fields

  • approvalRules :: Maybe [ApprovalRule]

    The approval rules applied to the pull request.

  • authorArn :: Maybe Text

    The Amazon Resource Name (ARN) of the user who created the pull request.

  • pullRequestId :: Maybe Text

    The system-generated ID of the pull request.

  • creationDate :: Maybe POSIX

    The date and time the pull request was originally created, in timestamp format.

  • pullRequestStatus :: Maybe PullRequestStatusEnum

    The status of the pull request. Pull request status can only change from OPEN to CLOSED.

  • title :: Maybe Text

    The user-defined title of the pull request. This title is displayed in the list of pull requests to other repository users.

  • clientRequestToken :: Maybe Text

    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.

  • lastActivityDate :: Maybe POSIX

    The day and time of the last user or system activity on the pull request, in timestamp format.

  • revisionId :: Maybe Text

    The system-generated revision ID for the pull request.

  • pullRequestTargets :: Maybe [PullRequestTarget]

    The targets of the pull request, including the source branch and destination branch for the pull request.

  • description :: Maybe Text

    The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

Instances

Instances details
Eq PullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.Types.PullRequest

Read PullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.Types.PullRequest

Show PullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.Types.PullRequest

Generic PullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.Types.PullRequest

Associated Types

type Rep PullRequest :: Type -> Type #

NFData PullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.Types.PullRequest

Methods

rnf :: PullRequest -> () #

Hashable PullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.Types.PullRequest

FromJSON PullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.Types.PullRequest

type Rep PullRequest Source # 
Instance details

Defined in Amazonka.CodeCommit.Types.PullRequest

type Rep PullRequest = D1 ('MetaData "PullRequest" "Amazonka.CodeCommit.Types.PullRequest" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "PullRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "approvalRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApprovalRule])) :*: S1 ('MetaSel ('Just "authorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "pullRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "pullRequestStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PullRequestStatusEnum))))) :*: ((S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastActivityDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "revisionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pullRequestTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PullRequestTarget])) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newPullRequest :: PullRequest Source #

Create a value of PullRequest 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:approvalRules:PullRequest', pullRequest_approvalRules - The approval rules applied to the pull request.

$sel:authorArn:PullRequest', pullRequest_authorArn - The Amazon Resource Name (ARN) of the user who created the pull request.

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

$sel:creationDate:PullRequest', pullRequest_creationDate - The date and time the pull request was originally created, in timestamp format.

$sel:pullRequestStatus:PullRequest', pullRequest_pullRequestStatus - The status of the pull request. Pull request status can only change from OPEN to CLOSED.

$sel:title:PullRequest', pullRequest_title - The user-defined title of the pull request. This title is displayed in the list of pull requests to other repository users.

$sel:clientRequestToken:PullRequest', pullRequest_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.

$sel:lastActivityDate:PullRequest', pullRequest_lastActivityDate - The day and time of the last user or system activity on the pull request, in timestamp format.

$sel:revisionId:PullRequest', pullRequest_revisionId - The system-generated revision ID for the pull request.

$sel:pullRequestTargets:PullRequest', pullRequest_pullRequestTargets - The targets of the pull request, including the source branch and destination branch for the pull request.

$sel:description:PullRequest', pullRequest_description - The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

pullRequest_approvalRules :: Lens' PullRequest (Maybe [ApprovalRule]) Source #

The approval rules applied to the pull request.

pullRequest_authorArn :: Lens' PullRequest (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user who created the pull request.

pullRequest_pullRequestId :: Lens' PullRequest (Maybe Text) Source #

The system-generated ID of the pull request.

pullRequest_creationDate :: Lens' PullRequest (Maybe UTCTime) Source #

The date and time the pull request was originally created, in timestamp format.

pullRequest_pullRequestStatus :: Lens' PullRequest (Maybe PullRequestStatusEnum) Source #

The status of the pull request. Pull request status can only change from OPEN to CLOSED.

pullRequest_title :: Lens' PullRequest (Maybe Text) Source #

The user-defined title of the pull request. This title is displayed in the list of pull requests to other repository users.

pullRequest_clientRequestToken :: Lens' PullRequest (Maybe Text) Source #

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.

pullRequest_lastActivityDate :: Lens' PullRequest (Maybe UTCTime) Source #

The day and time of the last user or system activity on the pull request, in timestamp format.

pullRequest_revisionId :: Lens' PullRequest (Maybe Text) Source #

The system-generated revision ID for the pull request.

pullRequest_pullRequestTargets :: Lens' PullRequest (Maybe [PullRequestTarget]) Source #

The targets of the pull request, including the source branch and destination branch for the pull request.

pullRequest_description :: Lens' PullRequest (Maybe Text) Source #

The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.