Reference documentation and code samples for the Agent Registry V1 API class Google::Cloud::AgentRegistry::V1::Agent.
Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#agent_id
def agent_id() -> ::String
Returns
- (::String) — Output only. A stable, globally unique identifier for agents.
#attributes
def attributes() -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Struct}
Returns
-
(::Google::Protobuf::Map{::String => ::Google::Protobuf::Struct}) —
Output only. Attributes of the Agent. Valid values:
agentregistry.googleapis.com/system/Framework: "google-adk" - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom".agentregistry.googleapis.com/system/RuntimeIdentity: "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
def card() -> ::Google::Cloud::AgentRegistry::V1::Agent::Card
Returns
- (::Google::Cloud::AgentRegistry::V1::Agent::Card) — Output only. Full Agent Card payload, when available.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Create time.
#description
def description() -> ::String
Returns
- (::String) — Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
#display_name
def display_name() -> ::String
Returns
- (::String) — Output only. The display name of the agent, often obtained from the A2A Agent Card.
#location
def location() -> ::String
Returns
- (::String) — Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
#name
def name() -> ::String
Returns
-
(::String) — Identifier. The resource name of an Agent.
Format:
projects/{project}/locations/{location}/agents/{agent}.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Identifier. The resource name of an Agent.
Format:
projects/{project}/locations/{location}/agents/{agent}.
Returns
-
(::String) — Identifier. The resource name of an Agent.
Format:
projects/{project}/locations/{location}/agents/{agent}.
#protocols
def protocols() -> ::Array<::Google::Cloud::AgentRegistry::V1::Agent::Protocol>
Returns
- (::Array<::Google::Cloud::AgentRegistry::V1::Agent::Protocol>) — Output only. The connection details for the Agent.
#skills
def skills() -> ::Array<::Google::Cloud::AgentRegistry::V1::Agent::Skill>
Returns
- (::Array<::Google::Cloud::AgentRegistry::V1::Agent::Skill>) — Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
#uid
def uid() -> ::String
Returns
- (::String) — Output only. A universally unique identifier for the Agent.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Update time.
#version
def version() -> ::String
Returns
- (::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.