Package com.oracle.bmc.generativeaiagent.model

Class HttpEndpointApiKeyAuthScopeConfig

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiagent.model.HttpEndpointAuthScopeConfig

com.oracle.bmc.generativeaiagent.model.HttpEndpointApiKeyAuthScopeConfig

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class HttpEndpointApiKeyAuthScopeConfig
extends HttpEndpointAuthScopeConfig

Specifies authentication using an API key injected either as a header or query parameter.

- If authScope = AGENT: The API key is retrieved from OCI Vault using the agent\u2019s identity.
Note: Objects should always be created or deserialized using the HttpEndpointApiKeyAuthScopeConfig.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the HttpEndpointApiKeyAuthScopeConfig.Builder, which maintain a set of all explicitly set fields called HttpEndpointApiKeyAuthScopeConfig.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpEndpointApiKeyAuthScopeConfig.Builder
static class	HttpEndpointApiKeyAuthScopeConfig.KeyLocation	The location of the API key in the request.

Nested classes/interfaces inherited from class com.oracle.bmc.generativeaiagent.model.HttpEndpointAuthScopeConfig

HttpEndpointAuthScopeConfig.HttpEndpointAuthScopeConfigType

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
HttpEndpointApiKeyAuthScopeConfig(String vaultSecretId, HttpEndpointApiKeyAuthScopeConfig.KeyLocation keyLocation, String keyName)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static HttpEndpointApiKeyAuthScopeConfig.Builder	builder()	Create a new builder.
boolean	equals(Object o)
HttpEndpointApiKeyAuthScopeConfig.KeyLocation	getKeyLocation()	The location of the API key in the request.
String	getKeyName()	The name of the key parameter in the location.
String	getVaultSecretId()	The OCID of the vault secret with API key.
int	hashCode()
HttpEndpointApiKeyAuthScopeConfig.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpEndpointApiKeyAuthScopeConfig

@Deprecated
public HttpEndpointApiKeyAuthScopeConfig(String vaultSecretId,
                                         HttpEndpointApiKeyAuthScopeConfig.KeyLocation keyLocation,
                                         String keyName)

Deprecated.

Method Detail

builder

public static HttpEndpointApiKeyAuthScopeConfig.Builder builder()

Create a new builder.

toBuilder

public HttpEndpointApiKeyAuthScopeConfig.Builder toBuilder()

getVaultSecretId

public String getVaultSecretId()

The OCID of the vault secret with API key.

Required when authScope is AGENT.

Returns:

the value

getKeyLocation

public HttpEndpointApiKeyAuthScopeConfig.KeyLocation getKeyLocation()

The location of the API key in the request.

Returns:

the value

getKeyName

public String getKeyName()

The name of the key parameter in the location.

Returns:

the value

toString

public String toString()

Overrides:

toString in class HttpEndpointAuthScopeConfig

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class HttpEndpointAuthScopeConfig

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class HttpEndpointAuthScopeConfig

hashCode

public int hashCode()

Overrides:

hashCode in class HttpEndpointAuthScopeConfig