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.CodeReviewSummary

Description

Synopsis

data CodeReviewSummary = CodeReviewSummary' {
- codeReviewArn :: Maybe Text
- createdTimeStamp :: Maybe POSIX
- lastUpdatedTimeStamp :: Maybe POSIX
- metricsSummary :: Maybe MetricsSummary
- name :: Maybe Text
- owner :: Maybe Text
- providerType :: Maybe ProviderType
- pullRequestId :: Maybe Text
- repositoryName :: Maybe Text
- sourceCodeType :: Maybe SourceCodeType
- state :: Maybe JobState
- type' :: Maybe Type
}
newCodeReviewSummary :: CodeReviewSummary
codeReviewSummary_codeReviewArn :: Lens' CodeReviewSummary (Maybe Text)
codeReviewSummary_createdTimeStamp :: Lens' CodeReviewSummary (Maybe UTCTime)
codeReviewSummary_lastUpdatedTimeStamp :: Lens' CodeReviewSummary (Maybe UTCTime)
codeReviewSummary_metricsSummary :: Lens' CodeReviewSummary (Maybe MetricsSummary)
codeReviewSummary_name :: Lens' CodeReviewSummary (Maybe Text)
codeReviewSummary_owner :: Lens' CodeReviewSummary (Maybe Text)
codeReviewSummary_providerType :: Lens' CodeReviewSummary (Maybe ProviderType)
codeReviewSummary_pullRequestId :: Lens' CodeReviewSummary (Maybe Text)
codeReviewSummary_repositoryName :: Lens' CodeReviewSummary (Maybe Text)
codeReviewSummary_sourceCodeType :: Lens' CodeReviewSummary (Maybe SourceCodeType)
codeReviewSummary_state :: Lens' CodeReviewSummary (Maybe JobState)
codeReviewSummary_type :: Lens' CodeReviewSummary (Maybe Type)

Documentation

data CodeReviewSummary Source #

Information about the summary of the code review.

See: newCodeReviewSummary smart constructor.

Constructors

CodeReviewSummary'

Fields

codeReviewArn :: Maybe Text
The Amazon Resource Name (ARN) of the CodeReview object.
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.
metricsSummary :: Maybe MetricsSummary
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 provider type of the repository association.
pullRequestId :: Maybe Text
The pull request ID for the code review.
repositoryName :: Maybe Text
The name of the repository.
sourceCodeType :: Maybe SourceCodeType
state :: Maybe JobState
The state of the code review.
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.
type' :: Maybe Type
The type of the code review.

Instances

Instances details

FromJSON CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary Methods parseJSON :: Value -> Parser CodeReviewSummary # parseJSONList :: Value -> Parser [CodeReviewSummary] #
Generic CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary Associated Types type Rep CodeReviewSummary :: Type -> Type # Methods from :: CodeReviewSummary -> Rep CodeReviewSummary x # to :: Rep CodeReviewSummary x -> CodeReviewSummary #
Read CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary Methods readsPrec :: Int -> ReadS CodeReviewSummary # readList :: ReadS [CodeReviewSummary] # readPrec :: ReadPrec CodeReviewSummary # readListPrec :: ReadPrec [CodeReviewSummary] #
Show CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary Methods showsPrec :: Int -> CodeReviewSummary -> ShowS # show :: CodeReviewSummary -> String # showList :: [CodeReviewSummary] -> ShowS #
NFData CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary Methods rnf :: CodeReviewSummary -> () #
Eq CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary Methods (==) :: CodeReviewSummary -> CodeReviewSummary -> Bool # (/=) :: CodeReviewSummary -> CodeReviewSummary -> Bool #
Hashable CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary Methods hashWithSalt :: Int -> CodeReviewSummary -> Int # hash :: CodeReviewSummary -> Int #
type Rep CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary type Rep CodeReviewSummary = D1 ('MetaData "CodeReviewSummary" "Amazonka.CodeGuruReviewer.Types.CodeReviewSummary" "amazonka-codeguru-reviewer-2.0-5PMDLaQhmT9HEhVpSUty9z" 'False) (C1 ('MetaCons "CodeReviewSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "codeReviewArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "createdTimeStamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "lastUpdatedTimeStamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "metricsSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricsSummary)) :: (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 "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Type)))))))

newCodeReviewSummary :: CodeReviewSummary Source #

Create a value of CodeReviewSummary 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:codeReviewArn:CodeReviewSummary', codeReviewSummary_codeReviewArn - The Amazon Resource Name (ARN) of the CodeReview object.

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

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

$sel:metricsSummary:CodeReviewSummary', codeReviewSummary_metricsSummary - The statistics from the code review.

$sel:name:CodeReviewSummary', codeReviewSummary_name - The name of the code review.

$sel:owner:CodeReviewSummary', codeReviewSummary_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:CodeReviewSummary', codeReviewSummary_providerType - The provider type of the repository association.

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

$sel:repositoryName:CodeReviewSummary', codeReviewSummary_repositoryName - The name of the repository.

$sel:sourceCodeType:CodeReviewSummary', codeReviewSummary_sourceCodeType - Undocumented member.

$sel:state:CodeReviewSummary', codeReviewSummary_state - The state of the code review.

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:type':CodeReviewSummary', codeReviewSummary_type - The type of the code review.

codeReviewSummary_codeReviewArn :: Lens' CodeReviewSummary (Maybe Text) Source #

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

codeReviewSummary_createdTimeStamp :: Lens' CodeReviewSummary (Maybe UTCTime) Source #

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

codeReviewSummary_lastUpdatedTimeStamp :: Lens' CodeReviewSummary (Maybe UTCTime) Source #

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

codeReviewSummary_metricsSummary :: Lens' CodeReviewSummary (Maybe MetricsSummary) Source #

The statistics from the code review.

codeReviewSummary_name :: Lens' CodeReviewSummary (Maybe Text) Source #

The name of the code review.

codeReviewSummary_owner :: Lens' CodeReviewSummary (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.

codeReviewSummary_providerType :: Lens' CodeReviewSummary (Maybe ProviderType) Source #

The provider type of the repository association.

codeReviewSummary_pullRequestId :: Lens' CodeReviewSummary (Maybe Text) Source #

The pull request ID for the code review.

codeReviewSummary_repositoryName :: Lens' CodeReviewSummary (Maybe Text) Source #

The name of the repository.

codeReviewSummary_sourceCodeType :: Lens' CodeReviewSummary (Maybe SourceCodeType) Source #

Undocumented member.

codeReviewSummary_state :: Lens' CodeReviewSummary (Maybe JobState) Source #

The state of the code review.

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.

codeReviewSummary_type :: Lens' CodeReviewSummary (Maybe Type) Source #

The type of the code review.