Package com.oracle.bmc.generativeaiagent.model

Enum HttpEndpointAuthConfig.HttpEndpointAuthConfigType

java.lang.Object

java.lang.Enum<HttpEndpointAuthConfig.HttpEndpointAuthConfigType>

com.oracle.bmc.generativeaiagent.model.HttpEndpointAuthConfig.HttpEndpointAuthConfigType

All Implemented Interfaces:

BmcEnum, Serializable, Comparable<HttpEndpointAuthConfig.HttpEndpointAuthConfigType>

Enclosing class:

HttpEndpointAuthConfig

public static enum HttpEndpointAuthConfig.HttpEndpointAuthConfigType
extends Enum<HttpEndpointAuthConfig.HttpEndpointAuthConfigType>
implements BmcEnum

The type of Auth config to be used when invoking an external endpoint.

The allowed values are: - HTTP_ENDPOINT_NO_AUTH_CONFIG: Indicates that no authentication is required for invoking the endpoint. - HTTP_ENDPOINT_DELEGATED_BEARER_AUTH_CONFIG: Specifies Bearer Token Authentication, where the same Bearer token received as part of the Agent Chat API request is used to invoke the external endpoint. - HTTP_ENDPOINT_OCI_RESOURCE_PRINCIPAL_AUTH_CONFIG: Specifies authentication using Oracle Cloud Infrastructure (OCI) Resource Principal, leveraging OCI’s identity-based authentication mechanism. - HTTP_ENDPOINT_IDCS_AUTH_CONFIG: Specifies authentication using Oracle Identity Cloud Service (IDCS), leveraging OAuth 2.0 for token-based authentication.

Enum Constant Summary

Enum Constants

Enum Constant	Description
HttpEndpointDelegatedBearerAuthConfig
HttpEndpointIdcsAuthConfig
HttpEndpointNoAuthConfig
HttpEndpointOciResourcePrincipalAuthConfig
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 HttpEndpointAuthConfig.HttpEndpointAuthConfigType	create(String key)
String	getValue()
static HttpEndpointAuthConfig.HttpEndpointAuthConfigType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HttpEndpointAuthConfig.HttpEndpointAuthConfigType[]	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

HttpEndpointNoAuthConfig

public static final HttpEndpointAuthConfig.HttpEndpointAuthConfigType HttpEndpointNoAuthConfig

HttpEndpointDelegatedBearerAuthConfig

public static final HttpEndpointAuthConfig.HttpEndpointAuthConfigType HttpEndpointDelegatedBearerAuthConfig

HttpEndpointOciResourcePrincipalAuthConfig

public static final HttpEndpointAuthConfig.HttpEndpointAuthConfigType HttpEndpointOciResourcePrincipalAuthConfig

HttpEndpointIdcsAuthConfig

public static final HttpEndpointAuthConfig.HttpEndpointAuthConfigType HttpEndpointIdcsAuthConfig

UnknownEnumValue

public static final HttpEndpointAuthConfig.HttpEndpointAuthConfigType 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 HttpEndpointAuthConfig.HttpEndpointAuthConfigType[] 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 (HttpEndpointAuthConfig.HttpEndpointAuthConfigType c : HttpEndpointAuthConfig.HttpEndpointAuthConfigType.values())
    System.out.println(c);

Returns:

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

valueOf

public static HttpEndpointAuthConfig.HttpEndpointAuthConfigType 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 HttpEndpointAuthConfig.HttpEndpointAuthConfigType create(String key)