Google Cloud Build V2 Client - Class Connection (0.14.0)

Reference documentation and code samples for the Google Cloud Build V2 Client class Connection.

A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Server or GitLab.

Generated from protobuf message google.devtools.cloudbuild.v2.Connection

Namespace

Google \ Cloud \ Build \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Immutable. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.

↳ create_time Google\Protobuf\Timestamp

Output only. Server assigned timestamp for when the connection was created.

↳ update_time Google\Protobuf\Timestamp

Output only. Server assigned timestamp for when the connection was updated.

↳ github_config Google\Cloud\Build\V2\GitHubConfig

Configuration for connections to github.com.

↳ github_enterprise_config Google\Cloud\Build\V2\GitHubEnterpriseConfig

Configuration for connections to an instance of GitHub Enterprise.

↳ gitlab_config Google\Cloud\Build\V2\GitLabConfig

Configuration for connections to gitlab.com or an instance of GitLab Enterprise.

↳ installation_state Google\Cloud\Build\V2\InstallationState

Output only. Installation state of the Connection.

↳ disabled bool

If disabled is set to true, functionality is disabled for this connection. Repository based API methods and webhooks processing for repositories in this connection will be disabled.

↳ reconciling bool

Output only. Set to true when the connection is being set up or updated in the background.

↳ annotations array|Google\Protobuf\Internal\MapField

Allows clients to store small amounts of arbitrary data.

↳ etag string

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

getName

Immutable. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.

Returns
TypeDescription
string

setName

Immutable. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connection_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Server assigned timestamp for when the connection was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Server assigned timestamp for when the connection was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. Server assigned timestamp for when the connection was updated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Server assigned timestamp for when the connection was updated.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getGithubConfig

Configuration for connections to github.com.

Returns
TypeDescription
Google\Cloud\Build\V2\GitHubConfig|null

hasGithubConfig

setGithubConfig

Configuration for connections to github.com.

Parameter
NameDescription
var Google\Cloud\Build\V2\GitHubConfig
Returns
TypeDescription
$this

getGithubEnterpriseConfig

Configuration for connections to an instance of GitHub Enterprise.

Returns
TypeDescription
Google\Cloud\Build\V2\GitHubEnterpriseConfig|null

hasGithubEnterpriseConfig

setGithubEnterpriseConfig

Configuration for connections to an instance of GitHub Enterprise.

Parameter
NameDescription
var Google\Cloud\Build\V2\GitHubEnterpriseConfig
Returns
TypeDescription
$this

getGitlabConfig

Configuration for connections to gitlab.com or an instance of GitLab Enterprise.

Returns
TypeDescription
Google\Cloud\Build\V2\GitLabConfig|null

hasGitlabConfig

setGitlabConfig

Configuration for connections to gitlab.com or an instance of GitLab Enterprise.

Parameter
NameDescription
var Google\Cloud\Build\V2\GitLabConfig
Returns
TypeDescription
$this

getInstallationState

Output only. Installation state of the Connection.

Returns
TypeDescription
Google\Cloud\Build\V2\InstallationState|null

hasInstallationState

clearInstallationState

setInstallationState

Output only. Installation state of the Connection.

Parameter
NameDescription
var Google\Cloud\Build\V2\InstallationState
Returns
TypeDescription
$this

getDisabled

If disabled is set to true, functionality is disabled for this connection.

Repository based API methods and webhooks processing for repositories in this connection will be disabled.

Returns
TypeDescription
bool

setDisabled

If disabled is set to true, functionality is disabled for this connection.

Repository based API methods and webhooks processing for repositories in this connection will be disabled.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getReconciling

Output only. Set to true when the connection is being set up or updated in the background.

Returns
TypeDescription
bool

setReconciling

Output only. Set to true when the connection is being set up or updated in the background.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getAnnotations

Allows clients to store small amounts of arbitrary data.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setAnnotations

Allows clients to store small amounts of arbitrary data.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getEtag

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Returns
TypeDescription
string

setEtag

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getConnectionConfig

Returns
TypeDescription
string