Google Cloud Build V1 Client - Class CancelBuildRequest (0.16.3)

Reference documentation and code samples for the Google Cloud Build V1 Client class CancelBuildRequest.

Request to cancel an ongoing build.

Generated from protobuf message google.devtools.cloudbuild.v1.CancelBuildRequest

Namespace

Google \ Cloud \ Build \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

The name of the Build to cancel. Format: projects/{project}/locations/{location}/builds/{build}

↳ project_id string

Required. ID of the project.

↳ id string

Required. ID of the build.

getName

The name of the Build to cancel.

Format: projects/{project}/locations/{location}/builds/{build}

Returns
Type Description
string

setName

The name of the Build to cancel.

Format: projects/{project}/locations/{location}/builds/{build}

Parameter
Name Description
var string
Returns
Type Description
$this

getProjectId

Required. ID of the project.

Returns
Type Description
string

setProjectId

Required. ID of the project.

Parameter
Name Description
var string
Returns
Type Description
$this

getId

Required. ID of the build.

Returns
Type Description
string

setId

Required. ID of the build.

Parameter
Name Description
var string
Returns
Type Description
$this