Package com.azure.ai.openai.models

Class OnYourDataConnectionStringAuthenticationOptions

java.lang.Object
com.azure.ai.openai.models.OnYourDataAuthenticationOptions
com.azure.ai.openai.models.OnYourDataConnectionStringAuthenticationOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<OnYourDataAuthenticationOptions>
public final class OnYourDataConnectionStringAuthenticationOptions extends OnYourDataAuthenticationOptions
The authentication options for Azure OpenAI On Your Data when using a connection string.

  • Constructor Details

    • OnYourDataConnectionStringAuthenticationOptions

      public OnYourDataConnectionStringAuthenticationOptions(String connectionString)
      Creates an instance of OnYourDataConnectionStringAuthenticationOptions class.
      Parameters:
      connectionString - the connectionString value to set.

  • Method Details

    • getConnectionString

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