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

Class: Aws::CodeCommit::Types::ListPullRequestsInput

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

Overview

Note:

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

{
  repository_name: "RepositoryName", # required
  author_arn: "Arn",
  pull_request_status: "OPEN", # accepts OPEN, CLOSED
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#author_arnString

Optional. The Amazon Resource Name (ARN) of the user who created the pull request. If used, this filters the results to pull requests created by that user.

Returns:

  • (String)


1293
1294
1295
1296
1297
1298
1299
1300
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1293

class ListPullRequestsInput < Struct.new(
  :repository_name,
  :author_arn,
  :pull_request_status,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

A non-negative integer used to limit the number of returned results.

Returns:

  • (Integer)


1293
1294
1295
1296
1297
1298
1299
1300
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1293

class ListPullRequestsInput < Struct.new(
  :repository_name,
  :author_arn,
  :pull_request_status,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

An enumeration token that when provided in a request, returns the next batch of the results.

Returns:

  • (String)


1293
1294
1295
1296
1297
1298
1299
1300
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1293

class ListPullRequestsInput < Struct.new(
  :repository_name,
  :author_arn,
  :pull_request_status,
  :next_token,
  :max_results)
  include Aws::Structure
end

#pull_request_statusString

Optional. The status of the pull request. If used, this refines the results to the pull requests that match the specified status.

Returns:

  • (String)


1293
1294
1295
1296
1297
1298
1299
1300
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1293

class ListPullRequestsInput < Struct.new(
  :repository_name,
  :author_arn,
  :pull_request_status,
  :next_token,
  :max_results)
  include Aws::Structure
end

#repository_nameString

The name of the repository for which you want to list pull requests.

Returns:

  • (String)


1293
1294
1295
1296
1297
1298
1299
1300
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1293

class ListPullRequestsInput < Struct.new(
  :repository_name,
  :author_arn,
  :pull_request_status,
  :next_token,
  :max_results)
  include Aws::Structure
end