PullRequest

Message representing a SCM Pull Request.

JSON representation
{
  "id": string,
  "title": string,
  "body": string,
  "headRef": string,
  "baseRef": string,
  "author": string,
  "createTime": string,
  "updateTime": string,
  "mergeTime": string,
  "closeTime": string,
  "declineTime": string,
  "state": enum (State),
  "mergeability": enum (Mergeability),
  "htmlUrl": string
}
Fields
id

string

Required. The ID of the PR.

title

string

Required. The title of the PR.

body

string

Optional. The body description of the PR.

headRef

string

Required. The source commit SHA of the head branch.

baseRef

string

Required. The target commit SHA of the base branch.

author

string

Output only. The username of the author.

createTime

string (Timestamp format)

Output only. When the PR was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. When the PR was updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

mergeTime

string (Timestamp format)

Output only. When the PR was merged.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

closeTime

string (Timestamp format)

Output only. When the PR was closed.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

declineTime

string (Timestamp format)

Output only. When the PR was declined. Only set for SCM providers that support declining pull requests. Never set for GitHub, GitHub Enterprise, GitLab, or GitLab Enterprise, where a pull request closed without being merged is CLOSED.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

state

enum (State)

Output only. The current state of the PR.

mergeability

enum (Mergeability)

Output only. The mergeability state of the pull request.

htmlUrl

string

Output only. The HTML URL of the pull request on the SCM provider.

State

The state of the PR.

Enums
STATE_UNSPECIFIED Default value.
OPEN The PR is open.
CLOSED The PR is closed.
MERGED The PR is merged.
DECLINED The PR is declined. Only used by SCM providers that support declining pull requests. Never used for GitHub, GitHub Enterprise, GitLab, or GitLab Enterprise, where a pull request closed without being merged is CLOSED.

Mergeability

The mergeability state of a pull request.

Enums
MERGEABILITY_UNSPECIFIED Mergeability state is unspecified.
MERGEABLE The pull request can be merged cleanly without Git conflicts.
CONFLICTING The pull request has merge conflicts and cannot be merged cleanly.
COMPUTING The mergeability state is currently being computed asynchronously by the upstream SCM provider.