Class Agent (0.2.0)

public final class Agent extends GeneratedMessage implements AgentOrBuilder

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

Protobuf type google.cloud.agentregistry.v1.Agent

Implements

AgentOrBuilder

Static Fields

AGENT_ID_FIELD_NUMBER

public static final int AGENT_ID_FIELD_NUMBER
Field Value
Type Description
int

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

CARD_FIELD_NUMBER

public static final int CARD_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROTOCOLS_FIELD_NUMBER

public static final int PROTOCOLS_FIELD_NUMBER
Field Value
Type Description
int

SKILLS_FIELD_NUMBER

public static final int SKILLS_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Agent getDefaultInstance()
Returns
Type Description
Agent

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Agent.Builder newBuilder()
Returns
Type Description
Agent.Builder

newBuilder(Agent prototype)

public static Agent.Builder newBuilder(Agent prototype)
Parameter
Name Description
prototype Agent
Returns
Type Description
Agent.Builder

parseDelimitedFrom(InputStream input)

public static Agent parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Agent
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Agent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Agent parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Agent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Agent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Agent parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Agent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Agent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Agent parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Agent
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Agent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Agent parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Agent
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Agent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Agent parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Agent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Agent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Agent
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Agent> parser()
Returns
Type Description
Parser<Agent>

Methods

containsAttributes(String key)

public boolean containsAttributes(String key)

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.

map<string, .google.protobuf.Struct> attributes = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAgentId()

public String getAgentId()

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

string agent_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The agentId.

getAgentIdBytes()

public ByteString getAgentIdBytes()

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

string agent_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for agentId.

getAttributes() (deprecated)

public Map<String,Struct> getAttributes()

Use #getAttributesMap() instead.

Returns
Type Description
Map<String,Struct>

getAttributesCount()

public int getAttributesCount()

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.

map<string, .google.protobuf.Struct> attributes = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getAttributesMap()

public Map<String,Struct> getAttributesMap()

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.

map<string, .google.protobuf.Struct> attributes = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Map<String,Struct>

getAttributesOrDefault(String key, Struct defaultValue)

public Struct getAttributesOrDefault(String key, Struct defaultValue)

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.

map<string, .google.protobuf.Struct> attributes = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
defaultValue Struct
Returns
Type Description
Struct

getAttributesOrThrow(String key)

public Struct getAttributesOrThrow(String key)

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.

map<string, .google.protobuf.Struct> attributes = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
Struct

getCard()

public Agent.Card getCard()

Output only. Full Agent Card payload, when available.

.google.cloud.agentregistry.v1.Agent.Card card = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Agent.Card

The card.

getCardOrBuilder()

public Agent.CardOrBuilder getCardOrBuilder()

Output only. Full Agent Card payload, when available.

.google.cloud.agentregistry.v1.Agent.Card card = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Agent.CardOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Agent getDefaultInstanceForType()
Returns
Type Description
Agent

getDescription()

public String getDescription()

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

string description = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

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

string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for displayName.

getLocation()

public String getLocation()

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

string location = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

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

string location = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for location.

getName()

public String getName()

Identifier. The resource name of an Agent. Format: projects/{project}/locations/{location}/agents/{agent}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of an Agent. Format: projects/{project}/locations/{location}/agents/{agent}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Agent> getParserForType()
Returns
Type Description
Parser<Agent>
Overrides

getProtocols(int index)

public Agent.Protocol getProtocols(int index)

Output only. The connection details for the Agent.

repeated .google.cloud.agentregistry.v1.Agent.Protocol protocols = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Agent.Protocol

getProtocolsCount()

public int getProtocolsCount()

Output only. The connection details for the Agent.

repeated .google.cloud.agentregistry.v1.Agent.Protocol protocols = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getProtocolsList()

public List<Agent.Protocol> getProtocolsList()

Output only. The connection details for the Agent.

repeated .google.cloud.agentregistry.v1.Agent.Protocol protocols = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Protocol>

getProtocolsOrBuilder(int index)

public Agent.ProtocolOrBuilder getProtocolsOrBuilder(int index)

Output only. The connection details for the Agent.

repeated .google.cloud.agentregistry.v1.Agent.Protocol protocols = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Agent.ProtocolOrBuilder

getProtocolsOrBuilderList()

public List<? extends Agent.ProtocolOrBuilder> getProtocolsOrBuilderList()

Output only. The connection details for the Agent.

repeated .google.cloud.agentregistry.v1.Agent.Protocol protocols = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.agentregistry.v1.Agent.ProtocolOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSkills(int index)

public Agent.Skill getSkills(int index)

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

repeated .google.cloud.agentregistry.v1.Agent.Skill skills = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Agent.Skill

getSkillsCount()

public int getSkillsCount()

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

repeated .google.cloud.agentregistry.v1.Agent.Skill skills = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getSkillsList()

public List<Agent.Skill> getSkillsList()

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

repeated .google.cloud.agentregistry.v1.Agent.Skill skills = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Skill>

getSkillsOrBuilder(int index)

public Agent.SkillOrBuilder getSkillsOrBuilder(int index)

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

repeated .google.cloud.agentregistry.v1.Agent.Skill skills = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Agent.SkillOrBuilder

getSkillsOrBuilderList()

public List<? extends Agent.SkillOrBuilder> getSkillsOrBuilderList()

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

repeated .google.cloud.agentregistry.v1.Agent.Skill skills = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.agentregistry.v1.Agent.SkillOrBuilder>

getUid()

public String getUid()

Output only. A universally unique identifier for the Agent.

string uid = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. A universally unique identifier for the Agent.

string uid = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update time.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getVersion()

public String 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.

string version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The version.

getVersionBytes()

public ByteString getVersionBytes()

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.

string version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for version.

hasCard()

public boolean hasCard()

Output only. Full Agent Card payload, when available.

.google.cloud.agentregistry.v1.Agent.Card card = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the card field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update time.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Agent.Builder newBuilderForType()
Returns
Type Description
Agent.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Agent.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Agent.Builder
Overrides

toBuilder()

public Agent.Builder toBuilder()
Returns
Type Description
Agent.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException