amazonka-codeguru-reviewer-2.0: Amazon CodeGuru Reviewer SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeGuruReviewer.Types.RequestMetadata

Description

 
Synopsis

Documentation

data RequestMetadata Source #

Metadata that is associated with a code review. This applies to both pull request and repository analysis code reviews.

See: newRequestMetadata smart constructor.

Constructors

RequestMetadata' 

Fields

  • eventInfo :: Maybe EventInfo

    Information about the event associated with a code review.

  • requestId :: Maybe Text

    The ID of the request. This is required for a pull request code review.

  • requester :: Maybe Text

    An identifier, such as a name or account ID, that is associated with the requester. The Requester is used to capture the author/actor name of the event request.

  • vendorName :: Maybe VendorName

    The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation.

Instances

Instances details
FromJSON RequestMetadata Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.Types.RequestMetadata

ToJSON RequestMetadata Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.Types.RequestMetadata

Generic RequestMetadata Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.Types.RequestMetadata

Associated Types

type Rep RequestMetadata :: Type -> Type #

Read RequestMetadata Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.Types.RequestMetadata

Show RequestMetadata Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.Types.RequestMetadata

NFData RequestMetadata Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.Types.RequestMetadata

Methods

rnf :: RequestMetadata -> () #

Eq RequestMetadata Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.Types.RequestMetadata

Hashable RequestMetadata Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.Types.RequestMetadata

type Rep RequestMetadata Source # 
Instance details

Defined in Amazonka.CodeGuruReviewer.Types.RequestMetadata

type Rep RequestMetadata = D1 ('MetaData "RequestMetadata" "Amazonka.CodeGuruReviewer.Types.RequestMetadata" "amazonka-codeguru-reviewer-2.0-5PMDLaQhmT9HEhVpSUty9z" 'False) (C1 ('MetaCons "RequestMetadata'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eventInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventInfo)) :*: S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "requester") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vendorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VendorName)))))

newRequestMetadata :: RequestMetadata Source #

Create a value of RequestMetadata 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:eventInfo:RequestMetadata', requestMetadata_eventInfo - Information about the event associated with a code review.

$sel:requestId:RequestMetadata', requestMetadata_requestId - The ID of the request. This is required for a pull request code review.

$sel:requester:RequestMetadata', requestMetadata_requester - An identifier, such as a name or account ID, that is associated with the requester. The Requester is used to capture the author/actor name of the event request.

$sel:vendorName:RequestMetadata', requestMetadata_vendorName - The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation.

requestMetadata_eventInfo :: Lens' RequestMetadata (Maybe EventInfo) Source #

Information about the event associated with a code review.

requestMetadata_requestId :: Lens' RequestMetadata (Maybe Text) Source #

The ID of the request. This is required for a pull request code review.

requestMetadata_requester :: Lens' RequestMetadata (Maybe Text) Source #

An identifier, such as a name or account ID, that is associated with the requester. The Requester is used to capture the author/actor name of the event request.

requestMetadata_vendorName :: Lens' RequestMetadata (Maybe VendorName) Source #

The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation.