Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodeGuruReviewer.Types.CodeReview

Description

Synopsis

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

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

analysisTypes :: Maybe [AnalysisType]
The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
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.
codeReviewArn :: Maybe Text
The Amazon Resource Name (ARN) of the CodeReview object.
configFileState :: Maybe ConfigFileState
The state of the aws-codeguru-reviewer.yml configuration file that allows the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of your repository.
createdTimeStamp :: Maybe POSIX
The time, in milliseconds since the epoch, when the code review was created.
lastUpdatedTimeStamp :: Maybe POSIX
The time, in milliseconds since the epoch, when the code review was last updated.
metrics :: Maybe Metrics
The statistics from the code review.
name :: Maybe Text
The name of the code review.
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.
providerType :: Maybe ProviderType
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
pullRequestId :: Maybe Text
The pull request ID for the code review.
repositoryName :: Maybe Text
The name of the repository.
sourceCodeType :: Maybe SourceCodeType
The type of the source code for the code review.
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.
stateReason :: Maybe Text
The reason for the state of the code review.
type' :: Maybe Type
The type of code review.

Instances

Instances details

FromJSON CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview Methods parseJSON :: Value -> Parser CodeReview # parseJSONList :: Value -> Parser [CodeReview] #
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 #
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 #
NFData CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview Methods rnf :: CodeReview -> () #
Eq CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview Methods (==) :: CodeReview -> CodeReview -> Bool # (/=) :: CodeReview -> CodeReview -> Bool #
Hashable CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview Methods hashWithSalt :: Int -> CodeReview -> Int # hash :: CodeReview -> Int #
type Rep CodeReview Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReview type Rep CodeReview = D1 ('MetaData "CodeReview" "Amazonka.CodeGuruReviewer.Types.CodeReview" "amazonka-codeguru-reviewer-2.0-5PMDLaQhmT9HEhVpSUty9z" 'False) (C1 ('MetaCons "CodeReview'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "analysisTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AnalysisType])) :: S1 ('MetaSel ('Just "associationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "codeReviewArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "configFileState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigFileState)))) :: ((S1 ('MetaSel ('Just "createdTimeStamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "lastUpdatedTimeStamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Metrics)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "providerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProviderType))) :: (S1 ('MetaSel ('Just "pullRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "sourceCodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceCodeType)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobState))) :: (S1 ('MetaSel ('Just "stateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Type)))))))

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:analysisTypes:CodeReview', codeReview_analysisTypes - The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

$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:codeReviewArn:CodeReview', codeReview_codeReviewArn - The Amazon Resource Name (ARN) of the CodeReview object.

$sel:configFileState:CodeReview', codeReview_configFileState - The state of the aws-codeguru-reviewer.yml configuration file that allows the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of your repository.

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

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

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

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

$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:providerType:CodeReview', codeReview_providerType - The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).

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

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

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

$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:stateReason:CodeReview', codeReview_stateReason - The reason for the state of the code review.

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

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

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

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_codeReviewArn :: Lens' CodeReview (Maybe Text) Source #

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

codeReview_configFileState :: Lens' CodeReview (Maybe ConfigFileState) Source #

The state of the aws-codeguru-reviewer.yml configuration file that allows the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of your repository.

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

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

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

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

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

The statistics from the code review.

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

The name of the code review.

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_providerType :: Lens' CodeReview (Maybe ProviderType) Source #

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

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

The pull request ID for the code review.

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

The name of the repository.

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

The type of the source code for the code review.

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_stateReason :: Lens' CodeReview (Maybe Text) Source #

The reason for the state of the code review.

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

The type of code review.