Module org.kohsuke.github.api

Package org.kohsuke.github

Enum RateLimitTarget

java.lang.Object

java.lang.Enum<RateLimitTarget>

org.kohsuke.github.RateLimitTarget

All Implemented Interfaces:

Serializable, Comparable<RateLimitTarget>

public enum RateLimitTarget
extends Enum<RateLimitTarget>

Specifies the rate limit record of an operation.

See Also:

• GitHubBuilder.withRateLimitChecker(RateLimitChecker, RateLimitTarget)

Enum Constant Summary

Enum Constants

Enum Constant	Description
CORE	Selects or updates the GHRateLimit.getCore() record.
GRAPHQL	Selects or updates the GHRateLimit.getGraphQL() record.
INTEGRATION_MANIFEST	Selects or updates the GHRateLimit.getIntegrationManifest() record.
NONE	Selects no rate limit.
SEARCH	Selects or updates the GHRateLimit.getSearch() record.

Method Summary

Modifier and Type	Method	Description
static RateLimitTarget	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RateLimitTarget[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CORE

public static final RateLimitTarget CORE

Selects or updates the GHRateLimit.getCore() record.

SEARCH

public static final RateLimitTarget SEARCH

Selects or updates the GHRateLimit.getSearch() record.

GRAPHQL

public static final RateLimitTarget GRAPHQL

Selects or updates the GHRateLimit.getGraphQL() record.

INTEGRATION_MANIFEST

public static final RateLimitTarget INTEGRATION_MANIFEST

Selects or updates the GHRateLimit.getIntegrationManifest() record.

NONE

public static final RateLimitTarget NONE

Selects no rate limit. This request uses no rate limit. If the response header includes rate limit information, it will apply to CORE.

Method Details

values

public static RateLimitTarget[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RateLimitTarget 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.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null