Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class AgentCard.
AgentCard conveys key information about an agent.
Generated from protobuf message google.cloud.geminidataanalytics.v1beta.AgentCard
Namespace
Google \ Cloud \ GeminiDataAnalytics \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ protocol_version |
string
Optional. The version of the A2A protocol this agent supports. |
↳ name |
string
Optional. A human readable name for the agent. |
↳ description |
string
Optional. A description of the agent's domain of action/solution space. |
↳ url |
string
Optional. A URL to the address the agent is hosted at. |
↳ preferred_transport |
string
Optional. The transport of the preferred endpoint. If empty, defaults to JSONRPC. |
↳ additional_interfaces |
array<AgentInterface>
Optional. Announcement of additional supported transports. |
↳ provider |
AgentProvider
Optional. The service provider of the agent. |
↳ version |
string
Optional. The version of the agent. |
↳ documentation_url |
string
Optional. A url to provide additional documentation about the agent. |
↳ capabilities |
AgentCapabilities
Optional. A2A Capability set supported by the agent. |
↳ security_schemes |
array|Google\Protobuf\Internal\MapField
The security scheme details used for authenticating with this agent. |
↳ security |
array<Security>
Security requirements for contacting the agent. |
↳ default_input_modes |
string[]
Optional. The set of interaction modes that the agent supports across all skills. |
↳ default_output_modes |
string[]
Optional. The mime types supported as outputs from this agent. |
↳ skills |
array<AgentSkill>
Optional. Skills represent a unit of ability an agent can perform. |
↳ supports_authenticated_extended_card |
bool
Optional. Whether the agent supports providing an extended agent card when the user is authenticated. |
↳ signatures |
array<AgentCardSignature>
Optional. JSON Web Signatures computed for this AgentCard. |
↳ icon_url |
string
Optional. An optional URL to an icon for the agent. |
getProtocolVersion
Optional. The version of the A2A protocol this agent supports.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProtocolVersion
Optional. The version of the A2A protocol this agent supports.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Optional. A human readable name for the agent.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Optional. A human readable name for the agent.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A description of the agent's domain of action/solution space.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A description of the agent's domain of action/solution space.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUrl
Optional. A URL to the address the agent is hosted at.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUrl
Optional. A URL to the address the agent is hosted at.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPreferredTransport
Optional. The transport of the preferred endpoint. If empty, defaults to JSONRPC.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPreferredTransport
Optional. The transport of the preferred endpoint. If empty, defaults to JSONRPC.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdditionalInterfaces
Optional. Announcement of additional supported transports.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<AgentInterface> |
|
setAdditionalInterfaces
Optional. Announcement of additional supported transports.
| Parameter | |
|---|---|
| Name | Description |
var |
array<AgentInterface>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProvider
Optional. The service provider of the agent.
| Returns | |
|---|---|
| Type | Description |
AgentProvider|null |
|
hasProvider
clearProvider
setProvider
Optional. The service provider of the agent.
| Parameter | |
|---|---|
| Name | Description |
var |
AgentProvider
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVersion
Optional. The version of the agent.
| Returns | |
|---|---|
| Type | Description |
string |
|
setVersion
Optional. The version of the agent.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDocumentationUrl
Optional. A url to provide additional documentation about the agent.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDocumentationUrl
Optional. A url to provide additional documentation about the agent.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCapabilities
Optional. A2A Capability set supported by the agent.
| Returns | |
|---|---|
| Type | Description |
AgentCapabilities|null |
|
hasCapabilities
clearCapabilities
setCapabilities
Optional. A2A Capability set supported by the agent.
| Parameter | |
|---|---|
| Name | Description |
var |
AgentCapabilities
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSecuritySchemes
The security scheme details used for authenticating with this agent.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setSecuritySchemes
The security scheme details used for authenticating with this agent.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSecurity
Security requirements for contacting the agent.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Security> |
|
setSecurity
Security requirements for contacting the agent.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Security>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultInputModes
Optional. The set of interaction modes that the agent supports across all skills.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setDefaultInputModes
Optional. The set of interaction modes that the agent supports across all skills.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultOutputModes
Optional. The mime types supported as outputs from this agent.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setDefaultOutputModes
Optional. The mime types supported as outputs from this agent.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSkills
Optional. Skills represent a unit of ability an agent can perform.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<AgentSkill> |
|
setSkills
Optional. Skills represent a unit of ability an agent can perform.
| Parameter | |
|---|---|
| Name | Description |
var |
array<AgentSkill>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSupportsAuthenticatedExtendedCard
Optional. Whether the agent supports providing an extended agent card when the user is authenticated.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSupportsAuthenticatedExtendedCard
Optional. Whether the agent supports providing an extended agent card when the user is authenticated.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSignatures
Optional. JSON Web Signatures computed for this AgentCard.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<AgentCardSignature> |
|
setSignatures
Optional. JSON Web Signatures computed for this AgentCard.
| Parameter | |
|---|---|
| Name | Description |
var |
array<AgentCardSignature>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIconUrl
Optional. An optional URL to an icon for the agent.
| Returns | |
|---|---|
| Type | Description |
string |
|
setIconUrl
Optional. An optional URL to an icon for the agent.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|