Configuration reference

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

Rate limiting configuration

Type

Default

quarkus.github-api.rate-limit.throttle.enabled

Whether proactive throttling is enabled.

Defaults to true in production and dev mode, false in tests.

Environment variable: QUARKUS_GITHUB_API_RATE_LIMIT_THROTTLE_ENABLED

boolean

quarkus.github-api.rate-limit.throttle.read

Delay between page fetches when using io.quarkiverse.githubapi.GitHubApiUtil#toStream(org.kohsuke.github.PagedIterable) or io.quarkiverse.githubapi.GitHubApiUtil#sleepForReadThrottling().

Environment variable: QUARKUS_GITHUB_API_RATE_LIMIT_THROTTLE_READ

Duration 

0.2S

quarkus.github-api.rate-limit.throttle.write

Delay between write/delete operations when using io.quarkiverse.githubapi.GitHubApiUtil#sleepForWriteThrottling().

Environment variable: QUARKUS_GITHUB_API_RATE_LIMIT_THROTTLE_WRITE

Duration 

1S

quarkus.github-api.rate-limit.retry.max-attempts

Maximum number of retry attempts when a GitHub API call is denied due to a secondary rate limit.

Maps to the hub4j/github-api retry count. If not set, the default from hub4j/github-api applies (2 retries).

Environment variable: QUARKUS_GITHUB_API_RATE_LIMIT_RETRY_MAX_ATTEMPTS

int
About the Duration format

To write duration values, use the standard java.time.Duration format. See the Duration#parse() Java API documentation for more information.

You can also use a simplified format, starting with a number:

  • If the value is only a number, it represents time in seconds.

  • If the value is a number followed by ms, it represents time in milliseconds.

In other cases, the simplified format is translated to the java.time.Duration format for parsing:

  • If the value is a number followed by h, m, or s, it is prefixed with PT.

  • If the value is a number followed by d, it is prefixed with P.