AgentIdentity Class

  • java.lang.Object
    • com.azure.ai.agents.models.AgentIdentity

Implements

public final class AgentIdentity
implements JsonSerializable<AgentIdentity>

The AgentIdentity model.

Method Summary

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

Reads an instance of AgentIdentity from the JsonReader.

String getClientId()

Get the clientId property: The client ID of the agent instance.

String getPrincipalId()

Get the principalId property: The principal ID of the agent instance.

AgentIdentityStatus getStatus()

Get the status property: The status of the agent identity.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Method Details

fromJson

public static AgentIdentity fromJson(JsonReader jsonReader)

Reads an instance of AgentIdentity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getClientId

public String getClientId()

Get the clientId property: The client ID of the agent instance. Also referred to as the instance ID.

Returns:

the clientId value.

getPrincipalId

public String getPrincipalId()

Get the principalId property: The principal ID of the agent instance.

Returns:

the principalId value.

getStatus

public AgentIdentityStatus getStatus()

Get the status property: The status of the agent identity. Present for both the agent instance identity and the agent blueprint.

Returns:

the status value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to