AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::CodeGuruReviewer::Types::ListCodeReviewsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListCodeReviewsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  provider_types: ["CodeCommit"], # accepts CodeCommit, GitHub, Bitbucket
  states: ["Completed"], # accepts Completed, Pending, Failed, Deleting
  repository_names: ["Name"],
  type: "PullRequest", # required, accepts PullRequest
  max_results: 1,
  next_token: "NextToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of results that are returned per call. The default is 100.

Returns:

  • (Integer)

    The maximum number of results that are returned per call.

#next_tokenString

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Returns:

  • (String)

    If nextToken is returned, there are more results available.

#provider_typesArray<String>

List of provider types for filtering that needs to be applied before displaying the result. For example, \"providerTypes=[GitHub]\" will list code reviews from GitHub.

Returns:

  • (Array<String>)

    List of provider types for filtering that needs to be applied before displaying the result.

#repository_namesArray<String>

List of repository names for filtering that needs to be applied before displaying the result.

Returns:

  • (Array<String>)

    List of repository names for filtering that needs to be applied before displaying the result.

#statesArray<String>

List of states for filtering that needs to be applied before displaying the result. For example, \"states=[Pending]\" will list code reviews in the Pending state.

Returns:

  • (Array<String>)

    List of states for filtering that needs to be applied before displaying the result.

#typeString

The type of code reviews to list in the response.

Possible values:

  • PullRequest

Returns:

  • (String)

    The type of code reviews to list in the response.