Resource: Connection
Message describing Connection object
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "deleteTime": string, "labels": { string: string, ... }, "installationState": { object ( |
Fields | |
---|---|
name |
Identifier. The resource name of the connection, in the format |
createTime |
Output only. [Output only] Create timestamp A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. [Output only] Update timestamp A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
deleteTime |
Output only. [Output only] Delete timestamp A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Optional. Labels as key value pairs An object containing a list of |
installationState |
Output only. Installation state of the Connection. |
disabled |
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 |
Output only. Set to true when the connection is being set up or updated in the background. |
annotations |
Optional. Allows clients to store small amounts of arbitrary data. An object containing a list of |
etag |
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 |
Output only. A system-assigned unique identifier for a the GitRepositoryLink. |
Union field connection_config . Configuration for the connection depending on the type of provider. connection_config can be only one of the following: |
|
githubConfig |
Configuration for connections to github.com. |
GitHubConfig
Configuration for connections to github.com.
JSON representation |
---|
{ "githubApp": enum ( |
Fields | |
---|---|
githubApp |
Required. Immutable. The GitHub Application that was installed to the GitHub user or organization. |
authorizerCredential |
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 |
Optional. GitHub App installation id. |
installationUri |
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 |
Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: |
username |
Output only. The username associated with this token. |
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 ( |
Fields | |
---|---|
stage |
Output only. Current step of the installation process. |
message |
Output only. Message of what the user should do next to continue the installation. Empty string if the installation is already complete. |
actionUri |
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. |
Methods |
|
---|---|
|
Creates a new Connection in a given project and location. |
|
Deletes a single Connection. |
|
FetchGitHubInstallations returns the list of GitHub Installations that are available to be added to a Connection. |
|
FetchLinkableGitRepositories returns a list of git repositories from an SCM that are available to be added to a Connection. |
|
Gets details of a single Connection. |
|
Lists Connections in a given project and location. |
|
Updates the parameters of a single Connection. |