Package com.azure.ai.openai.models

Class OnYourDataVectorSearchAccessTokenAuthenticationOptions

java.lang.Object

com.azure.ai.openai.models.OnYourDataVectorSearchAuthenticationOptions

com.azure.ai.openai.models.OnYourDataVectorSearchAccessTokenAuthenticationOptions

All Implemented Interfaces:

com.azure.json.JsonSerializable<OnYourDataVectorSearchAuthenticationOptions>

public final class OnYourDataVectorSearchAccessTokenAuthenticationOptions
extends OnYourDataVectorSearchAuthenticationOptions

The authentication options for Azure OpenAI On Your Data vector search when using access token.

Constructor Summary

Constructors

Constructor	Description
OnYourDataVectorSearchAccessTokenAuthenticationOptions(String accessToken)	Creates an instance of OnYourDataVectorSearchAccessTokenAuthenticationOptions class.

Method Summary

Modifier and Type	Method	Description
static OnYourDataVectorSearchAccessTokenAuthenticationOptions	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of OnYourDataVectorSearchAccessTokenAuthenticationOptions from the JsonReader.
String	getAccessToken()	Get the accessToken property: The access token to use for authentication.
OnYourDataVectorSearchAuthenticationType	getType()	Get the type property: The type of authentication to use.
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

OnYourDataVectorSearchAccessTokenAuthenticationOptions

public OnYourDataVectorSearchAccessTokenAuthenticationOptions(String accessToken)

Creates an instance of OnYourDataVectorSearchAccessTokenAuthenticationOptions class.

Parameters:

accessToken - the accessToken value to set.

Method Details

getType

public OnYourDataVectorSearchAuthenticationType getType()

Get the type property: The type of authentication to use.

Overrides:

getType in class OnYourDataVectorSearchAuthenticationOptions

Returns:

the type value.

getAccessToken

public String getAccessToken()

Get the accessToken property: The access token to use for authentication.

Returns:

the accessToken value.

toJson

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

Specified by:

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

Overrides:

toJson in class OnYourDataVectorSearchAuthenticationOptions

Throws:

IOException

fromJson

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

Reads an instance of OnYourDataVectorSearchAccessTokenAuthenticationOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of OnYourDataVectorSearchAccessTokenAuthenticationOptions 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 OnYourDataVectorSearchAccessTokenAuthenticationOptions.