Class AIServicesAccountKey

java.lang.Object
com.azure.search.documents.indexes.models.CognitiveServicesAccount
com.azure.search.documents.indexes.models.AIServicesAccountKey
All Implemented Interfaces:
com.azure.json.JsonSerializable<CognitiveServicesAccount>
public final class AIServicesAccountKey extends CognitiveServicesAccount
The account key of an Azure AI service resource that's attached to a skillset, to be used with the resource's subdomain.

  • Constructor Details

    • AIServicesAccountKey

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

  • Method Details

    • getOdataType

      public String getOdataType()
      Get the odataType property: A URI fragment specifying the type of Azure AI service resource attached to a skillset.
      Overrides:
      getOdataType in class CognitiveServicesAccount
      Returns:
      the odataType value.

    • getKey

      public String getKey()
      Get the key property: The key used to provision the Azure AI service resource attached to a skillset.
      Returns:
      the key value.

    • getSubdomainUrl

      public String getSubdomainUrl()
      Get the subdomainUrl property: The subdomain url for the corresponding AI Service.
      Returns:
      the subdomainUrl value.

    • setDescription

      public AIServicesAccountKey setDescription(String description)
      Set the description property: Description of the Azure AI service resource attached to a skillset.
      Overrides:
      setDescription in class CognitiveServicesAccount
      Parameters:
      description - the description value to set.
      Returns:
      the CognitiveServicesAccount object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<CognitiveServicesAccount>
      Overrides:
      toJson in class CognitiveServicesAccount
      Throws:
      IOException

    • fromJson

      public static AIServicesAccountKey fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AIServicesAccountKey from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AIServicesAccountKey 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 AIServicesAccountKey.