Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/CodeGuruReviewer/Client.html below:

Client — AWS SDK for Ruby V2

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

An API client for Amazon CodeGuru Reviewer. To construct a client, you need to configure a :region and :credentials.

codegurureviewer = Aws::CodeGuruReviewer::Client.new(
  region: region_name,
  credentials: credentials,
  )

See #initialize for a full list of supported configuration options.

You can configure a default region in the following locations:

• ENV['AWS_REGION']
• Aws.config[:region]

Go here for a list of supported regions.

Default credentials are loaded automatically from the following locations:

• ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
• Aws.config[:credentials]
• The shared credentials ini file at ~/.aws/credentials (more information)
• From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

• Aws::Credentials
• SharedCredentials
• InstanceProfileCredentials
• AssumeRoleCredentials

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

creds = YAML.load(File.read('/path/to/secrets'))

Aws::CodeGuruReviewer::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

#config, #handlers

• #initialize(options = {}) ⇒ Aws::CodeGuruReviewer::Client constructor

  Constructs an API client.

• #associate_repository(options = {}) ⇒ Types::AssociateRepositoryResponse

  Use to associate an AWS CodeCommit repository or a repostory managed by AWS CodeStar Connections with Amazon CodeGuru Reviewer.

• #create_code_review(options = {}) ⇒ Types::CreateCodeReviewResponse

  Use to create a code review with a CodeReviewType of RepositoryAnalysis.

• #describe_code_review(options = {}) ⇒ Types::DescribeCodeReviewResponse

  Returns the metadata associated with the code review along with its status.

  .

• #describe_recommendation_feedback(options = {}) ⇒ Types::DescribeRecommendationFeedbackResponse

  Describes the customer feedback for a CodeGuru Reviewer recommendation.

• #describe_repository_association(options = {}) ⇒ Types::DescribeRepositoryAssociationResponse

  Returns a RepositoryAssociation object that contains information about the requested repository association.

• #disassociate_repository(options = {}) ⇒ Types::DisassociateRepositoryResponse

  Removes the association between Amazon CodeGuru Reviewer and a repository.

  .

• #list_code_reviews(options = {}) ⇒ Types::ListCodeReviewsResponse

  Lists all the code reviews that the customer has created in the past 90 days.

• #list_recommendation_feedback(options = {}) ⇒ Types::ListRecommendationFeedbackResponse
• #list_recommendations(options = {}) ⇒ Types::ListRecommendationsResponse

  Returns the list of all recommendations for a completed code review.

• #list_repository_associations(options = {}) ⇒ Types::ListRepositoryAssociationsResponse
• #list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse

  Returns the list of tags associated with an associated repository resource.

  .

• #put_recommendation_feedback(options = {}) ⇒ Struct

  Stores customer feedback for a CodeGuru Reviewer recommendation.

• #tag_resource(options = {}) ⇒ Struct

  Adds one or more tags to an associated repository.

  .

• #untag_resource(options = {}) ⇒ Struct

  Removes a tag from an associated repository.

  .

• #wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

  Waiters polls an API operation until a resource enters a desired state.

• #waiter_names ⇒ Array<Symbol>

  Returns the list of supported waiters.

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

#handle, #handle_request, #handle_response

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.

If you associate a CodeCommit repository, it must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.

Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar Connections to connect to CodeGuru Reviewer. For more information, see Connect to a repository source provider in the Amazon CodeGuru Reviewer User Guide.

You cannot use the CodeGuru Reviewer SDK or the AWS 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 so cannot be created using this method.

Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.

Adds one or more tags to an associated repository.

Removes a tag from an associated repository.

Waiters polls an API operation until a resource enters a desired state.

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4