Class: Aws::CodeGuruReviewer::Types::ListRepositoryAssociationsRequest

Inherits:

Struct

• Object
• Struct
• Aws::CodeGuruReviewer::Types::ListRepositoryAssociationsRequest

Defined in:

gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb

Overview

Note:

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

{
  provider_types: ["CodeCommit"], # accepts CodeCommit, GitHub, Bitbucket, GitHubEnterpriseServer, S3Bucket
  states: ["Associated"], # accepts Associated, Associating, Failed, Disassociating, Disassociated
  names: ["Name"],
  owners: ["Owner"],
  max_results: 1,
  next_token: "NextToken",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_results ⇒ Integer

  The maximum number of repository association results returned by ListRepositoryAssociations in paginated output.

• #names ⇒ Array<String>

  List of repository names to use as a filter.

• #next_token ⇒ String

  The nextToken value returned from a previous paginated ListRepositoryAssociations request where maxResults was used and the results exceeded the value of that parameter.

• #owners ⇒ Array<String>

  List of owners to use as a filter.

• #provider_types ⇒ Array<String>

  List of provider types to use as a filter.

• #states ⇒ Array<String>

  List of repository association states to use as a filter.

Instance Attribute Details

#max_results ⇒ Integer

The maximum number of repository association results returned by ListRepositoryAssociations in paginated output. When this parameter is used, ListRepositoryAssociations only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, ListRepositoryAssociations returns up to 100 results and a nextToken value if applicable.

Returns:

• (Integer)

# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1301

class ListRepositoryAssociationsRequest < Struct.new(
  :provider_types,
  :states,
  :names,
  :owners,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#names ⇒ Array<String>

List of repository names to use as a filter.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1301

class ListRepositoryAssociationsRequest < Struct.new(
  :provider_types,
  :states,
  :names,
  :owners,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The nextToken value returned from a previous paginated ListRepositoryAssociations request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Treat this token as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

• (String)

# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1301

class ListRepositoryAssociationsRequest < Struct.new(
  :provider_types,
  :states,
  :names,
  :owners,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#owners ⇒ Array<String>

List of owners to use as a filter. For Amazon Web Services CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket and GitHub Enterprise Server, this is name of the account that was used to associate the repository.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1301

class ListRepositoryAssociationsRequest < Struct.new(
  :provider_types,
  :states,
  :names,
  :owners,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#provider_types ⇒ Array<String>

List of provider types to use as a filter.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1301

class ListRepositoryAssociationsRequest < Struct.new(
  :provider_types,
  :states,
  :names,
  :owners,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#states ⇒ Array<String>

List of repository association states to use as a filter.

The valid repository association states are:

• Associated: The repository association is complete.

• Associating: CodeGuru Reviewer is:

  • Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.

    If your repository ProviderType is GitHub, GitHub Enterprise Server, or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.

  • Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.

• Failed: The repository failed to associate or disassociate.

• Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.

• Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in an associated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1301

class ListRepositoryAssociationsRequest < Struct.new(
  :provider_types,
  :states,
  :names,
  :owners,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end