Package com.azure.ai.openai.models

Class OnYourDataApiKeyAuthenticationOptions

java.lang.Object

com.azure.ai.openai.models.OnYourDataAuthenticationOptions

com.azure.ai.openai.models.OnYourDataApiKeyAuthenticationOptions

All Implemented Interfaces:

com.azure.json.JsonSerializable<OnYourDataAuthenticationOptions>

public final class OnYourDataApiKeyAuthenticationOptions
extends OnYourDataAuthenticationOptions

The authentication options for Azure OpenAI On Your Data when using an API key.

Constructor Summary

Constructors

Constructor	Description
OnYourDataApiKeyAuthenticationOptions(String key)	Creates an instance of OnYourDataApiKeyAuthenticationOptions class.

Method Summary

Modifier and Type	Method	Description
static OnYourDataApiKeyAuthenticationOptions	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of OnYourDataApiKeyAuthenticationOptions from the JsonReader.
String	getKey()	Get the key property: The API key to use for authentication.
OnYourDataAuthenticationType	getType()	Get the type property: The authentication type.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

OnYourDataApiKeyAuthenticationOptions

public OnYourDataApiKeyAuthenticationOptions(String key)

Creates an instance of OnYourDataApiKeyAuthenticationOptions class.

Parameters:

key - the key value to set.

Method Details

getKey

public String getKey()

Get the key property: The API key to use for authentication.

Returns:

the key value.

getType

public OnYourDataAuthenticationType getType()

Get the type property: The authentication type.

Overrides:

getType in class OnYourDataAuthenticationOptions

Returns:

the type value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<OnYourDataAuthenticationOptions>

Overrides:

toJson in class OnYourDataAuthenticationOptions

Throws:

IOException

fromJson

public static OnYourDataApiKeyAuthenticationOptions fromJson(com.azure.json.JsonReader jsonReader)
                                                      throws IOException

Reads an instance of OnYourDataApiKeyAuthenticationOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of OnYourDataApiKeyAuthenticationOptions if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the OnYourDataApiKeyAuthenticationOptions.