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

Description

Synopsis

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

Documentation

data CodeReviewSummary Source #

Information about the summary of the code review.

See: newCodeReviewSummary smart constructor.

Constructors

CodeReviewSummary'

Fields

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.
pullRequestId :: Maybe Text
The pull request ID for the code review.
providerType :: Maybe ProviderType
The provider type of the repository association.
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 the code review.
sourceCodeType :: Maybe SourceCodeType
metricsSummary :: Maybe MetricsSummary
The statistics from the code review.
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.

Instances

Instances details

Eq CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary Methods (==) :: CodeReviewSummary -> CodeReviewSummary -> Bool # (/=) :: CodeReviewSummary -> CodeReviewSummary -> Bool #
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 #
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 #
NFData CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary Methods rnf :: CodeReviewSummary -> () #
Hashable CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary Methods hashWithSalt :: Int -> CodeReviewSummary -> Int # hash :: CodeReviewSummary -> Int #
FromJSON CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary Methods parseJSON :: Value -> Parser CodeReviewSummary # parseJSONList :: Value -> Parser [CodeReviewSummary] #
type Rep CodeReviewSummary Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.CodeReviewSummary type Rep CodeReviewSummary = D1 ('MetaData "CodeReviewSummary" "Amazonka.CodeGuruReviewer.Types.CodeReviewSummary" "libZSservicesZSamazonka-codeguru-reviewerZSamazonka-codeguru-reviewer" 'False) (C1 ('MetaCons "CodeReviewSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobState)) :: (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 "metricsSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricsSummary)) :: (S1 ('MetaSel ('Just "createdTimeStamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lastUpdatedTimeStamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

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: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:pullRequestId:CodeReviewSummary', codeReviewSummary_pullRequestId - The pull request ID for the code review.

$sel:providerType:CodeReviewSummary', codeReviewSummary_providerType - The provider type of the repository association.

$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:name:CodeReviewSummary', codeReviewSummary_name - The name of the code review.

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

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

$sel:type':CodeReviewSummary', codeReviewSummary_type - The type of the code review.

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

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

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

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

The pull request ID for the code review.

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

The provider type of the repository association.

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

The name of the code review.

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

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

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

The name of the repository.

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

The type of the code review.

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

Undocumented member.

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

The statistics from the code review.

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.