GitHubAppRuntimeConfig (Quarkus - GitHub App - Runtime 1.10.2 API)

java.lang.Object
- io.quarkiverse.githubapp.runtime.config.GitHubAppRuntimeConfig

@ConfigRoot(name="github-app",
            phase=RUN_TIME)
public class GitHubAppRuntimeConfig
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GitHubAppRuntimeConfig.Debug

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`appId`	The numeric application id provided by GitHub.
`Optional<String>`	`appName`	The GitHub name of the application.
`GitHubAppRuntimeConfig.Debug`	`debug`	Debug configuration.
`String`	`instanceEndpoint`	The GitHub instance endpoint.
`PrivateKey`	`privateKey`	The RSA private key.
`boolean`	`readConfigFilesFromSourceRepository`	Read the configuration files from the source repository in case of a fork.
`Optional<String>`	`webhookProxyUrl`	The Smee.io proxy URL used when testing locally.
`Optional<String>`	`webhookSecret`	The webhook secret if defined in the GitHub UI.

Constructor Summary

Constructors
Constructor Description

GitHubAppRuntimeConfig()

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - appId
```
@ConfigItem
public String appId
```
    The numeric application id provided by GitHub.
  - appName
```
@ConfigItem
public Optional<String> appName
```
    The GitHub name of the application.
    Optional, only used for improving the user experience.
  - readConfigFilesFromSourceRepository
```
@ConfigItem(defaultValue="false")
public boolean readConfigFilesFromSourceRepository
```
    Read the configuration files from the source repository in case of a fork.
  - privateKey
```
@ConfigItem
@ConvertWith(PrivateKeyConverter.class)
public PrivateKey privateKey
```
    The RSA private key.
  - webhookSecret
```
@ConfigItem
public Optional<String> webhookSecret
```
    The webhook secret if defined in the GitHub UI.
  - webhookProxyUrl
```
@ConfigItem
public Optional<String> webhookProxyUrl
```
    The Smee.io proxy URL used when testing locally.
  - instanceEndpoint
```
@ConfigItem(defaultValue="https://api.github.com")
public String instanceEndpoint
```
    The GitHub instance endpoint.
    Defaults to the public github.com instance.
  - debug
```
@ConfigItem
public GitHubAppRuntimeConfig.Debug debug
```
    Debug configuration.
- Constructor Detail
  - GitHubAppRuntimeConfig
```
public GitHubAppRuntimeConfig()
```