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

Class: Aws::CodeCommit::Types::PostCommentForPullRequestInput

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

{
  pull_request_id: "PullRequestId", # required
  repository_name: "RepositoryName", # required
  before_commit_id: "CommitId", # required
  after_commit_id: "CommitId", # required
  location: {
    file_path: "Path",
    file_position: 1,
    relative_file_version: "BEFORE", # accepts BEFORE, AFTER
  },
  content: "Content", # required
  client_request_token: "ClientRequestToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#after_commit_idString

The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.

Returns:

  • (String)


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1649

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


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1649

class PostCommentForPullRequestInput < Struct.new(
  :pull_request_id,
  :repository_name,
  :before_commit_id,
  :after_commit_id,
  :location,
  :content,
  :client_request_token)
  include Aws::Structure
end

#client_request_tokenString

A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1649

class PostCommentForPullRequestInput < Struct.new(
  :pull_request_id,
  :repository_name,
  :before_commit_id,
  :after_commit_id,
  :location,
  :content,
  :client_request_token)
  include Aws::Structure
end

#contentString

The content of your comment on the change.

Returns:

  • (String)


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1649

class PostCommentForPullRequestInput < Struct.new(
  :pull_request_id,
  :repository_name,
  :before_commit_id,
  :after_commit_id,
  :location,
  :content,
  :client_request_token)
  include Aws::Structure
end

#locationTypes::Location

The location of the change where you want to post your comment. If no location is provided, the comment will be posted as a general comment on the pull request difference between the before commit ID and the after commit ID.

Returns:



1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1649

class PostCommentForPullRequestInput < Struct.new(
  :pull_request_id,
  :repository_name,
  :before_commit_id,
  :after_commit_id,
  :location,
  :content,
  :client_request_token)
  include Aws::Structure
end

#pull_request_idString

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

Returns:

  • (String)


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1649

class PostCommentForPullRequestInput < Struct.new(
  :pull_request_id,
  :repository_name,
  :before_commit_id,
  :after_commit_id,
  :location,
  :content,
  :client_request_token)
  include Aws::Structure
end

#repository_nameString

The name of the repository where you want to post a comment on a pull request.

Returns:

  • (String)


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1649

class PostCommentForPullRequestInput < Struct.new(
  :pull_request_id,
  :repository_name,
  :before_commit_id,
  :after_commit_id,
  :location,
  :content,
  :client_request_token)
  include Aws::Structure
end