Reference documentation and code samples for the Google Cloud Build V1 Client class ApprovalResult.
ApprovalResult describes the decision and associated metadata of a manual approval of a build.
Generated from protobuf message google.devtools.cloudbuild.v1.ApprovalResult
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ approver_account |
string
Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called. |
↳ approval_time |
Google\Protobuf\Timestamp
Output only. The time when the approval decision was made. |
↳ decision |
int
Required. The decision of this manual approval. |
↳ comment |
string
Optional. An optional comment for this manual approval result. |
↳ url |
string
Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build. |
getApproverAccount
Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.
| Returns | |
|---|---|
| Type | Description |
string | |
setApproverAccount
Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getApprovalTime
Output only. The time when the approval decision was made.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasApprovalTime
clearApprovalTime
setApprovalTime
Output only. The time when the approval decision was made.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDecision
Required. The decision of this manual approval.
| Returns | |
|---|---|
| Type | Description |
int | |
setDecision
Required. The decision of this manual approval.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getComment
Optional. An optional comment for this manual approval result.
| Returns | |
|---|---|
| Type | Description |
string | |
setComment
Optional. An optional comment for this manual approval result.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUrl
Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.
| Returns | |
|---|---|
| Type | Description |
string | |
setUrl
Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |