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

Class: Aws::CodeCommit::Types::GetCommentsForPullRequestInput

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 GetCommentsForPullRequestInput data as a hash:

{
  pull_request_id: "PullRequestId", # required
  repository_name: "RepositoryName",
  before_commit_id: "CommitId",
  after_commit_id: "CommitId",
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#after_commit_idString

The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made.

Returns:

  • (String)


896
897
898
899
900
901
902
903
904
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 896

class GetCommentsForPullRequestInput < Struct.new(
  :pull_request_id,
  :repository_name,
  :before_commit_id,
  :after_commit_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#before_commit_idString

The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.

Returns:

  • (String)


896
897
898
899
900
901
902
903
904
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 896

class GetCommentsForPullRequestInput < Struct.new(
  :pull_request_id,
  :repository_name,
  :before_commit_id,
  :after_commit_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

A non-negative integer used to limit the number of returned results. The default is 100 comments. You can return up to 500 comments with a single request.

Returns:

  • (Integer)


896
897
898
899
900
901
902
903
904
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 896

class GetCommentsForPullRequestInput < Struct.new(
  :pull_request_id,
  :repository_name,
  :before_commit_id,
  :after_commit_id,
  :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)


896
897
898
899
900
901
902
903
904
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 896

class GetCommentsForPullRequestInput < Struct.new(
  :pull_request_id,
  :repository_name,
  :before_commit_id,
  :after_commit_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#pull_request_idString

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

Returns:

  • (String)


896
897
898
899
900
901
902
903
904
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 896

class GetCommentsForPullRequestInput < Struct.new(
  :pull_request_id,
  :repository_name,
  :before_commit_id,
  :after_commit_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#repository_nameString

The name of the repository that contains the pull request.

Returns:

  • (String)


896
897
898
899
900
901
902
903
904
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 896

class GetCommentsForPullRequestInput < Struct.new(
  :pull_request_id,
  :repository_name,
  :before_commit_id,
  :after_commit_id,
  :next_token,
  :max_results)
  include Aws::Structure
end