Google Cloud Agent Registry V1 Client - Class Agent (0.2.0)

Reference documentation and code samples for the Google Cloud Agent Registry V1 Client class Agent.

Represents an Agent.

"A2A" below refers to the Agent-to-Agent protocol.

Generated from protobuf message google.cloud.agentregistry.v1.Agent

Namespace

Google \ Cloud \ AgentRegistry \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
`↳ agent_id`	`string` Output only. A stable, globally unique identifier for agents.
`↳ location`	`string` Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
`↳ display_name`	`string` Output only. The display name of the agent, often obtained from the A2A Agent Card.
`↳ description`	`string` Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
`↳ version`	`string` Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.
`↳ protocols`	`array<Agent\Protocol>` Output only. The connection details for the Agent.
`↳ skills`	`array<Agent\Skill>` Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
`↳ uid`	`string` Output only. A universally unique identifier for the Agent.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Create time.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Update time.
`↳ attributes`	`array\|Google\Protobuf\Internal\MapField` Output only. Attributes of the Agent. Valid values: * * `agentregistry.googleapis.com/system/Framework`: {"framework": "google-adk"} - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom". * * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."} - the runtime identity associated with the Agent. * * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
`↳ card`	`Agent\Card` Output only. Full Agent Card payload, when available.

getName

Identifier. The resource name of an Agent.

Format: projects/{project}/locations/{location}/agents/{agent}.

Returns
Type	Description
`string`

setName

Identifier. The resource name of an Agent.

Format: projects/{project}/locations/{location}/agents/{agent}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAgentId

Output only. A stable, globally unique identifier for agents.

Returns
Type	Description
`string`

setAgentId

Output only. A stable, globally unique identifier for agents.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLocation

Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).

Returns
Type	Description
`string`

setLocation

Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Output only. The display name of the agent, often obtained from the A2A Agent Card.

Returns
Type	Description
`string`

setDisplayName

Output only. The display name of the agent, often obtained from the A2A Agent Card.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.

Returns
Type	Description
`string`

setDescription

Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVersion

Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.

Returns
Type	Description
`string`

setVersion

Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProtocols

Output only. The connection details for the Agent.

Returns
Type	Description
`Google\Protobuf\RepeatedField<Agent\Protocol>`

setProtocols

Output only. The connection details for the Agent.

Parameter
Name	Description
`var`	`array<Agent\Protocol>`

Returns
Type	Description
`$this`

getSkills

Output only. Skills the agent possesses, often obtained from the A2A Agent Card.

Returns
Type	Description
`Google\Protobuf\RepeatedField<Agent\Skill>`

setSkills

Output only. Skills the agent possesses, often obtained from the A2A Agent Card.

Parameter
Name	Description
`var`	`array<Agent\Skill>`

Returns
Type	Description
`$this`

getUid

Output only. A universally unique identifier for the Agent.

Returns
Type	Description
`string`

setUid

Output only. A universally unique identifier for the Agent.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Create time.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime