GitHubEnterpriseConfig

google.devtools.cloudbuild.v2. GitHubEnterpriseConfig

Represents a GitHubEnterpriseConfig.

Constructor

new GitHubEnterpriseConfig(propertiesopt)

Constructs a new GitHubEnterpriseConfig.

Parameters:
Name Type Attributes Description
properties google.devtools.cloudbuild.v2.IGitHubEnterpriseConfig <optional>

Properties to set

Implements:
  • IGitHubEnterpriseConfig

Members

apiKey

GitHubEnterpriseConfig apiKey.

appId

GitHubEnterpriseConfig appId.

appInstallationId

GitHubEnterpriseConfig appInstallationId.

appSlug

GitHubEnterpriseConfig appSlug.

hostUri

GitHubEnterpriseConfig hostUri.

privateKeySecretVersion

GitHubEnterpriseConfig privateKeySecretVersion.

serverVersion

GitHubEnterpriseConfig serverVersion.

serviceDirectoryConfig

GitHubEnterpriseConfig serviceDirectoryConfig.

sslCa

GitHubEnterpriseConfig sslCa.

webhookSecretSecretVersion

GitHubEnterpriseConfig webhookSecretSecretVersion.

Methods

toJSON() → {Object.<string, *>}

Converts this GitHubEnterpriseConfig to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.devtools.cloudbuild.v2.GitHubEnterpriseConfig}

Creates a new GitHubEnterpriseConfig instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.devtools.cloudbuild.v2.IGitHubEnterpriseConfig <optional>

Properties to set

Returns:
Type Description
google.devtools.cloudbuild.v2.GitHubEnterpriseConfig

GitHubEnterpriseConfig instance

(static) decode(reader, lengthopt) → {google.devtools.cloudbuild.v2.GitHubEnterpriseConfig}

Decodes a GitHubEnterpriseConfig message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.devtools.cloudbuild.v2.GitHubEnterpriseConfig

GitHubEnterpriseConfig

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.devtools.cloudbuild.v2.GitHubEnterpriseConfig}

Decodes a GitHubEnterpriseConfig message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.devtools.cloudbuild.v2.GitHubEnterpriseConfig

GitHubEnterpriseConfig

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified GitHubEnterpriseConfig message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.devtools.cloudbuild.v2.IGitHubEnterpriseConfig

GitHubEnterpriseConfig message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified GitHubEnterpriseConfig message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.devtools.cloudbuild.v2.IGitHubEnterpriseConfig

GitHubEnterpriseConfig message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.devtools.cloudbuild.v2.GitHubEnterpriseConfig}

Creates a GitHubEnterpriseConfig message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.devtools.cloudbuild.v2.GitHubEnterpriseConfig

GitHubEnterpriseConfig

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for GitHubEnterpriseConfig

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a GitHubEnterpriseConfig message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.devtools.cloudbuild.v2.GitHubEnterpriseConfig

GitHubEnterpriseConfig

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a GitHubEnterpriseConfig message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not