Google Cloud Developer Connect V1 Client - Class GitHubEnterpriseConfig (0.5.1)

Reference documentation and code samples for the Google Cloud Developer Connect V1 Client class GitHubEnterpriseConfig.

Configuration for connections to an instance of GitHub Enterprise.

Generated from protobuf message google.cloud.developerconnect.v1.GitHubEnterpriseConfig

Namespace

Google \ Cloud \ DeveloperConnect \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ host_uri string

Required. The URI of the GitHub Enterprise host this connection is for.
↳ app_id int|string

Optional. ID of the GitHub App created from the manifest.
↳ app_slug string

Output only. The URL-friendly name of the GitHub App.
↳ private_key_secret_version string

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

Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as projects/*/secrets/*/versions/*.
↳ app_installation_id int|string

Optional. ID of the installation of the GitHub App.
↳ installation_uri string

Output only. The URI to navigate to in order to manage the installation associated with this GitHubEnterpriseConfig.
↳ service_directory_config 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.
↳ server_version string

Output only. GitHub Enterprise version installed at the host_uri.
↳ ssl_ca_certificate string

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

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

getAppId

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

Returns
Type Description
int|string

setAppId

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getAppSlug

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

Returns
Type Description
string

setAppSlug

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

Parameter
Name Description
var string
Returns
Type Description
$this

getPrivateKeySecretVersion

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

Returns
Type Description
string

setPrivateKeySecretVersion

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

Parameter
Name Description
var string
Returns
Type Description
$this

getWebhookSecretSecretVersion

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

Returns
Type Description
string

setWebhookSecretSecretVersion

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

Parameter
Name Description
var string
Returns
Type Description
$this

getAppInstallationId

Optional. ID of the installation of the GitHub App.

Returns
Type Description
int|string

setAppInstallationId

Optional. ID of the installation of the GitHub App.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getInstallationUri

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

Returns
Type Description
string

setInstallationUri

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

Parameter
Name Description
var string
Returns
Type Description
$this

getServiceDirectoryConfig

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.

Returns
Type Description
ServiceDirectoryConfig|null

hasServiceDirectoryConfig

clearServiceDirectoryConfig

setServiceDirectoryConfig

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.

Parameter
Name Description
var ServiceDirectoryConfig
Returns
Type Description
$this

getServerVersion

Output only. GitHub Enterprise version installed at the host_uri.

Returns
Type Description
string

setServerVersion

Output only. GitHub Enterprise version installed at the host_uri.

Parameter
Name Description
var string
Returns
Type Description
$this

getSslCaCertificate

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

Returns
Type Description
string

setSslCaCertificate

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

Parameter
Name Description
var string
Returns
Type Description
$this