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

Class: Aws::CodeCommit::Types::PostCommentForComparedCommitInput

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

{
  repository_name: "RepositoryName", # required
  before_commit_id: "CommitId",
  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

To establish the directionality of the comparison, the full commit ID of the 'after' commit.

Returns:

  • (String)


1529
1530
1531
1532
1533
1534
1535
1536
1537
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1529

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

#before_commit_idString

To establish the directionality of the comparison, the full commit ID of the 'before' commit.

Returns:

  • (String)


1529
1530
1531
1532
1533
1534
1535
1536
1537
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1529

class PostCommentForComparedCommitInput < Struct.new(
  :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)


1529
1530
1531
1532
1533
1534
1535
1536
1537
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1529

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

#contentString

The content of the comment you want to make.

Returns:

  • (String)


1529
1530
1531
1532
1533
1534
1535
1536
1537
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1529

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

#locationTypes::Location

The location of the comparison where you want to comment.

Returns:



1529
1530
1531
1532
1533
1534
1535
1536
1537
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1529

class PostCommentForComparedCommitInput < Struct.new(
  :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 the comparison between commits.

Returns:

  • (String)


1529
1530
1531
1532
1533
1534
1535
1536
1537
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1529

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