Package org.springframework.ai.openai.metadata.support

Enum Class OpenAiApiResponseHeaders

java.lang.Object

java.lang.Enum<OpenAiApiResponseHeaders>

org.springframework.ai.openai.metadata.support.OpenAiApiResponseHeaders

All Implemented Interfaces:

Serializable, Comparable<OpenAiApiResponseHeaders>, Constable

public enum OpenAiApiResponseHeaders
extends Enum<OpenAiApiResponseHeaders>

Enumeration of OpenAI API response headers.

Since:

0.7.0

Author:

John Blum

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
REQUESTS_LIMIT_HEADER
REQUESTS_REMAINING_HEADER
REQUESTS_RESET_HEADER
TOKENS_LIMIT_HEADER
TOKENS_REMAINING_HEADER
TOKENS_RESET_HEADER

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUESTS_LIMIT_HEADER

public static final OpenAiApiResponseHeaders REQUESTS_LIMIT_HEADER

REQUESTS_REMAINING_HEADER

public static final OpenAiApiResponseHeaders REQUESTS_REMAINING_HEADER

REQUESTS_RESET_HEADER

public static final OpenAiApiResponseHeaders REQUESTS_RESET_HEADER

TOKENS_RESET_HEADER

public static final OpenAiApiResponseHeaders TOKENS_RESET_HEADER

TOKENS_LIMIT_HEADER

public static final OpenAiApiResponseHeaders TOKENS_LIMIT_HEADER

TOKENS_REMAINING_HEADER

public static final OpenAiApiResponseHeaders TOKENS_REMAINING_HEADER

Method Details

values

public static OpenAiApiResponseHeaders[] values()

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

Returns:

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

valueOf

public static OpenAiApiResponseHeaders valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

getDescription

public String getDescription()