Package com.mulesoft.connectors.a2a.api.model.card.security

Enum Class ApiKeyLocation

java.lang.Object

java.lang.Enum<ApiKeyLocation>

com.mulesoft.connectors.a2a.api.model.card.security.ApiKeyLocation

All Implemented Interfaces:

Serializable, Comparable<ApiKeyLocation>, Constable

public enum ApiKeyLocation
extends Enum<ApiKeyLocation>

Enumeration of API key locations in HTTP requests.

These values define where the API key can be placed in the request as specified in OpenAPI 3.0 specification.

Since:

1.0.0

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 is passed as a cookie parameter.
HEADER	API key is passed as a header parameter.
QUERY	API key is passed as a query parameter.

Method Summary

Modifier and Type	Method	Description
static ApiKeyLocation	fromValue(String value)	Gets the ApiKeyLocation from a string value.
String	getValue()	Gets the string value of the API key location.
String	toString()
static ApiKeyLocation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ApiKeyLocation[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

QUERY

public static final ApiKeyLocation QUERY

API key is passed as a query parameter.

HEADER

public static final ApiKeyLocation HEADER

API key is passed as a header parameter.

COOKIE

public static final ApiKeyLocation COOKIE

API key is passed as a cookie parameter.

Method Details

values

public static ApiKeyLocation[] 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 ApiKeyLocation 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

getValue

public String getValue()

Gets the string value of the API key location.

Returns:

The string value

fromValue

public static ApiKeyLocation fromValue(String value)

Gets the ApiKeyLocation from a string value.

Parameters:

value - The string value to convert

Returns:

The corresponding ApiKeyLocation, or null if not found

toString

public String toString()

Overrides:

toString in class Enum<ApiKeyLocation>