Package com.azure.ai.openai.models

Class OnYourDataKeyAndKeyIdAuthenticationOptions

java.lang.Object
com.azure.ai.openai.models.OnYourDataAuthenticationOptions
com.azure.ai.openai.models.OnYourDataKeyAndKeyIdAuthenticationOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<OnYourDataAuthenticationOptions>
public final class OnYourDataKeyAndKeyIdAuthenticationOptions extends OnYourDataAuthenticationOptions
The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.

  • Constructor Details

    • OnYourDataKeyAndKeyIdAuthenticationOptions

      public OnYourDataKeyAndKeyIdAuthenticationOptions(String key, String keyId)
      Creates an instance of OnYourDataKeyAndKeyIdAuthenticationOptions class.
      Parameters:
      key - the key value to set.
      keyId - the keyId value to set.

  • Method Details

    • getKey

      public String getKey()
      Get the key property: The key to use for authentication.
      Returns:
      the key value.

    • getKeyId

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