Package com.microsoft.kiota.authentication

Enum Class ApiKeyLocation

java.lang.Object

java.lang.Enum<ApiKeyLocation>

com.microsoft.kiota.authentication.ApiKeyLocation

All Implemented Interfaces:

Serializable, Comparable<ApiKeyLocation>, Constable

public enum ApiKeyLocation
extends Enum<ApiKeyLocation>

The location of the API key in the request.

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
HEADER	Add the API key as request header
QUERY_PARAMETER	Add the API key as a query parameter

Method Summary

Modifier and Type	Method	Description
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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

QUERY_PARAMETER

public static final ApiKeyLocation QUERY_PARAMETER

Add the API key as a query parameter

HEADER

public static final ApiKeyLocation HEADER

Add the API key as request header

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