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

Inherits:

Struct

• Object
• Struct
• Aws::CodeCommit::Types::PostCommentForPullRequestInput

Includes:

Structure

Defined in:

lib/aws-sdk-codecommit/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #after_commit_id ⇒ String

  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.

• #before_commit_id ⇒ String

  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.

• #client_request_token ⇒ String

  A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter.

• #content ⇒ String

  The content of your comment on the change.

• #location ⇒ Types::Location

  The location of the change where you want to post your comment.

• #pull_request_id ⇒ String

  The system-generated ID of the pull request.

• #repository_name ⇒ String

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

Instance Attribute Details

#after_commit_id ⇒ String

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)

# File 'lib/aws-sdk-codecommit/types.rb', line 5439

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

#before_commit_id ⇒ String

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)

# File 'lib/aws-sdk-codecommit/types.rb', line 5439

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

#client_request_token ⇒ String

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

# File 'lib/aws-sdk-codecommit/types.rb', line 5439

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

#content ⇒ String

The content of your comment on the change.

Returns:

• (String)

# File 'lib/aws-sdk-codecommit/types.rb', line 5439

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

#location ⇒ Types::Location

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

Returns:

• (Types::Location)

# File 'lib/aws-sdk-codecommit/types.rb', line 5439

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

#pull_request_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-codecommit/types.rb', line 5439

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

#repository_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-codecommit/types.rb', line 5439

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