Package com.oracle.bmc.generativeaiagent.model

Enum HttpEndpointApiKeyAuthScopeConfig.KeyLocation

java.lang.Object

java.lang.Enum<HttpEndpointApiKeyAuthScopeConfig.KeyLocation>

com.oracle.bmc.generativeaiagent.model.HttpEndpointApiKeyAuthScopeConfig.KeyLocation

All Implemented Interfaces:

BmcEnum, Serializable, Comparable<HttpEndpointApiKeyAuthScopeConfig.KeyLocation>

Enclosing class:

HttpEndpointApiKeyAuthScopeConfig

public static enum HttpEndpointApiKeyAuthScopeConfig.KeyLocation
extends Enum<HttpEndpointApiKeyAuthScopeConfig.KeyLocation>
implements BmcEnum

The location of the API key in the request.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Header
QueryParameter
UnknownEnumValue	This value is used if a service returns a value for this enum that is not recognized by this version of the SDK.

Method Summary

Modifier and Type	Method	Description
static HttpEndpointApiKeyAuthScopeConfig.KeyLocation	create(String key)
String	getValue()
static HttpEndpointApiKeyAuthScopeConfig.KeyLocation	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HttpEndpointApiKeyAuthScopeConfig.KeyLocation[]	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 Detail

Header

public static final HttpEndpointApiKeyAuthScopeConfig.KeyLocation Header

QueryParameter

public static final HttpEndpointApiKeyAuthScopeConfig.KeyLocation QueryParameter

UnknownEnumValue

public static final HttpEndpointApiKeyAuthScopeConfig.KeyLocation UnknownEnumValue

This value is used if a service returns a value for this enum that is not recognized by this version of the SDK.

Method Detail

values

public static HttpEndpointApiKeyAuthScopeConfig.KeyLocation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HttpEndpointApiKeyAuthScopeConfig.KeyLocation c : HttpEndpointApiKeyAuthScopeConfig.KeyLocation.values())
    System.out.println(c);

Returns:

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

valueOf

public static HttpEndpointApiKeyAuthScopeConfig.KeyLocation 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

getValue

public String getValue()

Specified by:

getValue in interface BmcEnum

create

public static HttpEndpointApiKeyAuthScopeConfig.KeyLocation create(String key)