Copyright	(c) 2013-2021 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

Amazonka.CodeGuruReviewer.Types.CodeReview

Description

Synopsis

data CodeReview = CodeReview' {
- associationArn :: Maybe Text
- state :: Maybe JobState
- metrics :: Maybe Metrics
- pullRequestId :: Maybe Text
- providerType :: Maybe ProviderType
- owner :: Maybe Text
- name :: Maybe Text
- codeReviewArn :: Maybe Text
- repositoryName :: Maybe Text
- type' :: Maybe Type
- sourceCodeType :: Maybe SourceCodeType
- stateReason :: Maybe Text
- createdTimeStamp :: Maybe POSIX
- analysisTypes :: Maybe [AnalysisType]
- lastUpdatedTimeStamp :: Maybe POSIX
}
newCodeReview :: CodeReview
codeReview_associationArn :: Lens' CodeReview (Maybe Text)
codeReview_state :: Lens' CodeReview (Maybe JobState)
codeReview_metrics :: Lens' CodeReview (Maybe Metrics)
codeReview_pullRequestId :: Lens' CodeReview (Maybe Text)
codeReview_providerType :: Lens' CodeReview (Maybe ProviderType)
codeReview_owner :: Lens' CodeReview (Maybe Text)
codeReview_name :: Lens' CodeReview (Maybe Text)
codeReview_codeReviewArn :: Lens' CodeReview (Maybe Text)
codeReview_repositoryName :: Lens' CodeReview (Maybe Text)
codeReview_type :: Lens' CodeReview (Maybe Type)
codeReview_sourceCodeType :: Lens' CodeReview (Maybe SourceCodeType)
codeReview_stateReason :: Lens' CodeReview (Maybe Text)
codeReview_createdTimeStamp :: Lens' CodeReview (Maybe UTCTime)
codeReview_analysisTypes :: Lens' CodeReview (Maybe [AnalysisType])
codeReview_lastUpdatedTimeStamp :: Lens' CodeReview (Maybe UTCTime)

Documentation

data CodeReview Source #

Information about a code review. A code review belongs to the associated repository that contains the reviewed code.

See: newCodeReview smart constructor.

Constructors

CodeReview'

Fields

associationArn :: Maybe Text
The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations .
state :: Maybe JobState
The valid code review states are:
- Completed: The code review is complete.
- Pending: The code review started and has not completed or failed.
- Failed: The code review failed.
- Deleting: The code review is being deleted.
metrics :: Maybe Metrics
The statistics from the code review.
pullRequestId :: Maybe Text
The pull request ID for the code review.
providerType :: Maybe ProviderType
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
owner :: Maybe Text
The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.
name :: Maybe Text
The name of the code review.
codeReviewArn :: Maybe Text
The Amazon Resource Name (ARN) of the CodeReview object.
repositoryName :: Maybe Text
The name of the repository.
type' :: Maybe Type
The type of code review.
sourceCodeType :: Maybe SourceCodeType
The type of the source code for the code review.
stateReason :: Maybe Text
The reason for the state of the code review.
createdTimeStamp :: Maybe POSIX
The time, in milliseconds since the epoch, when the code review was created.
analysisTypes :: Maybe [AnalysisType]
They types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
lastUpdatedTimeStamp :: Maybe POSIX
The time, in milliseconds since the epoch, when the code review was last updated.

Instances

Instances details

Eq CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview Methods (==) :: CodeReview -> CodeReview -> Bool # (/=) :: CodeReview -> CodeReview -> Bool #
Read CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview Methods readsPrec :: Int -> ReadS CodeReview # readList :: ReadS [CodeReview] # readPrec :: ReadPrec CodeReview # readListPrec :: ReadPrec [CodeReview] #
Show CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview Methods showsPrec :: Int -> CodeReview -> ShowS # show :: CodeReview -> String # showList :: [CodeReview] -> ShowS #
Generic CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview Associated Types type Rep CodeReview :: Type -> Type # Methods from :: CodeReview -> Rep CodeReview x # to :: Rep CodeReview x -> CodeReview #
NFData CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview Methods rnf :: CodeReview -> () #
Hashable CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview Methods hashWithSalt :: Int -> CodeReview -> Int # hash :: CodeReview -> Int #
FromJSON CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview Methods parseJSON :: Value -> Parser CodeReview # parseJSONList :: Value -> Parser [CodeReview] #
type Rep CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview type Rep CodeReview = D1 ('MetaData "CodeReview" "Amazonka.CodeGuruReviewer.Types.CodeReview" "libZSservicesZSamazonka-codeguru-reviewerZSamazonka-codeguru-reviewer" 'False) (C1 ('MetaCons "CodeReview'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "associationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobState)) :: S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Metrics)))) :: ((S1 ('MetaSel ('Just "pullRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "providerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProviderType))) :: (S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "codeReviewArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Type)) :: S1 ('MetaSel ('Just "sourceCodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceCodeType)))) :: ((S1 ('MetaSel ('Just "stateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createdTimeStamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "analysisTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AnalysisType])) :: S1 ('MetaSel ('Just "lastUpdatedTimeStamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newCodeReview :: CodeReview Source #

Create a value of CodeReview 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:associationArn:CodeReview', codeReview_associationArn - The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations .

$sel:state:CodeReview', codeReview_state - The valid code review states are:

Completed: The code review is complete.
Pending: The code review started and has not completed or failed.
Failed: The code review failed.
Deleting: The code review is being deleted.

$sel:metrics:CodeReview', codeReview_metrics - The statistics from the code review.

$sel:pullRequestId:CodeReview', codeReview_pullRequestId - The pull request ID for the code review.

$sel:providerType:CodeReview', codeReview_providerType - The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).

$sel:owner:CodeReview', codeReview_owner - The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.

$sel:name:CodeReview', codeReview_name - The name of the code review.

$sel:codeReviewArn:CodeReview', codeReview_codeReviewArn - The Amazon Resource Name (ARN) of the CodeReview object.

$sel:repositoryName:CodeReview', codeReview_repositoryName - The name of the repository.

$sel:type':CodeReview', codeReview_type - The type of code review.

$sel:sourceCodeType:CodeReview', codeReview_sourceCodeType - The type of the source code for the code review.

$sel:stateReason:CodeReview', codeReview_stateReason - The reason for the state of the code review.

$sel:createdTimeStamp:CodeReview', codeReview_createdTimeStamp - The time, in milliseconds since the epoch, when the code review was created.

$sel:analysisTypes:CodeReview', codeReview_analysisTypes - They types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

$sel:lastUpdatedTimeStamp:CodeReview', codeReview_lastUpdatedTimeStamp - The time, in milliseconds since the epoch, when the code review was last updated.

codeReview_associationArn :: Lens' CodeReview (Maybe Text) Source #

The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations .

codeReview_state :: Lens' CodeReview (Maybe JobState) Source #

The valid code review states are:

Completed: The code review is complete.
Pending: The code review started and has not completed or failed.
Failed: The code review failed.
Deleting: The code review is being deleted.

codeReview_metrics :: Lens' CodeReview (Maybe Metrics) Source #

The statistics from the code review.

codeReview_pullRequestId :: Lens' CodeReview (Maybe Text) Source #

The pull request ID for the code review.

codeReview_providerType :: Lens' CodeReview (Maybe ProviderType) Source #

The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).

codeReview_owner :: Lens' CodeReview (Maybe Text) Source #

The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.

codeReview_name :: Lens' CodeReview (Maybe Text) Source #

The name of the code review.

codeReview_codeReviewArn :: Lens' CodeReview (Maybe Text) Source #

The Amazon Resource Name (ARN) of the CodeReview object.

codeReview_repositoryName :: Lens' CodeReview (Maybe Text) Source #

The name of the repository.

codeReview_type :: Lens' CodeReview (Maybe Type) Source #

The type of code review.

codeReview_sourceCodeType :: Lens' CodeReview (Maybe SourceCodeType) Source #

The type of the source code for the code review.

codeReview_stateReason :: Lens' CodeReview (Maybe Text) Source #

The reason for the state of the code review.

codeReview_createdTimeStamp :: Lens' CodeReview (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the code review was created.

codeReview_analysisTypes :: Lens' CodeReview (Maybe [AnalysisType]) Source #

They types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

codeReview_lastUpdatedTimeStamp :: Lens' CodeReview (Maybe UTCTime) Source #

The time, in milliseconds since the epoch, when the code review was last updated.