Class GitHubEnterpriseConfig (3.26.0)

public final class GitHubEnterpriseConfig extends GeneratedMessageV3 implements GitHubEnterpriseConfigOrBuilder

Configuration for connections to an instance of GitHub Enterprise.

Protobuf type google.devtools.cloudbuild.v2.GitHubEnterpriseConfig

Static Fields

API_KEY_FIELD_NUMBER

public static final int API_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

APP_ID_FIELD_NUMBER

public static final int APP_ID_FIELD_NUMBER
Field Value
TypeDescription
int

APP_INSTALLATION_ID_FIELD_NUMBER

public static final int APP_INSTALLATION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

APP_SLUG_FIELD_NUMBER

public static final int APP_SLUG_FIELD_NUMBER
Field Value
TypeDescription
int

HOST_URI_FIELD_NUMBER

public static final int HOST_URI_FIELD_NUMBER
Field Value
TypeDescription
int

PRIVATE_KEY_SECRET_VERSION_FIELD_NUMBER

public static final int PRIVATE_KEY_SECRET_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

SERVER_VERSION_FIELD_NUMBER

public static final int SERVER_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_DIRECTORY_CONFIG_FIELD_NUMBER

public static final int SERVICE_DIRECTORY_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

SSL_CA_FIELD_NUMBER

public static final int SSL_CA_FIELD_NUMBER
Field Value
TypeDescription
int

WEBHOOK_SECRET_SECRET_VERSION_FIELD_NUMBER

public static final int WEBHOOK_SECRET_SECRET_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GitHubEnterpriseConfig getDefaultInstance()
Returns
TypeDescription
GitHubEnterpriseConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static GitHubEnterpriseConfig.Builder newBuilder()
Returns
TypeDescription
GitHubEnterpriseConfig.Builder

newBuilder(GitHubEnterpriseConfig prototype)

public static GitHubEnterpriseConfig.Builder newBuilder(GitHubEnterpriseConfig prototype)
Parameter
NameDescription
prototypeGitHubEnterpriseConfig
Returns
TypeDescription
GitHubEnterpriseConfig.Builder

parseDelimitedFrom(InputStream input)

public static GitHubEnterpriseConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GitHubEnterpriseConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GitHubEnterpriseConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GitHubEnterpriseConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static GitHubEnterpriseConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
GitHubEnterpriseConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GitHubEnterpriseConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GitHubEnterpriseConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GitHubEnterpriseConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GitHubEnterpriseConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GitHubEnterpriseConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GitHubEnterpriseConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GitHubEnterpriseConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GitHubEnterpriseConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GitHubEnterpriseConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GitHubEnterpriseConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static GitHubEnterpriseConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GitHubEnterpriseConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GitHubEnterpriseConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GitHubEnterpriseConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static GitHubEnterpriseConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GitHubEnterpriseConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GitHubEnterpriseConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GitHubEnterpriseConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<GitHubEnterpriseConfig> parser()
Returns
TypeDescription
Parser<GitHubEnterpriseConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getApiKey()

public String getApiKey()

Required. API Key used for authentication of webhook events.

string api_key = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The apiKey.

getApiKeyBytes()

public ByteString getApiKeyBytes()

Required. API Key used for authentication of webhook events.

string api_key = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for apiKey.

getAppId()

public long getAppId()

Id of the GitHub App created from the manifest.

int64 app_id = 2;

Returns
TypeDescription
long

The appId.

getAppInstallationId()

public long getAppInstallationId()

ID of the installation of the GitHub App.

int64 app_installation_id = 9;

Returns
TypeDescription
long

The appInstallationId.

getAppSlug()

public String getAppSlug()

The URL-friendly name of the GitHub App.

string app_slug = 13;

Returns
TypeDescription
String

The appSlug.

getAppSlugBytes()

public ByteString getAppSlugBytes()

The URL-friendly name of the GitHub App.

string app_slug = 13;

Returns
TypeDescription
ByteString

The bytes for appSlug.

getDefaultInstanceForType()

public GitHubEnterpriseConfig getDefaultInstanceForType()
Returns
TypeDescription
GitHubEnterpriseConfig

getHostUri()

public String getHostUri()

Required. The URI of the GitHub Enterprise host this connection is for.

string host_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The hostUri.

getHostUriBytes()

public ByteString getHostUriBytes()

Required. The URI of the GitHub Enterprise host this connection is for.

string host_uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for hostUri.

getParserForType()

public Parser<GitHubEnterpriseConfig> getParserForType()
Returns
TypeDescription
Parser<GitHubEnterpriseConfig>
Overrides

getPrivateKeySecretVersion()

public String getPrivateKeySecretVersion()

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

string private_key_secret_version = 4 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The privateKeySecretVersion.

getPrivateKeySecretVersionBytes()

public ByteString getPrivateKeySecretVersionBytes()

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

string private_key_secret_version = 4 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for privateKeySecretVersion.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServerVersion()

public String getServerVersion()

Output only. GitHub Enterprise version installed at the host_uri.

string server_version = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The serverVersion.

getServerVersionBytes()

public ByteString getServerVersionBytes()

Output only. GitHub Enterprise version installed at the host_uri.

string server_version = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for serverVersion.

getServiceDirectoryConfig()

public ServiceDirectoryConfig 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.

.google.devtools.cloudbuild.v2.ServiceDirectoryConfig service_directory_config = 10;

Returns
TypeDescription
ServiceDirectoryConfig

The serviceDirectoryConfig.

getServiceDirectoryConfigOrBuilder()

public ServiceDirectoryConfigOrBuilder getServiceDirectoryConfigOrBuilder()

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.

.google.devtools.cloudbuild.v2.ServiceDirectoryConfig service_directory_config = 10;

Returns
TypeDescription
ServiceDirectoryConfigOrBuilder

getSslCa()

public String getSslCa()

SSL certificate to use for requests to GitHub Enterprise.

string ssl_ca = 11;

Returns
TypeDescription
String

The sslCa.

getSslCaBytes()

public ByteString getSslCaBytes()

SSL certificate to use for requests to GitHub Enterprise.

string ssl_ca = 11;

Returns
TypeDescription
ByteString

The bytes for sslCa.

getWebhookSecretSecretVersion()

public String getWebhookSecretSecretVersion()

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

string webhook_secret_secret_version = 5 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The webhookSecretSecretVersion.

getWebhookSecretSecretVersionBytes()

public ByteString getWebhookSecretSecretVersionBytes()

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

string webhook_secret_secret_version = 5 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for webhookSecretSecretVersion.

hasServiceDirectoryConfig()

public boolean hasServiceDirectoryConfig()

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.

.google.devtools.cloudbuild.v2.ServiceDirectoryConfig service_directory_config = 10;

Returns
TypeDescription
boolean

Whether the serviceDirectoryConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public GitHubEnterpriseConfig.Builder newBuilderForType()
Returns
TypeDescription
GitHubEnterpriseConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GitHubEnterpriseConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
GitHubEnterpriseConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public GitHubEnterpriseConfig.Builder toBuilder()
Returns
TypeDescription
GitHubEnterpriseConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException