Enum ApiRateLimitChecker

    • Enum Constant Detail

      • ThrottleForNormalize

        public static final ApiRateLimitChecker ThrottleForNormalize
        Attempt to evenly distribute GitHub API requests.
      • ThrottleOnOver

        public static final ApiRateLimitChecker ThrottleOnOver
        Restrict GitHub API requests only when near or above rate limit.
      • NoThrottle

        public static final ApiRateLimitChecker NoThrottle
        Ignore GitHub API Rate limit. Useful for GitHub Enterprise instances that might not have a limit set up.
    • Method Detail

      • values

        public static ApiRateLimitChecker[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ApiRateLimitChecker c : ApiRateLimitChecker.values())
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ApiRateLimitChecker valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        name - the name of the enum constant to be returned.
        the enum constant with the specified name
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • getDisplayName

        public String getDisplayName()
      • configureThreadLocalChecker

        public static void configureThreadLocalChecker​(@NonNull
                                                       TaskListener listener,
                                                       org.kohsuke.github.GitHub gitHub)
      • getChecker

        public abstract org.jenkinsci.plugins.github_branch_source.ApiRateLimitChecker.LocalChecker getChecker​(@NonNull
                                                                                                               TaskListener listener,
                                                                                                               String apiUrl)