Google Cloud Build V1 Client - Class GitHubEventsConfig (0.6.1)

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

GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received.

This message is experimental.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ installation_id int|string

The installationID that emits the GitHub event.

↳ owner string

Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform".

↳ name string

Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders".

↳ pull_request Google\Cloud\Build\V1\PullRequestFilter

filter to match changes in pull requests.

↳ push Google\Cloud\Build\V1\PushFilter

filter to match changes in refs like branches, tags.

getInstallationId

The installationID that emits the GitHub event.

Returns
TypeDescription
int|string

setInstallationId

The installationID that emits the GitHub event.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getOwner

Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform".

Returns
TypeDescription
string

setOwner

Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders".

Returns
TypeDescription
string

setName

Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPullRequest

filter to match changes in pull requests.

Returns
TypeDescription
Google\Cloud\Build\V1\PullRequestFilter|null

hasPullRequest

setPullRequest

filter to match changes in pull requests.

Parameter
NameDescription
var Google\Cloud\Build\V1\PullRequestFilter
Returns
TypeDescription
$this

getPush

filter to match changes in refs like branches, tags.

Returns
TypeDescription
Google\Cloud\Build\V1\PushFilter|null

hasPush

setPush

filter to match changes in refs like branches, tags.

Parameter
NameDescription
var Google\Cloud\Build\V1\PushFilter
Returns
TypeDescription
$this

getEvent

Returns
TypeDescription
string