Reference documentation and code samples for the Google Cloud Build V1 Client class GitHubEnterpriseConfig.
Generated from protobuf message google.devtools.cloudbuild.v1.GitHubEnterpriseConfig
Namespace
Google \ Cloud \ Build \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" |
↳ host_url |
string
The URL of the github enterprise host the configuration is for. |
↳ app_id |
int|string
Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when the installation was associated with the project. |
↳ webhook_key |
string
The key that should be attached to webhook calls to the ReceiveWebhook endpoint. |
↳ peered_network |
string
Optional. 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 |
↳ secrets |
Google\Cloud\Build\V1\GitHubEnterpriseSecrets
Names of secrets in Secret Manager. |
↳ display_name |
string
Name to display for this config. |
↳ ssl_ca |
string
Optional. SSL certificate to use for requests to GitHub Enterprise. |
getName
Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHostUrl
The URL of the github enterprise host the configuration is for.
| Returns | |
|---|---|
| Type | Description |
string | |
setHostUrl
The URL of the github enterprise host the configuration is for.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAppId
Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setAppId
Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Time when the installation was associated with the project.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the installation was associated with the project.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWebhookKey
The key that should be attached to webhook calls to the ReceiveWebhook endpoint.
| Returns | |
|---|---|
| Type | Description |
string | |
setWebhookKey
The key that should be attached to webhook calls to the ReceiveWebhook endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPeeredNetwork
Optional. 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.
| Returns | |
|---|---|
| Type | Description |
string | |
setPeeredNetwork
Optional. 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSecrets
Names of secrets in Secret Manager.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Build\V1\GitHubEnterpriseSecrets|null | |
hasSecrets
clearSecrets
setSecrets
Names of secrets in Secret Manager.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Build\V1\GitHubEnterpriseSecrets
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Name to display for this config.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Name to display for this config.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSslCa
Optional. SSL certificate to use for requests to GitHub Enterprise.
| Returns | |
|---|---|
| Type | Description |
string | |
setSslCa
Optional. SSL certificate to use for requests to GitHub Enterprise.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |