/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.codegurureviewer; import javax.annotation.Generated; import com.amazonaws.services.codegurureviewer.model.*; /** * Interface for accessing CodeGuruReviewer asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.codegurureviewer.AbstractAmazonCodeGuruReviewerAsync} instead. *
**
* 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 and Python 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 (Amazon Web Services PrivateLink) in the Amazon CodeGuru Reviewer User Guide. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCodeGuruReviewerAsync extends AmazonCodeGuruReviewer { /** ** Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services * 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. *
** If you associate a CodeCommit or S3 repository, it must be in the same Amazon Web Services Region and Amazon Web * Services account where its CodeGuru Reviewer code reviews are configured. *
** Bitbucket and GitHub Enterprise Server repositories are managed by Amazon Web Services CodeStar Connections to * connect to CodeGuru Reviewer. For more information, see Associate a repository in the Amazon CodeGuru Reviewer User Guide. *
** You cannot use the CodeGuru Reviewer SDK or the Amazon Web Services CLI to associate a GitHub repository with * Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see Getting started * with CodeGuru Reviewer in the CodeGuru Reviewer User Guide. *
** Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services * 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. *
** If you associate a CodeCommit or S3 repository, it must be in the same Amazon Web Services Region and Amazon Web * Services account where its CodeGuru Reviewer code reviews are configured. *
** Bitbucket and GitHub Enterprise Server repositories are managed by Amazon Web Services CodeStar Connections to * connect to CodeGuru Reviewer. For more information, see Associate a repository in the Amazon CodeGuru Reviewer User Guide. *
** You cannot use the CodeGuru Reviewer SDK or the Amazon Web Services CLI to associate a GitHub repository with * Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see Getting started * with CodeGuru Reviewer in the CodeGuru Reviewer User Guide. *
*
* 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.
*
* 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.
*
* Returns the metadata associated with the code review along with its status. *
* * @param describeCodeReviewRequest * @return A Java Future containing the result of the DescribeCodeReview operation returned by the service. * @sample AmazonCodeGuruReviewerAsync.DescribeCodeReview * @see AWS API Documentation */ java.util.concurrent.Future* Returns the metadata associated with the code review along with its status. *
* * @param describeCodeReviewRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeCodeReview operation returned by the service. * @sample AmazonCodeGuruReviewerAsyncHandler.DescribeCodeReview * @see AWS API Documentation */ java.util.concurrent.Future* Describes the customer feedback for a CodeGuru Reviewer recommendation. *
* * @param describeRecommendationFeedbackRequest * @return A Java Future containing the result of the DescribeRecommendationFeedback operation returned by the * service. * @sample AmazonCodeGuruReviewerAsync.DescribeRecommendationFeedback * @see AWS API Documentation */ java.util.concurrent.Future* Describes the customer feedback for a CodeGuru Reviewer recommendation. *
* * @param describeRecommendationFeedbackRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeRecommendationFeedback operation returned by the * service. * @sample AmazonCodeGuruReviewerAsyncHandler.DescribeRecommendationFeedback * @see AWS API Documentation */ java.util.concurrent.Future* Returns a * RepositoryAssociation object that contains information about the requested repository association. *
* * @param describeRepositoryAssociationRequest * @return A Java Future containing the result of the DescribeRepositoryAssociation operation returned by the * service. * @sample AmazonCodeGuruReviewerAsync.DescribeRepositoryAssociation * @see AWS API Documentation */ java.util.concurrent.Future* Returns a * RepositoryAssociation object that contains information about the requested repository association. *
* * @param describeRepositoryAssociationRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeRepositoryAssociation operation returned by the * service. * @sample AmazonCodeGuruReviewerAsyncHandler.DescribeRepositoryAssociation * @see AWS API Documentation */ java.util.concurrent.Future* Removes the association between Amazon CodeGuru Reviewer and a repository. *
* * @param disassociateRepositoryRequest * @return A Java Future containing the result of the DisassociateRepository operation returned by the service. * @sample AmazonCodeGuruReviewerAsync.DisassociateRepository * @see AWS API Documentation */ java.util.concurrent.Future* Removes the association between Amazon CodeGuru Reviewer and a repository. *
* * @param disassociateRepositoryRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DisassociateRepository operation returned by the service. * @sample AmazonCodeGuruReviewerAsyncHandler.DisassociateRepository * @see AWS API Documentation */ java.util.concurrent.Future* Lists all the code reviews that the customer has created in the past 90 days. *
* * @param listCodeReviewsRequest * @return A Java Future containing the result of the ListCodeReviews operation returned by the service. * @sample AmazonCodeGuruReviewerAsync.ListCodeReviews * @see AWS API Documentation */ java.util.concurrent.Future* Lists all the code reviews that the customer has created in the past 90 days. *
* * @param listCodeReviewsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListCodeReviews operation returned by the service. * @sample AmazonCodeGuruReviewerAsyncHandler.ListCodeReviews * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru * Reviewer users. *
* * @param listRecommendationFeedbackRequest * @return A Java Future containing the result of the ListRecommendationFeedback operation returned by the service. * @sample AmazonCodeGuruReviewerAsync.ListRecommendationFeedback * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru * Reviewer users. *
* * @param listRecommendationFeedbackRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListRecommendationFeedback operation returned by the service. * @sample AmazonCodeGuruReviewerAsyncHandler.ListRecommendationFeedback * @see AWS API Documentation */ java.util.concurrent.Future* Returns the list of all recommendations for a completed code review. *
* * @param listRecommendationsRequest * @return A Java Future containing the result of the ListRecommendations operation returned by the service. * @sample AmazonCodeGuruReviewerAsync.ListRecommendations * @see AWS API Documentation */ java.util.concurrent.Future* Returns the list of all recommendations for a completed code review. *
* * @param listRecommendationsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListRecommendations operation returned by the service. * @sample AmazonCodeGuruReviewerAsyncHandler.ListRecommendations * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listRepositoryAssociationsRequest * @return A Java Future containing the result of the ListRepositoryAssociations operation returned by the service. * @sample AmazonCodeGuruReviewerAsync.ListRepositoryAssociations * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listRepositoryAssociationsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListRepositoryAssociations operation returned by the service. * @sample AmazonCodeGuruReviewerAsyncHandler.ListRepositoryAssociations * @see AWS API Documentation */ java.util.concurrent.Future* Returns the list of tags associated with an associated repository resource. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonCodeGuruReviewerAsync.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future* Returns the list of tags associated with an associated repository resource. *
* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonCodeGuruReviewerAsyncHandler.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future* Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different * reactions the previous feedback is overwritten. *
* * @param putRecommendationFeedbackRequest * @return A Java Future containing the result of the PutRecommendationFeedback operation returned by the service. * @sample AmazonCodeGuruReviewerAsync.PutRecommendationFeedback * @see AWS API Documentation */ java.util.concurrent.Future* Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different * reactions the previous feedback is overwritten. *
* * @param putRecommendationFeedbackRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the PutRecommendationFeedback operation returned by the service. * @sample AmazonCodeGuruReviewerAsyncHandler.PutRecommendationFeedback * @see AWS API Documentation */ java.util.concurrent.Future* Adds one or more tags to an associated repository. *
* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonCodeGuruReviewerAsync.TagResource * @see AWS * API Documentation */ java.util.concurrent.Future* Adds one or more tags to an associated repository. *
* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonCodeGuruReviewerAsyncHandler.TagResource * @see AWS * API Documentation */ java.util.concurrent.Future* Removes a tag from an associated repository. *
* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonCodeGuruReviewerAsync.UntagResource * @see AWS API Documentation */ java.util.concurrent.Future* Removes a tag from an associated repository. *
* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonCodeGuruReviewerAsyncHandler.UntagResource * @see AWS API Documentation */ java.util.concurrent.Future