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

Class: Aws::CodeCommit::Types::PullRequest

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

Overview

Returns information about a pull request.

Instance Attribute Summary collapse

Instance Attribute Details

#author_arnString

The Amazon Resource Name (ARN) of the user who created the pull request.

Returns:

  • (String)


1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1814

class PullRequest < Struct.new(
  :pull_request_id,
  :title,
  :description,
  :last_activity_date,
  :creation_date,
  :pull_request_status,
  :author_arn,
  :pull_request_targets,
  :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.

Returns:

  • (String)


1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1814

class PullRequest < Struct.new(
  :pull_request_id,
  :title,
  :description,
  :last_activity_date,
  :creation_date,
  :pull_request_status,
  :author_arn,
  :pull_request_targets,
  :client_request_token)
  include Aws::Structure
end

#creation_dateTime

The date and time the pull request was originally created, in timestamp format.

Returns:

  • (Time)


1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1814

class PullRequest < Struct.new(
  :pull_request_id,
  :title,
  :description,
  :last_activity_date,
  :creation_date,
  :pull_request_status,
  :author_arn,
  :pull_request_targets,
  :client_request_token)
  include Aws::Structure
end

#descriptionString

The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

Returns:

  • (String)


1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1814

class PullRequest < Struct.new(
  :pull_request_id,
  :title,
  :description,
  :last_activity_date,
  :creation_date,
  :pull_request_status,
  :author_arn,
  :pull_request_targets,
  :client_request_token)
  include Aws::Structure
end

#last_activity_dateTime

The day and time of the last user or system activity on the pull request, in timestamp format.

Returns:

  • (Time)


1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1814

class PullRequest < Struct.new(
  :pull_request_id,
  :title,
  :description,
  :last_activity_date,
  :creation_date,
  :pull_request_status,
  :author_arn,
  :pull_request_targets,
  :client_request_token)
  include Aws::Structure
end

#pull_request_idString

The system-generated ID of the pull request.

Returns:

  • (String)


1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1814

class PullRequest < Struct.new(
  :pull_request_id,
  :title,
  :description,
  :last_activity_date,
  :creation_date,
  :pull_request_status,
  :author_arn,
  :pull_request_targets,
  :client_request_token)
  include Aws::Structure
end

#pull_request_statusString

The status of the pull request. Pull request status can only change from OPEN to CLOSED.

Returns:

  • (String)


1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1814

class PullRequest < Struct.new(
  :pull_request_id,
  :title,
  :description,
  :last_activity_date,
  :creation_date,
  :pull_request_status,
  :author_arn,
  :pull_request_targets,
  :client_request_token)
  include Aws::Structure
end

#pull_request_targetsArray<Types::PullRequestTarget>

The targets of the pull request, including the source branch and destination branch for the pull request.

Returns:



1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1814

class PullRequest < Struct.new(
  :pull_request_id,
  :title,
  :description,
  :last_activity_date,
  :creation_date,
  :pull_request_status,
  :author_arn,
  :pull_request_targets,
  :client_request_token)
  include Aws::Structure
end

#titleString

The user-defined title of the pull request. This title is displayed in the list of pull requests to other users of the repository.

Returns:

  • (String)


1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1814

class PullRequest < Struct.new(
  :pull_request_id,
  :title,
  :description,
  :last_activity_date,
  :creation_date,
  :pull_request_status,
  :author_arn,
  :pull_request_targets,
  :client_request_token)
  include Aws::Structure
end