# Cloud Build V2 API - Class Google::Cloud::Build::V2::Connection (v0.14.0)

0.14.0 (latest) 0.13.0 0.12.1 0.11.0 0.10.0 0.9.1 0.8.0 0.7.2 0.6.0 0.5.2 0.4.0 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Cloud Build V2 API class Google::Cloud::Build::V2::Connection.

A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data Center,
Bitbucket Cloud or GitLab.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #annotations

    def annotations() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Allows clients to store small amounts of arbitrary data.

### #annotations=

    def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::String}) --- Allows clients to store small amounts of arbitrary data.
**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Allows clients to store small amounts of arbitrary data.

### #bitbucket_cloud_config

    def bitbucket_cloud_config() -> ::Google::Cloud::Build::V2::BitbucketCloudConfig

**Returns**

- ([::Google::Cloud::Build::V2::BitbucketCloudConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-BitbucketCloudConfig)) --- Configuration for connections to Bitbucket Cloud.


  Note: The following fields are mutually exclusive: `bitbucket_cloud_config`, `github_config`, `github_enterprise_config`, `gitlab_config`, `bitbucket_data_center_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #bitbucket_cloud_config=

    def bitbucket_cloud_config=(value) -> ::Google::Cloud::Build::V2::BitbucketCloudConfig

**Parameter**

- **value** ([::Google::Cloud::Build::V2::BitbucketCloudConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-BitbucketCloudConfig)) --- Configuration for connections to Bitbucket Cloud.


  Note: The following fields are mutually exclusive: `bitbucket_cloud_config`, `github_config`, `github_enterprise_config`, `gitlab_config`, `bitbucket_data_center_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::Build::V2::BitbucketCloudConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-BitbucketCloudConfig)) --- Configuration for connections to Bitbucket Cloud.


  Note: The following fields are mutually exclusive: `bitbucket_cloud_config`, `github_config`, `github_enterprise_config`, `gitlab_config`, `bitbucket_data_center_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #bitbucket_data_center_config

    def bitbucket_data_center_config() -> ::Google::Cloud::Build::V2::BitbucketDataCenterConfig

**Returns**

- ([::Google::Cloud::Build::V2::BitbucketDataCenterConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-BitbucketDataCenterConfig)) --- Configuration for connections to Bitbucket Data Center.


  Note: The following fields are mutually exclusive: `bitbucket_data_center_config`, `github_config`, `github_enterprise_config`, `gitlab_config`, `bitbucket_cloud_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #bitbucket_data_center_config=

    def bitbucket_data_center_config=(value) -> ::Google::Cloud::Build::V2::BitbucketDataCenterConfig

**Parameter**

- **value** ([::Google::Cloud::Build::V2::BitbucketDataCenterConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-BitbucketDataCenterConfig)) --- Configuration for connections to Bitbucket Data Center.


  Note: The following fields are mutually exclusive: `bitbucket_data_center_config`, `github_config`, `github_enterprise_config`, `gitlab_config`, `bitbucket_cloud_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::Build::V2::BitbucketDataCenterConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-BitbucketDataCenterConfig)) --- Configuration for connections to Bitbucket Data Center.


  Note: The following fields are mutually exclusive: `bitbucket_data_center_config`, `github_config`, `github_enterprise_config`, `gitlab_config`, `bitbucket_cloud_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #create_time

    def create_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Protobuf-Timestamp)) --- Output only. Server assigned timestamp for when the connection was created.

### #disabled

    def disabled() -> ::Boolean

**Returns**

- (::Boolean) --- 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.

### #disabled=

    def disabled=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- 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**

- (::Boolean) --- 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.

### #etag

    def etag() -> ::String

**Returns**

- (::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.

### #etag=

    def etag=(value) -> ::String

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #github_config

    def github_config() -> ::Google::Cloud::Build::V2::GitHubConfig

**Returns**

- ([::Google::Cloud::Build::V2::GitHubConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-GitHubConfig)) --- Configuration for connections to github.com.


  Note: The following fields are mutually exclusive: `github_config`, `github_enterprise_config`, `gitlab_config`, `bitbucket_data_center_config`, `bitbucket_cloud_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #github_config=

    def github_config=(value) -> ::Google::Cloud::Build::V2::GitHubConfig

**Parameter**

- **value** ([::Google::Cloud::Build::V2::GitHubConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-GitHubConfig)) --- Configuration for connections to github.com.


  Note: The following fields are mutually exclusive: `github_config`, `github_enterprise_config`, `gitlab_config`, `bitbucket_data_center_config`, `bitbucket_cloud_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::Build::V2::GitHubConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-GitHubConfig)) --- Configuration for connections to github.com.


  Note: The following fields are mutually exclusive: `github_config`, `github_enterprise_config`, `gitlab_config`, `bitbucket_data_center_config`, `bitbucket_cloud_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #github_enterprise_config

    def github_enterprise_config() -> ::Google::Cloud::Build::V2::GitHubEnterpriseConfig

**Returns**

- ([::Google::Cloud::Build::V2::GitHubEnterpriseConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-GitHubEnterpriseConfig)) --- Configuration for connections to an instance of GitHub Enterprise.


  Note: The following fields are mutually exclusive: `github_enterprise_config`, `github_config`, `gitlab_config`, `bitbucket_data_center_config`, `bitbucket_cloud_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #github_enterprise_config=

    def github_enterprise_config=(value) -> ::Google::Cloud::Build::V2::GitHubEnterpriseConfig

**Parameter**

- **value** ([::Google::Cloud::Build::V2::GitHubEnterpriseConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-GitHubEnterpriseConfig)) --- Configuration for connections to an instance of GitHub Enterprise.


  Note: The following fields are mutually exclusive: `github_enterprise_config`, `github_config`, `gitlab_config`, `bitbucket_data_center_config`, `bitbucket_cloud_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::Build::V2::GitHubEnterpriseConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-GitHubEnterpriseConfig)) --- Configuration for connections to an instance of GitHub Enterprise.


  Note: The following fields are mutually exclusive: `github_enterprise_config`, `github_config`, `gitlab_config`, `bitbucket_data_center_config`, `bitbucket_cloud_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #gitlab_config

    def gitlab_config() -> ::Google::Cloud::Build::V2::GitLabConfig

**Returns**

- ([::Google::Cloud::Build::V2::GitLabConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-GitLabConfig)) --- Configuration for connections to gitlab.com or an instance of GitLab Enterprise.


  Note: The following fields are mutually exclusive: `gitlab_config`, `github_config`, `github_enterprise_config`, `bitbucket_data_center_config`, `bitbucket_cloud_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #gitlab_config=

    def gitlab_config=(value) -> ::Google::Cloud::Build::V2::GitLabConfig

**Parameter**

- **value** ([::Google::Cloud::Build::V2::GitLabConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-GitLabConfig)) --- Configuration for connections to gitlab.com or an instance of GitLab Enterprise.


  Note: The following fields are mutually exclusive: `gitlab_config`, `github_config`, `github_enterprise_config`, `bitbucket_data_center_config`, `bitbucket_cloud_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::Build::V2::GitLabConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-GitLabConfig)) --- Configuration for connections to gitlab.com or an instance of GitLab Enterprise.


  Note: The following fields are mutually exclusive: `gitlab_config`, `github_config`, `github_enterprise_config`, `bitbucket_data_center_config`, `bitbucket_cloud_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #installation_state

    def installation_state() -> ::Google::Cloud::Build::V2::InstallationState

**Returns**

- ([::Google::Cloud::Build::V2::InstallationState](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Cloud-Build-V2-InstallationState)) --- Output only. Installation state of the Connection.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Immutable. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Immutable. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
**Returns**

- (::String) --- Immutable. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.

### #reconciling

    def reconciling() -> ::Boolean

**Returns**

- (::Boolean) --- Output only. Set to true when the connection is being set up or updated in the background.

### #update_time

    def update_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-build-v2/latest/Google-Protobuf-Timestamp)) --- Output only. Server assigned timestamp for when the connection was updated.