CodeGuruReviewer class

This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java code.

By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide.

To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by creating an interface VPC endpoint. For more information, see CodeGuru Reviewer and interface VPC endpoints (AWS PrivateLink) in the Amazon CodeGuru Reviewer User Guide.

Constructors

CodeGuruReviewer({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

associateRepository({required Repository repository, String? clientRequestToken, Map<String, String>? tags}) → Future<AssociateRepositoryResponse>
Use to associate an AWS CodeCommit repository or a repostory managed by AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see Recommendations in Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createCodeReview({required String name, required String repositoryAssociationArn, required CodeReviewType type, String? clientRequestToken}) → Future<CreateCodeReviewResponse>
Use to create a code review with a CodeReviewType of RepositoryAnalysis. This type of code review analyzes all code under a specified branch in an associated repository. PullRequest code reviews are automatically triggered by a pull request so cannot be created using this method.
describeCodeReview({required String codeReviewArn}) → Future<DescribeCodeReviewResponse>
Returns the metadata associated with the code review along with its status.
describeRecommendationFeedback({required String codeReviewArn, required String recommendationId, String? userId}) → Future<DescribeRecommendationFeedbackResponse>
Describes the customer feedback for a CodeGuru Reviewer recommendation.
describeRepositoryAssociation({required String associationArn}) → Future<DescribeRepositoryAssociationResponse>
Returns a RepositoryAssociation object that contains information about the requested repository association.
disassociateRepository({required String associationArn}) → Future<DisassociateRepositoryResponse>
Removes the association between Amazon CodeGuru Reviewer and a repository.
listCodeReviews({required Type type, int? maxResults, String? nextToken, List<ProviderType>? providerTypes, List<String>? repositoryNames, List<JobState>? states}) → Future<ListCodeReviewsResponse>
Lists all the code reviews that the customer has created in the past 90 days.
listRecommendationFeedback({required String codeReviewArn, int? maxResults, String? nextToken, List<String>? recommendationIds, List<String>? userIds}) → Future<ListRecommendationFeedbackResponse>
Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.
listRecommendations({required String codeReviewArn, int? maxResults, String? nextToken}) → Future<ListRecommendationsResponse>
Returns the list of all recommendations for a completed code review.
listRepositoryAssociations({int? maxResults, List<String>? names, String? nextToken, List<String>? owners, List<ProviderType>? providerTypes, List<RepositoryAssociationState>? states}) → Future<ListRepositoryAssociationsResponse>
Returns a list of RepositoryAssociationSummary objects that contain summary information about a repository association. You can filter the returned list by ProviderType , Name , State , and Owner .
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Returns the list of tags associated with an associated repository resource.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putRecommendationFeedback({required String codeReviewArn, required List<Reaction> reactions, required String recommendationId}) → Future<void>
Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.
tagResource({required Map<String, String> tags, required String resourceArn}) → Future<void>
Adds one or more tags to an associated repository.
toString() → String
A string representation of this object.
inherited
untagResource({required List<String> tagKeys, required String resourceArn}) → Future<void>
Removes a tag from an associated repository.

Operators

operator ==(Object other) → bool
The equality operator.
inherited