AIServicesAccountKey Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:12.0.0

• java.lang.Object
• • com.azure.search.documents.indexes.models.CognitiveServicesAccount
  • • com.azure.search.documents.indexes.models.AIServicesAccountKey

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 Summary

Constructor	Description
AIServicesAccountKey(String key, String subdomainUrl)	Creates an instance of AIServicesAccountKey class.

Method Summary

Modifier and Type	Method and Description
static AIServicesAccountKey	fromJson(JsonReader jsonReader) Reads an instance of AIServicesAccountKey from the JsonReader.
String	getKey() Get the key property: The key used to provision the Azure AI service resource attached to a skillset.
String	getOdataType() Get the odataType property: The discriminator for derived types.
String	getSubdomainUrl() Get the subdomainUrl property: The subdomain/Azure AI Services endpoint url for the corresponding AI Service.
AIServicesAccountKey	setDescription(String description) Set the description property: Description of the Azure AI service resource attached to a skillset.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from CognitiveServicesAccount

fromJson getDescription getOdataType setDescription toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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

fromJson

public static AIServicesAccountKey fromJson(JsonReader jsonReader)

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:

IOException

- If the deserialized JSON object was missing any required properties.

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.

getOdataType

public String getOdataType()

Get the odataType property: The discriminator for derived types.

Overrides:

AIServicesAccountKey.getOdataType()

Returns:

the odataType value.

getSubdomainUrl

public String getSubdomainUrl()

Get the subdomainUrl property: The subdomain/Azure AI Services endpoint 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:

AIServicesAccountKey.setDescription(String description)

Parameters:

description

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AIServicesAccountKey.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException