Class OnYourDataAccessTokenAuthenticationOptions

java.lang.Object
com.azure.ai.openai.models.OnYourDataAuthenticationOptions
com.azure.ai.openai.models.OnYourDataAccessTokenAuthenticationOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<OnYourDataAuthenticationOptions>

public final class OnYourDataAccessTokenAuthenticationOptions extends OnYourDataAuthenticationOptions
The authentication options for Azure OpenAI On Your Data when using access token.
  • Constructor Details

    • OnYourDataAccessTokenAuthenticationOptions

      public OnYourDataAccessTokenAuthenticationOptions(String accessToken)
      Creates an instance of OnYourDataAccessTokenAuthenticationOptions class.
      Parameters:
      accessToken - the accessToken value to set.
  • Method Details

    • getAccessToken

      public String getAccessToken()
      Get the accessToken property: The access token to use for authentication.
      Returns:
      the accessToken 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 OnYourDataAccessTokenAuthenticationOptions fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of OnYourDataAccessTokenAuthenticationOptions from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of OnYourDataAccessTokenAuthenticationOptions 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 OnYourDataAccessTokenAuthenticationOptions.