Interface CodeReview.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CodeReview.Builder,
,CodeReview> SdkBuilder<CodeReview.Builder,
,CodeReview> SdkPojo
- Enclosing class:
CodeReview
-
Method Summary
Modifier and TypeMethodDescriptionanalysisTypes
(Collection<AnalysisType> analysisTypes) The types of analysis performed during a repository analysis or a pull request review.analysisTypes
(AnalysisType... analysisTypes) The types of analysis performed during a repository analysis or a pull request review.analysisTypesWithStrings
(String... analysisTypes) The types of analysis performed during a repository analysis or a pull request review.analysisTypesWithStrings
(Collection<String> analysisTypes) The types of analysis performed during a repository analysis or a pull request review.associationArn
(String associationArn) The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code.codeReviewArn
(String codeReviewArn) The Amazon Resource Name (ARN) of the CodeReview object.configFileState
(String configFileState) The state of theaws-codeguru-reviewer.yml
configuration file that allows the configuration of the CodeGuru Reviewer analysis.configFileState
(ConfigFileState configFileState) The state of theaws-codeguru-reviewer.yml
configuration file that allows the configuration of the CodeGuru Reviewer analysis.createdTimeStamp
(Instant createdTimeStamp) The time, in milliseconds since the epoch, when the code review was created.lastUpdatedTimeStamp
(Instant lastUpdatedTimeStamp) The time, in milliseconds since the epoch, when the code review was last updated.default CodeReview.Builder
metrics
(Consumer<Metrics.Builder> metrics) The statistics from the code review.The statistics from the code review.The name of the code review.The owner of the repository.providerType
(String providerType) The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).providerType
(ProviderType providerType) The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).pullRequestId
(String pullRequestId) The pull request ID for the code review.repositoryName
(String repositoryName) The name of the repository.default CodeReview.Builder
sourceCodeType
(Consumer<SourceCodeType.Builder> sourceCodeType) The type of the source code for the code review.sourceCodeType
(SourceCodeType sourceCodeType) The type of the source code for the code review.The valid code review states are:The valid code review states are:stateReason
(String stateReason) The reason for the state of the code review.The type of code review.The type of code review.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The name of the code review.
- Parameters:
name
- The name of the code review.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
codeReviewArn
The Amazon Resource Name (ARN) of the CodeReview object.
- Parameters:
codeReviewArn
- The Amazon Resource Name (ARN) of the CodeReview object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
repositoryName
The name of the repository.
- Parameters:
repositoryName
- The name of the repository.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
providerType
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
- Parameters:
providerType
- The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
providerType
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
- Parameters:
providerType
- The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
stateReason
The reason for the state of the code review.
- Parameters:
stateReason
- The reason for the state of the code review.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdTimeStamp
The time, in milliseconds since the epoch, when the code review was created.
- Parameters:
createdTimeStamp
- The time, in milliseconds since the epoch, when the code review was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedTimeStamp
The time, in milliseconds since the epoch, when the code review was last updated.
- Parameters:
lastUpdatedTimeStamp
- The time, in milliseconds since the epoch, when the code review was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The type of code review.
- Parameters:
type
- The type of code review.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The type of code review.
- Parameters:
type
- The type of code review.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
pullRequestId
The pull request ID for the code review.
- Parameters:
pullRequestId
- The pull request ID for the code review.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceCodeType
The type of the source code for the code review.
- Parameters:
sourceCodeType
- The type of the source code for the code review.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceCodeType
The type of the source code for the code review.
This is a convenience method that creates an instance of theSourceCodeType.Builder
avoiding the need to create one manually viaSourceCodeType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceCodeType(SourceCodeType)
.- Parameters:
sourceCodeType
- a consumer that will call methods onSourceCodeType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
associationArn
The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations.
- Parameters:
associationArn
- The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metrics
The statistics from the code review.
- Parameters:
metrics
- The statistics from the code review.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metrics
The statistics from the code review.
This is a convenience method that creates an instance of theMetrics.Builder
avoiding the need to create one manually viaMetrics.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometrics(Metrics)
.- Parameters:
metrics
- a consumer that will call methods onMetrics.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
analysisTypesWithStrings
The types of analysis performed during a repository analysis or a pull request review. You can specify either
Security
,CodeQuality
, or both.- Parameters:
analysisTypes
- The types of analysis performed during a repository analysis or a pull request review. You can specify eitherSecurity
,CodeQuality
, or both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
analysisTypesWithStrings
The types of analysis performed during a repository analysis or a pull request review. You can specify either
Security
,CodeQuality
, or both.- Parameters:
analysisTypes
- The types of analysis performed during a repository analysis or a pull request review. You can specify eitherSecurity
,CodeQuality
, or both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
analysisTypes
The types of analysis performed during a repository analysis or a pull request review. You can specify either
Security
,CodeQuality
, or both.- Parameters:
analysisTypes
- The types of analysis performed during a repository analysis or a pull request review. You can specify eitherSecurity
,CodeQuality
, or both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
analysisTypes
The types of analysis performed during a repository analysis or a pull request review. You can specify either
Security
,CodeQuality
, or both.- Parameters:
analysisTypes
- The types of analysis performed during a repository analysis or a pull request review. You can specify eitherSecurity
,CodeQuality
, or both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
configFileState
- The state of theaws-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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
configFileState
- The state of theaws-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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-