Google Cloud Developer Connect V1 Client - Class PullRequest (0.9.0)

Reference documentation and code samples for the Google Cloud Developer Connect V1 Client class PullRequest.

Message representing a SCM Pull Request.

Generated from protobuf message google.cloud.developerconnect.v1.PullRequest

Namespace

Google \ Cloud \ DeveloperConnect \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

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

↳ head_ref string

Required. The source commit SHA of the head branch.

↳ base_ref string

Required. The target commit SHA of the base branch.

↳ author string

Output only. The username of the author.

↳ create_time Google\Protobuf\Timestamp

Output only. When the PR was created.

↳ update_time Google\Protobuf\Timestamp

Output only. When the PR was updated.

↳ merge_time Google\Protobuf\Timestamp

Output only. When the PR was merged.

↳ close_time Google\Protobuf\Timestamp

Output only. When the PR was closed.

↳ decline_time Google\Protobuf\Timestamp

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.

↳ state int

Output only. The current state of the PR.

↳ mergeability int

Output only. The mergeability state of the pull request.

↳ html_url string

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

getId

Required. The ID of the PR.

Returns
Type Description
string

setId

Required. The ID of the PR.

Parameter
Name Description
var string
Returns
Type Description
$this

getTitle

Required. The title of the PR.

Returns
Type Description
string

setTitle

Required. The title of the PR.

Parameter
Name Description
var string
Returns
Type Description
$this

getBody

Optional. The body description of the PR.

Returns
Type Description
string

setBody

Optional. The body description of the PR.

Parameter
Name Description
var string
Returns
Type Description
$this

getHeadRef

Required. The source commit SHA of the head branch.

Returns
Type Description
string

setHeadRef

Required. The source commit SHA of the head branch.

Parameter
Name Description
var string
Returns
Type Description
$this

getBaseRef

Required. The target commit SHA of the base branch.

Returns
Type Description
string

setBaseRef

Required. The target commit SHA of the base branch.

Parameter
Name Description
var string
Returns
Type Description
$this

getAuthor

Output only. The username of the author.

Returns
Type Description
string

setAuthor

Output only. The username of the author.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. When the PR was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. When the PR was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. When the PR was updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. When the PR was updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getMergeTime

Output only. When the PR was merged.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasMergeTime

clearMergeTime

setMergeTime

Output only. When the PR was merged.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCloseTime

Output only. When the PR was closed.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCloseTime

clearCloseTime

setCloseTime

Output only. When the PR was closed.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDeclineTime

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.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeclineTime

clearDeclineTime

setDeclineTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getState

Output only. The current state of the PR.

Returns
Type Description
int Enum of type State.

setState

Output only. The current state of the PR.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getMergeability

Output only. The mergeability state of the pull request.

Returns
Type Description
int Enum of type Mergeability.

setMergeability

Output only. The mergeability state of the pull request.

Parameter
Name Description
var int

Enum of type Mergeability.

Returns
Type Description
$this

getHtmlUrl

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

Returns
Type Description
string

setHtmlUrl

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

Parameter
Name Description
var string
Returns
Type Description
$this