Console
    Contact Us Start free

    REST Resource: projects.locations.connections

    Resource: Connection

    Message describing Connection object

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "deleteTime" 
 : 
 string 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "installationState" 
 : 
 { 
 object (  InstallationState 
 
) 
 } 
 , 
 "disabled" 
 : 
 boolean 
 , 
 "reconciling" 
 : 
 boolean 
 , 
 "annotations" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "etag" 
 : 
 string 
 , 
 "uid" 
 : 
 string 
 , 
 "cryptoKeyConfig" 
 : 
 { 
 object (  CryptoKeyConfig 
 
) 
 } 
 , 
 "gitProxyConfig" 
 : 
 { 
 object (  GitProxyConfig 
 
) 
 } 
 , 
 // Union field connection_config 
can be only one of the following: 
 "githubConfig" 
 : 
 { 
 object (  GitHubConfig 
 
) 
 } 
 , 
 "githubEnterpriseConfig" 
 : 
 { 
 object (  GitHubEnterpriseConfig 
 
) 
 } 
 , 
 "gitlabConfig" 
 : 
 { 
 object (  GitLabConfig 
 
) 
 } 
 , 
 "gitlabEnterpriseConfig" 
 : 
 { 
 object (  GitLabEnterpriseConfig 
 
) 
 } 
 , 
 "bitbucketDataCenterConfig" 
 : 
 { 
 object (  BitbucketDataCenterConfig 
 
) 
 } 
 , 
 "bitbucketCloudConfig" 
 : 
 { 
 object (  BitbucketCloudConfig 
 
) 
 } 
 // End of list of possible types for union field connection_config 
. 
 }
    Fields
    name

    string

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

    createTime

    string ( Timestamp format)

    Output only. [Output only] Create timestamp

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    updateTime

    string ( Timestamp format)

    Output only. [Output only] Update timestamp

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    deleteTime

    string ( Timestamp format)

    Output only. [Output only] Delete timestamp

    Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    labels

    map (key: string, value: string)

    Optional. Labels as key value pairs

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    installationState

    object ( InstallationState )

    Output only. Installation state of the Connection.

    disabled

    boolean

    Optional. 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

    boolean

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

    annotations

    map (key: string, value: string)

    Optional. Allows clients to store small amounts of arbitrary data.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    etag

    string

    Optional. 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.

    uid

    string

    Output only. A system-assigned unique identifier for the Connection.

    cryptoKeyConfig

    object ( CryptoKeyConfig )

    Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.

    gitProxyConfig

    object ( GitProxyConfig )

    Optional. Configuration for the git proxy feature. Enabling the git proxy allows clients to perform git operations on the repositories linked in the connection.

    Union field connection_config . Configuration for the connection depending on the type of provider. connection_config can be only one of the following:
    githubConfig

    object ( GitHubConfig )

    Configuration for connections to github.com.

    githubEnterpriseConfig

    object ( GitHubEnterpriseConfig )

    Configuration for connections to an instance of GitHub Enterprise.

    gitlabConfig

    object ( GitLabConfig )

    Configuration for connections to gitlab.com.

    gitlabEnterpriseConfig

    object ( GitLabEnterpriseConfig )

    Configuration for connections to an instance of GitLab Enterprise.

    bitbucketDataCenterConfig

    object ( BitbucketDataCenterConfig )

    Configuration for connections to an instance of Bitbucket Data Center.

    bitbucketCloudConfig

    object ( BitbucketCloudConfig )

    Configuration for connections to an instance of Bitbucket Clouds.

    GitHubConfig

    Configuration for connections to github.com.

    JSON representation 
     { 
 "githubApp" 
 : 
 enum (  GitHubApp 
 
) 
 , 
 "authorizerCredential" 
 : 
 { 
 object (  OAuthCredential 
 
) 
 } 
 , 
 "appInstallationId" 
 : 
 string 
 , 
 "installationUri" 
 : 
 string 
 }
    Fields
    githubApp

    enum ( GitHubApp )

    Required. Immutable. The GitHub Application that was installed to the GitHub user or organization.
    authorizerCredential

    object ( OAuthCredential )

    Optional. OAuth credential of the account that authorized the GitHub App. It is recommended to use a robot account instead of a human user account. The OAuth token must be tied to the GitHub App of this config.
    appInstallationId

    string ( int64 format)

    Optional. GitHub App installation id.
    installationUri

    string

    Output only. The URI to navigate to in order to manage the installation associated with this GitHubConfig.

    GitHubApp

    Represents the various GitHub Applications that can be installed to a GitHub user or organization and used with Developer Connect.

    Enums
    GIT_HUB_APP_UNSPECIFIED GitHub App not specified.
    DEVELOPER_CONNECT The Developer Connect GitHub Application.
    FIREBASE The Firebase GitHub Application.

    OAuthCredential

    Represents an OAuth token of the account that authorized the Connection, and associated metadata.

    JSON representation 
     { 
 "oauthTokenSecretVersion" 
 : 
 string 
 , 
 "username" 
 : 
 string 
 }
    Fields
    oauthTokenSecretVersion

    string

    Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: projects/*/secrets/*/versions/* .
    username

    string

    Output only. The username associated with this token.

    GitHubEnterpriseConfig

    Configuration for connections to an instance of GitHub Enterprise.

    JSON representation 
     { 
 "hostUri" 
 : 
 string 
 , 
 "appId" 
 : 
 string 
 , 
 "appSlug" 
 : 
 string 
 , 
 "privateKeySecretVersion" 
 : 
 string 
 , 
 "webhookSecretSecretVersion" 
 : 
 string 
 , 
 "appInstallationId" 
 : 
 string 
 , 
 "installationUri" 
 : 
 string 
 , 
 "serviceDirectoryConfig" 
 : 
 { 
 object (  ServiceDirectoryConfig 
 
) 
 } 
 , 
 "serverVersion" 
 : 
 string 
 , 
 "sslCaCertificate" 
 : 
 string 
 }
    Fields
    hostUri

    string

    Required. The URI of the GitHub Enterprise host this connection is for.
    appId

    string ( int64 format)

    Optional. ID of the GitHub App created from the manifest.
    appSlug

    string

    Output only. The URL-friendly name of the GitHub App.
    privateKeySecretVersion

    string

    Optional. SecretManager resource containing the private key of the GitHub App, formatted as projects/*/secrets/*/versions/* .
    webhookSecretSecretVersion

    string

    Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as projects/*/secrets/*/versions/* .
    appInstallationId

    string ( int64 format)

    Optional. ID of the installation of the GitHub App.
    installationUri

    string

    Output only. The URI to navigate to in order to manage the installation associated with this GitHubEnterpriseConfig.
    serviceDirectoryConfig

    object ( ServiceDirectoryConfig )

    Optional. Configuration for using Service Directory to privately connect to a GitHub Enterprise server. This should only be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitHub Enterprise server will be made over the public internet.
    serverVersion

    string

    Output only. GitHub Enterprise version installed at the hostUri.
    sslCaCertificate

    string

    Optional. SSL certificate to use for requests to GitHub Enterprise.

    ServiceDirectoryConfig

    ServiceDirectoryConfig represents Service Directory configuration for a connection.

    JSON representation 
     { 
 "service" 
 : 
 string 
 }
    Fields
    service

    string

    Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

    GitLabConfig

    Configuration for connections to gitlab.com.

    JSON representation 
     { 
 "webhookSecretSecretVersion" 
 : 
 string 
 , 
 "readAuthorizerCredential" 
 : 
 { 
 object (  UserCredential 
 
) 
 } 
 , 
 "authorizerCredential" 
 : 
 { 
 object (  UserCredential 
 
) 
 } 
 }
    Fields
    webhookSecretSecretVersion

    string

    Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as projects/*/secrets/*/versions/* . This is used to validate webhooks.
    readAuthorizerCredential

    object ( UserCredential )

    Required. A GitLab personal access token with the minimum read_api scope access and a minimum role of reporter . The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
    authorizerCredential

    object ( UserCredential )

    Required. A GitLab personal access token with the minimum api scope access and a minimum role of maintainer . The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.

    UserCredential

    Represents a personal access token that authorized the Connection, and associated metadata.

    JSON representation 
     { 
 "userTokenSecretVersion" 
 : 
 string 
 , 
 "username" 
 : 
 string 
 }
    Fields
    userTokenSecretVersion

    string

    Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: projects/*/secrets/*/versions/* .
    username

    string

    Output only. The username associated with this token.

    GitLabEnterpriseConfig

    Configuration for connections to an instance of GitLab Enterprise.

    JSON representation 
     { 
 "hostUri" 
 : 
 string 
 , 
 "webhookSecretSecretVersion" 
 : 
 string 
 , 
 "readAuthorizerCredential" 
 : 
 { 
 object (  UserCredential 
 
) 
 } 
 , 
 "authorizerCredential" 
 : 
 { 
 object (  UserCredential 
 
) 
 } 
 , 
 "serviceDirectoryConfig" 
 : 
 { 
 object (  ServiceDirectoryConfig 
 
) 
 } 
 , 
 "sslCaCertificate" 
 : 
 string 
 , 
 "serverVersion" 
 : 
 string 
 }
    Fields
    hostUri

    string

    Required. The URI of the GitLab Enterprise host this connection is for.
    webhookSecretSecretVersion

    string

    Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as projects/*/secrets/*/versions/* . This is used to validate webhooks.
    readAuthorizerCredential

    object ( UserCredential )

    Required. A GitLab personal access token with the minimum read_api scope access and a minimum role of reporter . The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
    authorizerCredential

    object ( UserCredential )

    Required. A GitLab personal access token with the minimum api scope access and a minimum role of maintainer . The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to.
    serviceDirectoryConfig

    object ( ServiceDirectoryConfig )

    Optional. Configuration for using Service Directory to privately connect to a GitLab Enterprise instance. This should only be set if the GitLab Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitLab Enterprise server will be made over the public internet.
    sslCaCertificate

    string

    Optional. SSL Certificate Authority certificate to use for requests to GitLab Enterprise instance.
    serverVersion

    string

    Output only. Version of the GitLab Enterprise server running on the hostUri .

    BitbucketDataCenterConfig

    Configuration for connections to an instance of Bitbucket Data Center.

    JSON representation 
     { 
 "hostUri" 
 : 
 string 
 , 
 "webhookSecretSecretVersion" 
 : 
 string 
 , 
 "readAuthorizerCredential" 
 : 
 { 
 object (  UserCredential 
 
) 
 } 
 , 
 "authorizerCredential" 
 : 
 { 
 object (  UserCredential 
 
) 
 } 
 , 
 "serviceDirectoryConfig" 
 : 
 { 
 object (  ServiceDirectoryConfig 
 
) 
 } 
 , 
 "sslCaCertificate" 
 : 
 string 
 , 
 "serverVersion" 
 : 
 string 
 }
    Fields
    hostUri

    string

    Required. The URI of the Bitbucket Data Center host this connection is for.
    webhookSecretSecretVersion

    string

    Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as projects/*/secrets/*/versions/* . This is used to validate webhooks.
    readAuthorizerCredential

    object ( UserCredential )

    Required. An http access token with the minimum Repository read access. It's recommended to use a system account to generate the credentials.
    authorizerCredential

    object ( UserCredential )

    Required. An http access token with the minimum Repository admin scope access. This is needed to create webhooks. It's recommended to use a system account to generate these credentials.
    serviceDirectoryConfig

    object ( ServiceDirectoryConfig )

    Optional. Configuration for using Service Directory to privately connect to a Bitbucket Data Center instance. This should only be set if the Bitbucket Data Center is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the Bitbucket Data Center will be made over the public internet.
    sslCaCertificate

    string

    Optional. SSL certificate authority to trust when making requests to Bitbucket Data Center.
    serverVersion

    string

    Output only. Version of the Bitbucket Data Center server running on the hostUri .

    BitbucketCloudConfig

    Configuration for connections to an instance of Bitbucket Cloud.

    JSON representation 
     { 
 "workspace" 
 : 
 string 
 , 
 "webhookSecretSecretVersion" 
 : 
 string 
 , 
 "readAuthorizerCredential" 
 : 
 { 
 object (  UserCredential 
 
) 
 } 
 , 
 "authorizerCredential" 
 : 
 { 
 object (  UserCredential 
 
) 
 } 
 }
    Fields
    workspace

    string

    Required. The Bitbucket Cloud Workspace ID to be connected to Google Cloud Platform.
    webhookSecretSecretVersion

    string

    Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as projects/*/secrets/*/versions/* . This is used to validate and create webhooks.
    readAuthorizerCredential

    object ( UserCredential )

    Required. An access token with the minimum repository access. It can either be a workspace, project or repository access token. It's recommended to use a system account to generate the credentials.
    authorizerCredential

    object ( UserCredential )

    Required. An access token with the minimum repository , pullrequest and webhook scope access. It can either be a workspace, project or repository access token. This is needed to create webhooks. It's recommended to use a system account to generate these credentials.

    InstallationState

    Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections.

    JSON representation 
     { 
 "stage" 
 : 
 enum (  Stage 
 
) 
 , 
 "message" 
 : 
 string 
 , 
 "actionUri" 
 : 
 string 
 }
    Fields
    stage

    enum ( Stage )

    Output only. Current step of the installation process.
    message

    string

    Output only. Message of what the user should do next to continue the installation. Empty string if the installation is already complete.
    actionUri

    string

    Output only. Link to follow for next action. Empty string if the installation is already complete.

    Stage

    Stage of the installation process.

    Enums
    STAGE_UNSPECIFIED No stage specified.
    PENDING_CREATE_APP Only for GitHub Enterprise. An App creation has been requested. The user needs to confirm the creation in their GitHub enterprise host.
    PENDING_USER_OAUTH User needs to authorize the GitHub (or Enterprise) App via OAuth.
    PENDING_INSTALL_APP User needs to follow the link to install the GitHub (or Enterprise) App.
    COMPLETE Installation process has been completed.

    CryptoKeyConfig

    The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature.

    JSON representation 
     { 
 "keyReference" 
 : 
 string 
 }
    Fields
    keyReference

    string

    Required. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of projects/*/locations/*/keyRings/*/cryptoKeys/* .

    GitProxyConfig

    The git proxy configuration.

    JSON representation 
     { 
 "enabled" 
 : 
 boolean 
 }
    Fields
    enabled

    boolean

    Optional. Setting this to true allows the git proxy to be used for performing git operations on the repositories linked in the connection.

    Methods

    create

    		Creates a new Connection in a given project and location.

    delete

    		Deletes a single Connection.

    fetchGitHubInstallations

    		FetchGitHubInstallations returns the list of GitHub Installations that are available to be added to a Connection.

    fetchLinkableGitRepositories

    		FetchLinkableGitRepositories returns a list of git repositories from an SCM that are available to be added to a Connection.

    get

    		Gets details of a single Connection.

    list

    		Lists Connections in a given project and location.

    patch

    		Updates the parameters of a single Connection.

    processGitHubEnterpriseWebhook

    		ProcessGitHubEnterpriseWebhook is called by the external GitHub Enterprise instances for notifying events.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: