Package org.a2aproject.sdk.spec

Enum Class APIKeySecurityScheme.Location

java.lang.Object

java.lang.Enum<APIKeySecurityScheme.Location>

org.a2aproject.sdk.spec.APIKeySecurityScheme.Location

All Implemented Interfaces:

Serializable, Comparable<APIKeySecurityScheme.Location>, Constable

Enclosing class:

APIKeySecurityScheme

public static enum APIKeySecurityScheme.Location
extends Enum<APIKeySecurityScheme.Location>

Represents the location of the API key.

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
COOKIE	API key sent in a cookie.
HEADER	API key sent in an HTTP header.
QUERY	API key sent as a query parameter.

Method Summary

Modifier and Type	Method	Description
String	asString()	Converts this location to its string representation.
static APIKeySecurityScheme.Location	fromString(String location)	Converts a string to a Location enum value.
static APIKeySecurityScheme.Location	valueOf(String name)	Returns the enum constant of this class with the specified name.
static APIKeySecurityScheme.Location[]	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

COOKIE

public static final APIKeySecurityScheme.Location COOKIE

API key sent in a cookie.

HEADER

public static final APIKeySecurityScheme.Location HEADER

API key sent in an HTTP header.

QUERY

public static final APIKeySecurityScheme.Location QUERY

API key sent as a query parameter.

Method Details

values

public static APIKeySecurityScheme.Location[] 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 APIKeySecurityScheme.Location 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

asString

public String asString()

Converts this location to its string representation.

Returns:

the string representation of this location

fromString

public static APIKeySecurityScheme.Location fromString(String location)

Converts a string to a Location enum value.

Parameters:

location - the string location ("cookie", "header", or "query")

Returns:

the corresponding Location enum value

Throws:

IllegalArgumentException - if the location string is invalid