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.
↳ ssl_ca
string
SSL certificate to use for requests to GitHub Enterprise.
↳ server_version
string
Output only. GitHub Enterprise version installed at the host_uri.
getHostUri
Required. The URI of the GitHub Enterprise host this connection is for.
Returns
Type
Description
string
setHostUri
Required. The URI of the GitHub Enterprise host this connection is for.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getApiKey
Required. API Key used for authentication of webhook events.
Returns
Type
Description
string
setApiKey
Required. API Key used for authentication of webhook events.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAppId
Id of the GitHub App created from the manifest.
Returns
Type
Description
int|string
setAppId
Id of the GitHub App created from the manifest.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getAppSlug
The URL-friendly name of the GitHub App.
Returns
Type
Description
string
setAppSlug
The URL-friendly name of the GitHub App.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPrivateKeySecretVersion
SecretManager resource containing the private key of the GitHub App,
formatted asprojects/*/secrets/*/versions/*.
Returns
Type
Description
string
setPrivateKeySecretVersion
SecretManager resource containing the private key of the GitHub App,
formatted asprojects/*/secrets/*/versions/*.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getWebhookSecretSecretVersion
SecretManager resource containing the webhook secret of the GitHub App,
formatted asprojects/*/secrets/*/versions/*.
Returns
Type
Description
string
setWebhookSecretSecretVersion
SecretManager resource containing the webhook secret of the GitHub App,
formatted asprojects/*/secrets/*/versions/*.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAppInstallationId
ID of the installation of the GitHub App.
Returns
Type
Description
int|string
setAppInstallationId
ID of the installation of the GitHub App.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getServiceDirectoryConfig
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Build V2 Client - Class GitHubEnterpriseConfig (1.0.4)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.4 (latest)](/php/docs/reference/cloud-build/latest/V2.GitHubEnterpriseConfig)\n- [1.0.3](/php/docs/reference/cloud-build/1.0.3/V2.GitHubEnterpriseConfig)\n- [0.16.3](/php/docs/reference/cloud-build/0.16.3/V2.GitHubEnterpriseConfig)\n- [0.15.0](/php/docs/reference/cloud-build/0.15.0/V2.GitHubEnterpriseConfig)\n- [0.14.0](/php/docs/reference/cloud-build/0.14.0/V2.GitHubEnterpriseConfig)\n- [0.13.2](/php/docs/reference/cloud-build/0.13.2/V2.GitHubEnterpriseConfig)\n- [0.12.0](/php/docs/reference/cloud-build/0.12.0/V2.GitHubEnterpriseConfig)\n- [0.11.0](/php/docs/reference/cloud-build/0.11.0/V2.GitHubEnterpriseConfig)\n- [0.10.0](/php/docs/reference/cloud-build/0.10.0/V2.GitHubEnterpriseConfig)\n- [0.9.0](/php/docs/reference/cloud-build/0.9.0/V2.GitHubEnterpriseConfig)\n- [0.8.0](/php/docs/reference/cloud-build/0.8.0/V2.GitHubEnterpriseConfig)\n- [0.7.3](/php/docs/reference/cloud-build/0.7.3/V2.GitHubEnterpriseConfig)\n- [0.6.1](/php/docs/reference/cloud-build/0.6.1/V2.GitHubEnterpriseConfig)\n- [0.5.1](/php/docs/reference/cloud-build/0.5.1/V2.GitHubEnterpriseConfig)\n- [0.4.0](/php/docs/reference/cloud-build/0.4.0/V2.GitHubEnterpriseConfig)\n- [0.3.8](/php/docs/reference/cloud-build/0.3.8/V2.GitHubEnterpriseConfig) \nReference documentation and code samples for the Google Cloud Build V2 Client class GitHubEnterpriseConfig.\n\nConfiguration for connections to an instance of GitHub Enterprise.\n\nGenerated from protobuf message `google.devtools.cloudbuild.v2.GitHubEnterpriseConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Build \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getHostUri\n\nRequired. The URI of the GitHub Enterprise host this connection is for.\n\n### setHostUri\n\nRequired. The URI of the GitHub Enterprise host this connection is for.\n\n### getApiKey\n\nRequired. API Key used for authentication of webhook events.\n\n### setApiKey\n\nRequired. API Key used for authentication of webhook events.\n\n### getAppId\n\nId of the GitHub App created from the manifest.\n\n### setAppId\n\nId of the GitHub App created from the manifest.\n\n### getAppSlug\n\nThe URL-friendly name of the GitHub App.\n\n### setAppSlug\n\nThe URL-friendly name of the GitHub App.\n\n### getPrivateKeySecretVersion\n\nSecretManager resource containing the private key of the GitHub App,\nformatted as `projects/*/secrets/*/versions/*`.\n\n### setPrivateKeySecretVersion\n\nSecretManager resource containing the private key of the GitHub App,\nformatted as `projects/*/secrets/*/versions/*`.\n\n### getWebhookSecretSecretVersion\n\nSecretManager resource containing the webhook secret of the GitHub App,\nformatted as `projects/*/secrets/*/versions/*`.\n\n### setWebhookSecretSecretVersion\n\nSecretManager resource containing the webhook secret of the GitHub App,\nformatted as `projects/*/secrets/*/versions/*`.\n\n### getAppInstallationId\n\nID of the installation of the GitHub App.\n\n### setAppInstallationId\n\nID of the installation of the GitHub App.\n\n### getServiceDirectoryConfig\n\nConfiguration for using Service Directory to privately connect to a GitHub\nEnterprise server. This should only be set if the GitHub Enterprise server\nis hosted on-premises and not reachable by public internet. If this field\nis left empty, calls to the GitHub Enterprise server will be made over the\npublic internet.\n\n### hasServiceDirectoryConfig\n\n### clearServiceDirectoryConfig\n\n### setServiceDirectoryConfig\n\nConfiguration for using Service Directory to privately connect to a GitHub\nEnterprise server. This should only be set if the GitHub Enterprise server\nis hosted on-premises and not reachable by public internet. If this field\nis left empty, calls to the GitHub Enterprise server will be made over the\npublic internet.\n\n### getSslCa\n\nSSL certificate to use for requests to GitHub Enterprise.\n\n### setSslCa\n\nSSL certificate to use for requests to GitHub Enterprise.\n\n### getServerVersion\n\nOutput only. GitHub Enterprise version installed at the host_uri.\n\n### setServerVersion\n\nOutput only. GitHub Enterprise version installed at the host_uri."]]
