TaxonomyCategory Class

Package:

com.azure.ai.projects.models

Maven Artifact:

com.azure:azure-ai-projects:2.0.1

• java.lang.Object
• • com.azure.ai.projects.models.TaxonomyCategory

Implements

JsonSerializable<TaxonomyCategory>

public final class TaxonomyCategory
implements JsonSerializable<TaxonomyCategory>

Taxonomy category definition.

Constructor Summary

Constructor	Description
TaxonomyCategory(String id, String name, RiskCategory riskCategory, List<TaxonomySubCategory> subCategories)	Creates an instance of TaxonomyCategory class.

Method Summary

Modifier and Type	Method and Description
static TaxonomyCategory	fromJson(JsonReader jsonReader) Reads an instance of TaxonomyCategory from the JsonReader.
String	getDescription() Get the description property: Description of the taxonomy category.
String	getId() Get the id property: Unique identifier of the taxonomy category.
String	getName() Get the name property: Name of the taxonomy category.
Map<String,String>	getProperties() Get the properties property: Additional properties for the taxonomy category.
RiskCategory	getRiskCategory() Get the riskCategory property: Risk category associated with this taxonomy category.
List<TaxonomySubCategory>	getSubCategories() Get the subCategories property: List of taxonomy sub categories.
TaxonomyCategory	setDescription(String description) Set the description property: Description of the taxonomy category.
TaxonomyCategory	setProperties(Map<String,String> properties) Set the properties property: Additional properties for the taxonomy category.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TaxonomyCategory

public TaxonomyCategory(String id, String name, RiskCategory riskCategory, List<TaxonomySubCategory> subCategories)

Creates an instance of TaxonomyCategory class.

Parameters:

id - the id value to set.

name - the name value to set.

riskCategory - the riskCategory value to set.

subCategories - the subCategories value to set.

Method Details

fromJson

public static TaxonomyCategory fromJson(JsonReader jsonReader)

Reads an instance of TaxonomyCategory from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of TaxonomyCategory 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.

getDescription

public String getDescription()

Get the description property: Description of the taxonomy category.

Returns:

the description value.

getId

public String getId()

Get the id property: Unique identifier of the taxonomy category.

Returns:

the id value.

getName

public String getName()

Get the name property: Name of the taxonomy category.

Returns:

the name value.

getProperties

public Map<String,String> getProperties()

Get the properties property: Additional properties for the taxonomy category.

Returns:

the properties value.

getRiskCategory

public RiskCategory getRiskCategory()

Get the riskCategory property: Risk category associated with this taxonomy category.

Returns:

the riskCategory value.

getSubCategories

public List<TaxonomySubCategory> getSubCategories()

Get the subCategories property: List of taxonomy sub categories.

Returns:

the subCategories value.

setDescription

public TaxonomyCategory setDescription(String description)

Set the description property: Description of the taxonomy category.

Parameters:

description - the description value to set.

Returns:

the TaxonomyCategory object itself.

setProperties

public TaxonomyCategory setProperties(Map<String,String> properties)

Set the properties property: Additional properties for the taxonomy category.

Parameters:

properties - the properties value to set.

Returns:

the TaxonomyCategory object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException