Skip to main content

github_enterprise_configs

Overview

Namegithub_enterprise_configs
TypeResource
Idgoogle.cloudbuild.github_enterprise_configs

Fields

NameDatatypeDescription
namestringOptional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
appIdstringRequired. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
displayNamestringName to display for this config.
webhookKeystringThe key that should be attached to webhook calls to the ReceiveWebhook endpoint.
peeredNetworkstringOptional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number or id and {network} is the name of a VPC network in the project.
secretsobjectGitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/.
createTimestringOutput only. Time when the installation was associated with the project.
hostUrlstringThe URL of the github enterprise host the configuration is for.
sslCastringOptional. SSL certificate to use for requests to GitHub Enterprise.

Methods

NameAccessible byRequired ParamsDescription
projects_github_enterprise_configs_getSELECTgithubEnterpriseConfigsId, projectsIdRetrieve a GitHubEnterpriseConfig.
projects_github_enterprise_configs_listSELECTprojectsIdList all GitHubEnterpriseConfigs for a given project.
projects_locations_github_enterprise_configs_getSELECTgithubEnterpriseConfigsId, locationsId, projectsIdRetrieve a GitHubEnterpriseConfig.
projects_locations_github_enterprise_configs_listSELECTlocationsId, projectsIdList all GitHubEnterpriseConfigs for a given project.
projects_github_enterprise_configs_createINSERTprojectsIdCreate an association between a GCP project and a GitHub Enterprise server.
projects_locations_github_enterprise_configs_createINSERTlocationsId, projectsIdCreate an association between a GCP project and a GitHub Enterprise server.
projects_github_enterprise_configs_deleteDELETEgithubEnterpriseConfigsId, projectsIdDelete an association between a GCP project and a GitHub Enterprise server.
projects_locations_github_enterprise_configs_deleteDELETEgithubEnterpriseConfigsId, locationsId, projectsIdDelete an association between a GCP project and a GitHub Enterprise server.
projects_github_enterprise_configs_patchEXECgithubEnterpriseConfigsId, projectsIdUpdate an association between a GCP project and a GitHub Enterprise server.
projects_locations_github_enterprise_configs_patchEXECgithubEnterpriseConfigsId, locationsId, projectsIdUpdate an association between a GCP project and a GitHub Enterprise server.