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

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

Message representing a SCM Pull Request Review Comment (inline on diff).

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

Namespace

Google \ Cloud \ DeveloperConnect \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ id string

Output only. The ID of the comment.

↳ body string

Required. The body of the comment.

↳ path string

Required. The file path to comment on.

↳ first_line int

Optional. The first line of the comment range (inclusive). If not specified, the comment applies only to the last_line.

↳ last_line int

Required. The last line of the comment range (inclusive). If first_line is not specified, the comment applies only to this line.

↳ side int

Optional. The side of the diff to comment on. Defaults to HEAD.

↳ author string

Output only. The username of the author.

↳ create_time Google\Protobuf\Timestamp

Output only. When the comment was created.

↳ update_time Google\Protobuf\Timestamp

Output only. When the comment was updated.

↳ commit_id string

Output only. The commit SHA the comment was actually applied to.

getId

Output only. The ID of the comment.

Returns
Type Description
string

setId

Output only. The ID of the comment.

Parameter
Name Description
var string
Returns
Type Description
$this

getBody

Required. The body of the comment.

Returns
Type Description
string

setBody

Required. The body of the comment.

Parameter
Name Description
var string
Returns
Type Description
$this

getPath

Required. The file path to comment on.

Returns
Type Description
string

setPath

Required. The file path to comment on.

Parameter
Name Description
var string
Returns
Type Description
$this

getFirstLine

Optional. The first line of the comment range (inclusive). If not specified, the comment applies only to the last_line.

Returns
Type Description
int

setFirstLine

Optional. The first line of the comment range (inclusive). If not specified, the comment applies only to the last_line.

Parameter
Name Description
var int
Returns
Type Description
$this

getLastLine

Required. The last line of the comment range (inclusive). If first_line is not specified, the comment applies only to this line.

Returns
Type Description
int

setLastLine

Required. The last line of the comment range (inclusive). If first_line is not specified, the comment applies only to this line.

Parameter
Name Description
var int
Returns
Type Description
$this

getSide

Optional. The side of the diff to comment on. Defaults to HEAD.

Returns
Type Description
int Enum of type DiffSide.

setSide

Optional. The side of the diff to comment on. Defaults to HEAD.

Parameter
Name Description
var int

Enum of type DiffSide.

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 comment was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. When the comment was created.

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

getUpdateTime

Output only. When the comment was updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. When the comment was updated.

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

getCommitId

Output only. The commit SHA the comment was actually applied to.

Returns
Type Description
string

setCommitId

Output only. The commit SHA the comment was actually applied to.

Parameter
Name Description
var string
Returns
Type Description
$this