com.google.api.services.cloudbuild.v1.model

Class GitHubEnterpriseConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudbuild.v1.model.GitHubEnterpriseConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GitHubEnterpriseConfig
extends com.google.api.client.json.GenericJson

GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Build API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GitHubEnterpriseConfig()

Method Summary

Modifier and Type	Method and Description
GitHubEnterpriseConfig	clone()
Long	getAppId() Required.
String	getCreateTime() Output only.
String	getDisplayName() Name to display for this config.
String	getHostUrl() The URL of the github enterprise host the configuration is for.
String	getName() Optional.
String	getPeeredNetwork() Optional.
GitHubEnterpriseSecrets	getSecrets() Names of secrets in Secret Manager.
String	getSslCa() Optional.
String	getWebhookKey() The key that should be attached to webhook calls to the ReceiveWebhook endpoint.
GitHubEnterpriseConfig	set(String fieldName, Object value)
GitHubEnterpriseConfig	setAppId(Long appId) Required.
GitHubEnterpriseConfig	setCreateTime(String createTime) Output only.
GitHubEnterpriseConfig	setDisplayName(String displayName) Name to display for this config.
GitHubEnterpriseConfig	setHostUrl(String hostUrl) The URL of the github enterprise host the configuration is for.
GitHubEnterpriseConfig	setName(String name) Optional.
GitHubEnterpriseConfig	setPeeredNetwork(String peeredNetwork) Optional.
GitHubEnterpriseConfig	setSecrets(GitHubEnterpriseSecrets secrets) Names of secrets in Secret Manager.
GitHubEnterpriseConfig	setSslCa(String sslCa) Optional.
GitHubEnterpriseConfig	setWebhookKey(String webhookKey) The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GitHubEnterpriseConfig

public GitHubEnterpriseConfig()

Method Detail

getAppId

public Long getAppId()

Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.

Returns:

value or null for none

setAppId

public GitHubEnterpriseConfig setAppId(Long appId)

Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server.

Parameters:

appId - appId or null for none

getCreateTime

public String getCreateTime()

Output only. Time when the installation was associated with the project.

Returns:

value or null for none

setCreateTime

public GitHubEnterpriseConfig setCreateTime(String createTime)

Output only. Time when the installation was associated with the project.

Parameters:

createTime - createTime or null for none

getDisplayName

public String getDisplayName()

Name to display for this config.

Returns:

value or null for none

setDisplayName

public GitHubEnterpriseConfig setDisplayName(String displayName)

Name to display for this config.

Parameters:

displayName - displayName or null for none

getHostUrl

public String getHostUrl()

The URL of the github enterprise host the configuration is for.

Returns:

value or null for none

setHostUrl

public GitHubEnterpriseConfig setHostUrl(String hostUrl)

The URL of the github enterprise host the configuration is for.

Parameters:

hostUrl - hostUrl or null for none

getName

public String getName()

Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"

Returns:

value or null for none

setName

public GitHubEnterpriseConfig setName(String name)

Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}"

Parameters:

name - name or null for none

getPeeredNetwork

public String 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:

value or null for none

setPeeredNetwork

public GitHubEnterpriseConfig setPeeredNetwork(String peeredNetwork)

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.

Parameters:

peeredNetwork - peeredNetwork or null for none

getSecrets

public GitHubEnterpriseSecrets getSecrets()

Names of secrets in Secret Manager.

Returns:

value or null for none

setSecrets

public GitHubEnterpriseConfig setSecrets(GitHubEnterpriseSecrets secrets)

Names of secrets in Secret Manager.

Parameters:

secrets - secrets or null for none

getSslCa

public String getSslCa()

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

Returns:

value or null for none

setSslCa

public GitHubEnterpriseConfig setSslCa(String sslCa)

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

Parameters:

sslCa - sslCa or null for none

getWebhookKey

public String getWebhookKey()

The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

Returns:

value or null for none

setWebhookKey

public GitHubEnterpriseConfig setWebhookKey(String webhookKey)

The key that should be attached to webhook calls to the ReceiveWebhook endpoint.

Parameters:

webhookKey - webhookKey or null for none

set

public GitHubEnterpriseConfig set(String fieldName,
                                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GitHubEnterpriseConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson