Package org.a2aproject.sdk.grpc
Interface AgentCardOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
AgentCard,AgentCard.Builder
@Generated
public interface AgentCardOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleanThe security scheme details used for authenticating with this agent.A2A Capability set supported by the agent.A2A Capability set supported by the agent.getDefaultInputModes(int index) protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills.com.google.protobuf.ByteStringgetDefaultInputModesBytes(int index) protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills.intprotolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills.protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills.getDefaultOutputModes(int index) The media types supported as outputs from this agent.com.google.protobuf.ByteStringgetDefaultOutputModesBytes(int index) The media types supported as outputs from this agent.intThe media types supported as outputs from this agent.The media types supported as outputs from this agent.A human-readable description of the agent, assisting users and other agents in understanding its purpose.com.google.protobuf.ByteStringA human-readable description of the agent, assisting users and other agents in understanding its purpose.A URL providing additional documentation about the agent.com.google.protobuf.ByteStringA URL providing additional documentation about the agent.Optional.com.google.protobuf.ByteStringOptional.getName()A human readable name for the agent.com.google.protobuf.ByteStringA human readable name for the agent.The service provider of the agent.The service provider of the agent.getSecurityRequirements(int index) Security requirements for contacting the agent.intSecurity requirements for contacting the agent.Security requirements for contacting the agent.getSecurityRequirementsOrBuilder(int index) Security requirements for contacting the agent.List<? extends SecurityRequirementOrBuilder>Security requirements for contacting the agent.Deprecated.intThe security scheme details used for authenticating with this agent.The security scheme details used for authenticating with this agent.getSecuritySchemesOrDefault(String key, SecurityScheme defaultValue) The security scheme details used for authenticating with this agent.The security scheme details used for authenticating with this agent.getSignatures(int index) JSON Web Signatures computed for this `AgentCard`.intJSON Web Signatures computed for this `AgentCard`.JSON Web Signatures computed for this `AgentCard`.getSignaturesOrBuilder(int index) JSON Web Signatures computed for this `AgentCard`.List<? extends AgentCardSignatureOrBuilder>JSON Web Signatures computed for this `AgentCard`.getSkills(int index) Skills represent the abilities of an agent.intSkills represent the abilities of an agent.Skills represent the abilities of an agent.getSkillsOrBuilder(int index) Skills represent the abilities of an agent.List<? extends AgentSkillOrBuilder>Skills represent the abilities of an agent.getSupportedInterfaces(int index) Ordered list of supported interfaces.intOrdered list of supported interfaces.Ordered list of supported interfaces.getSupportedInterfacesOrBuilder(int index) Ordered list of supported interfaces.List<? extends AgentInterfaceOrBuilder>Ordered list of supported interfaces.The version of the agent.com.google.protobuf.ByteStringThe version of the agent.booleanA2A Capability set supported by the agent.booleanA URL providing additional documentation about the agent.booleanOptional.booleanThe service provider of the agent.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()A human readable name for the agent. Example: "Recipe Agent"
string name = 1 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()A human readable name for the agent. Example: "Recipe Agent"
string name = 1 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The bytes for name.
-
getDescription
String getDescription()A human-readable description of the agent, assisting users and other agents in understanding its purpose. Example: "Agent that helps users with recipes and cooking."
string description = 2 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()A human-readable description of the agent, assisting users and other agents in understanding its purpose. Example: "Agent that helps users with recipes and cooking."
string description = 2 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The bytes for description.
-
getSupportedInterfacesList
List<AgentInterface> getSupportedInterfacesList()Ordered list of supported interfaces. The first entry is preferred.
repeated .lf.a2a.v1.AgentInterface supported_interfaces = 3 [(.google.api.field_behavior) = REQUIRED]; -
getSupportedInterfaces
Ordered list of supported interfaces. The first entry is preferred.
repeated .lf.a2a.v1.AgentInterface supported_interfaces = 3 [(.google.api.field_behavior) = REQUIRED]; -
getSupportedInterfacesCount
int getSupportedInterfacesCount()Ordered list of supported interfaces. The first entry is preferred.
repeated .lf.a2a.v1.AgentInterface supported_interfaces = 3 [(.google.api.field_behavior) = REQUIRED]; -
getSupportedInterfacesOrBuilderList
List<? extends AgentInterfaceOrBuilder> getSupportedInterfacesOrBuilderList()Ordered list of supported interfaces. The first entry is preferred.
repeated .lf.a2a.v1.AgentInterface supported_interfaces = 3 [(.google.api.field_behavior) = REQUIRED]; -
getSupportedInterfacesOrBuilder
Ordered list of supported interfaces. The first entry is preferred.
repeated .lf.a2a.v1.AgentInterface supported_interfaces = 3 [(.google.api.field_behavior) = REQUIRED]; -
hasProvider
boolean hasProvider()The service provider of the agent.
.lf.a2a.v1.AgentProvider provider = 4;- Returns:
- Whether the provider field is set.
-
getProvider
AgentProvider getProvider()The service provider of the agent.
.lf.a2a.v1.AgentProvider provider = 4;- Returns:
- The provider.
-
getProviderOrBuilder
AgentProviderOrBuilder getProviderOrBuilder()The service provider of the agent.
.lf.a2a.v1.AgentProvider provider = 4; -
getVersion
String getVersion()The version of the agent. Example: "1.0.0"
string version = 5 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The version.
-
getVersionBytes
com.google.protobuf.ByteString getVersionBytes()The version of the agent. Example: "1.0.0"
string version = 5 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The bytes for version.
-
hasDocumentationUrl
boolean hasDocumentationUrl()A URL providing additional documentation about the agent.
optional string documentation_url = 6;- Returns:
- Whether the documentationUrl field is set.
-
getDocumentationUrl
String getDocumentationUrl()A URL providing additional documentation about the agent.
optional string documentation_url = 6;- Returns:
- The documentationUrl.
-
getDocumentationUrlBytes
com.google.protobuf.ByteString getDocumentationUrlBytes()A URL providing additional documentation about the agent.
optional string documentation_url = 6;- Returns:
- The bytes for documentationUrl.
-
hasCapabilities
boolean hasCapabilities()A2A Capability set supported by the agent.
.lf.a2a.v1.AgentCapabilities capabilities = 7 [(.google.api.field_behavior) = REQUIRED];- Returns:
- Whether the capabilities field is set.
-
getCapabilities
AgentCapabilities getCapabilities()A2A Capability set supported by the agent.
.lf.a2a.v1.AgentCapabilities capabilities = 7 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The capabilities.
-
getCapabilitiesOrBuilder
AgentCapabilitiesOrBuilder getCapabilitiesOrBuilder()A2A Capability set supported by the agent.
.lf.a2a.v1.AgentCapabilities capabilities = 7 [(.google.api.field_behavior) = REQUIRED]; -
getSecuritySchemesCount
int getSecuritySchemesCount()The security scheme details used for authenticating with this agent.
map<string, .lf.a2a.v1.SecurityScheme> security_schemes = 8; -
containsSecuritySchemes
The security scheme details used for authenticating with this agent.
map<string, .lf.a2a.v1.SecurityScheme> security_schemes = 8; -
getSecuritySchemes
Deprecated.UsegetSecuritySchemesMap()instead. -
getSecuritySchemesMap
Map<String,SecurityScheme> getSecuritySchemesMap()The security scheme details used for authenticating with this agent.
map<string, .lf.a2a.v1.SecurityScheme> security_schemes = 8; -
getSecuritySchemesOrDefault
The security scheme details used for authenticating with this agent.
map<string, .lf.a2a.v1.SecurityScheme> security_schemes = 8; -
getSecuritySchemesOrThrow
The security scheme details used for authenticating with this agent.
map<string, .lf.a2a.v1.SecurityScheme> security_schemes = 8; -
getSecurityRequirementsList
List<SecurityRequirement> getSecurityRequirementsList()Security requirements for contacting the agent.
repeated .lf.a2a.v1.SecurityRequirement security_requirements = 9; -
getSecurityRequirements
Security requirements for contacting the agent.
repeated .lf.a2a.v1.SecurityRequirement security_requirements = 9; -
getSecurityRequirementsCount
int getSecurityRequirementsCount()Security requirements for contacting the agent.
repeated .lf.a2a.v1.SecurityRequirement security_requirements = 9; -
getSecurityRequirementsOrBuilderList
List<? extends SecurityRequirementOrBuilder> getSecurityRequirementsOrBuilderList()Security requirements for contacting the agent.
repeated .lf.a2a.v1.SecurityRequirement security_requirements = 9; -
getSecurityRequirementsOrBuilder
Security requirements for contacting the agent.
repeated .lf.a2a.v1.SecurityRequirement security_requirements = 9; -
getDefaultInputModesList
protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as media types.
repeated string default_input_modes = 10 [(.google.api.field_behavior) = REQUIRED];- Returns:
- A list containing the defaultInputModes.
-
getDefaultInputModesCount
int getDefaultInputModesCount()protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as media types.
repeated string default_input_modes = 10 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The count of defaultInputModes.
-
getDefaultInputModes
protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as media types.
repeated string default_input_modes = 10 [(.google.api.field_behavior) = REQUIRED];- Parameters:
index- The index of the element to return.- Returns:
- The defaultInputModes at the given index.
-
getDefaultInputModesBytes
com.google.protobuf.ByteString getDefaultInputModesBytes(int index) protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as media types.
repeated string default_input_modes = 10 [(.google.api.field_behavior) = REQUIRED];- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the defaultInputModes at the given index.
-
getDefaultOutputModesList
The media types supported as outputs from this agent.
repeated string default_output_modes = 11 [(.google.api.field_behavior) = REQUIRED];- Returns:
- A list containing the defaultOutputModes.
-
getDefaultOutputModesCount
int getDefaultOutputModesCount()The media types supported as outputs from this agent.
repeated string default_output_modes = 11 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The count of defaultOutputModes.
-
getDefaultOutputModes
The media types supported as outputs from this agent.
repeated string default_output_modes = 11 [(.google.api.field_behavior) = REQUIRED];- Parameters:
index- The index of the element to return.- Returns:
- The defaultOutputModes at the given index.
-
getDefaultOutputModesBytes
com.google.protobuf.ByteString getDefaultOutputModesBytes(int index) The media types supported as outputs from this agent.
repeated string default_output_modes = 11 [(.google.api.field_behavior) = REQUIRED];- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the defaultOutputModes at the given index.
-
getSkillsList
List<AgentSkill> getSkillsList()Skills represent the abilities of an agent. It is largely a descriptive concept but represents a more focused set of behaviors that the agent is likely to succeed at.
repeated .lf.a2a.v1.AgentSkill skills = 12 [(.google.api.field_behavior) = REQUIRED]; -
getSkills
Skills represent the abilities of an agent. It is largely a descriptive concept but represents a more focused set of behaviors that the agent is likely to succeed at.
repeated .lf.a2a.v1.AgentSkill skills = 12 [(.google.api.field_behavior) = REQUIRED]; -
getSkillsCount
int getSkillsCount()Skills represent the abilities of an agent. It is largely a descriptive concept but represents a more focused set of behaviors that the agent is likely to succeed at.
repeated .lf.a2a.v1.AgentSkill skills = 12 [(.google.api.field_behavior) = REQUIRED]; -
getSkillsOrBuilderList
List<? extends AgentSkillOrBuilder> getSkillsOrBuilderList()Skills represent the abilities of an agent. It is largely a descriptive concept but represents a more focused set of behaviors that the agent is likely to succeed at.
repeated .lf.a2a.v1.AgentSkill skills = 12 [(.google.api.field_behavior) = REQUIRED]; -
getSkillsOrBuilder
Skills represent the abilities of an agent. It is largely a descriptive concept but represents a more focused set of behaviors that the agent is likely to succeed at.
repeated .lf.a2a.v1.AgentSkill skills = 12 [(.google.api.field_behavior) = REQUIRED]; -
getSignaturesList
List<AgentCardSignature> getSignaturesList()JSON Web Signatures computed for this `AgentCard`.
repeated .lf.a2a.v1.AgentCardSignature signatures = 13; -
getSignatures
JSON Web Signatures computed for this `AgentCard`.
repeated .lf.a2a.v1.AgentCardSignature signatures = 13; -
getSignaturesCount
int getSignaturesCount()JSON Web Signatures computed for this `AgentCard`.
repeated .lf.a2a.v1.AgentCardSignature signatures = 13; -
getSignaturesOrBuilderList
List<? extends AgentCardSignatureOrBuilder> getSignaturesOrBuilderList()JSON Web Signatures computed for this `AgentCard`.
repeated .lf.a2a.v1.AgentCardSignature signatures = 13; -
getSignaturesOrBuilder
JSON Web Signatures computed for this `AgentCard`.
repeated .lf.a2a.v1.AgentCardSignature signatures = 13; -
hasIconUrl
boolean hasIconUrl()Optional. A URL to an icon for the agent.
optional string icon_url = 14;- Returns:
- Whether the iconUrl field is set.
-
getIconUrl
String getIconUrl()Optional. A URL to an icon for the agent.
optional string icon_url = 14;- Returns:
- The iconUrl.
-
getIconUrlBytes
com.google.protobuf.ByteString getIconUrlBytes()Optional. A URL to an icon for the agent.
optional string icon_url = 14;- Returns:
- The bytes for iconUrl.
-