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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb

Overview

Note:

When making an API call, you may pass ListCodeReviewsRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

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)


579
580
581
582
583
584
585
586
587
588
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 579

class ListCodeReviewsRequest < Struct.new(
  :provider_types,
  :states,
  :repository_names,
  :type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#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)


579
580
581
582
583
584
585
586
587
588
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 579

class ListCodeReviewsRequest < Struct.new(
  :provider_types,
  :states,
  :repository_names,
  :type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#provider_typesArray<String>

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

Returns:

  • (Array<String>)


579
580
581
582
583
584
585
586
587
588
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 579

class ListCodeReviewsRequest < Struct.new(
  :provider_types,
  :states,
  :repository_names,
  :type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#repository_namesArray<String>

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

Returns:

  • (Array<String>)


579
580
581
582
583
584
585
586
587
588
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 579

class ListCodeReviewsRequest < Struct.new(
  :provider_types,
  :states,
  :repository_names,
  :type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#statesArray<String>

List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending 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:

  • (Array<String>)


579
580
581
582
583
584
585
586
587
588
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 579

class ListCodeReviewsRequest < Struct.new(
  :provider_types,
  :states,
  :repository_names,
  :type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of code reviews to list in the response.

Returns:

  • (String)


579
580
581
582
583
584
585
586
587
588
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 579

class ListCodeReviewsRequest < Struct.new(
  :provider_types,
  :states,
  :repository_names,
  :type,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end