AgentReference Class

Package:
com.azure.ai.agents.models
Maven Artifact:
com.azure:azure-ai-agents:2.2.0
  • java.lang.Object
    • com.azure.ai.agents.models.AgentReference

Implements

JsonSerializable<AgentReference>

public final class AgentReference
implements JsonSerializable<AgentReference>

The AgentReference model.

Constructor Summary

Constructor Description
AgentReference(String name)

Creates an instance of AgentReference class.

Method Summary

Modifier and Type Method and Description
static AgentReference fromJson(JsonReader jsonReader)

Reads an instance of AgentReference from the JsonReader.
String getName()

Get the name property: The name of the agent.
String getType()

Get the type property: The type property.
String getVersion()

Get the version property: The version identifier of the agent.
AgentReference setVersion(String version)

Set the version property: The version identifier of the agent.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AgentReference

public AgentReference(String name)

Creates an instance of AgentReference class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static AgentReference fromJson(JsonReader jsonReader)

Reads an instance of AgentReference from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getName

public String getName()

Get the name property: The name of the agent.

Returns:

the name value.

getType

public String getType()

Get the type property: The type property.

Returns:

the type value.

getVersion

public String getVersion()

Get the version property: The version identifier of the agent.

Returns:

the version value.

setVersion

public AgentReference setVersion(String version)

Set the version property: The version identifier of the agent.

Parameters:

version - the version value to set.

Returns:

the AgentReference object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to