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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returns information about a pull request.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#approval_rules ⇒ Array<Types::ApprovalRule>

The approval rules applied to the pull request.

Returns:

#author_arn ⇒ String

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

Returns:

  • (String) —

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

#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.

Returns:

  • (String) —

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

#creation_date ⇒ Time

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

Returns:

  • (Time) —

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

#description ⇒ String

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

    The user-defined description of the pull request.

#last_activity_date ⇒ Time

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

Returns:

  • (Time) —

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

#pull_request_id ⇒ String

The system-generated ID of the pull request.

Returns:

  • (String) —

    The system-generated ID of the pull request.

#pull_request_status ⇒ String

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

Possible values:

  • OPEN
  • CLOSED

Returns:

  • (String) —

    The status of the pull request.

#pull_request_targets ⇒ Array<Types::PullRequestTarget>

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

Returns:

  • (Array<Types::PullRequestTarget>) —

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

#revision_id ⇒ String

The system-generated revision ID for the pull request.

Returns:

  • (String) —

    The system-generated revision ID for the pull request.

#title ⇒ String

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

Returns:

  • (String) —

    The user-defined title of the pull request.