Reference documentation and code samples for the Google Cloud Agent Registry V1 Client class Service.
Represents a user-defined Service.
Generated from protobuf message google.cloud.agentregistry.v1.Service
Namespace
Google \ Cloud \ AgentRegistry \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ agent_spec |
Service\AgentSpec
Optional. The spec of the Agent. When |
↳ mcp_server_spec |
Service\McpServerSpec
Optional. The spec of the MCP Server. When |
↳ endpoint_spec |
Service\EndpointSpec
Optional. The spec of the Endpoint. When |
↳ name |
string
Identifier. The resource name of the Service. Format: |
↳ display_name |
string
Optional. User-defined display name for the Service. Can have a maximum length of |
↳ description |
string
Optional. User-defined description of an Service. Can have a maximum length of |
↳ interfaces |
array<PBInterface>
Optional. The connection details for the Service. |
↳ registry_resource |
string
Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format: * * |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Create time. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Update time. |
getAgentSpec
Optional. The spec of the Agent. When agent_spec is set, the type of
the service is Agent.
| Returns | |
|---|---|
| Type | Description |
Service\AgentSpec|null |
|
hasAgentSpec
setAgentSpec
Optional. The spec of the Agent. When agent_spec is set, the type of
the service is Agent.
| Parameter | |
|---|---|
| Name | Description |
var |
Service\AgentSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMcpServerSpec
Optional. The spec of the MCP Server. When mcp_server_spec is set, the
type of the service is MCP Server.
| Returns | |
|---|---|
| Type | Description |
Service\McpServerSpec|null |
|
hasMcpServerSpec
setMcpServerSpec
Optional. The spec of the MCP Server. When mcp_server_spec is set, the
type of the service is MCP Server.
| Parameter | |
|---|---|
| Name | Description |
var |
Service\McpServerSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndpointSpec
Optional. The spec of the Endpoint. When endpoint_spec is set, the type
of the service is Endpoint.
| Returns | |
|---|---|
| Type | Description |
Service\EndpointSpec|null |
|
hasEndpointSpec
setEndpointSpec
Optional. The spec of the Endpoint. When endpoint_spec is set, the type
of the service is Endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
Service\EndpointSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Identifier. The resource name of the Service.
Format: projects/{project}/locations/{location}/services/{service}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the Service.
Format: projects/{project}/locations/{location}/services/{service}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. User-defined display name for the Service.
Can have a maximum length of 63 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. User-defined display name for the Service.
Can have a maximum length of 63 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. User-defined description of an Service.
Can have a maximum length of 2048 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. User-defined description of an Service.
Can have a maximum length of 2048 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInterfaces
Optional. The connection details for the Service.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<PBInterface> |
|
setInterfaces
Optional. The connection details for the Service.
| Parameter | |
|---|---|
| Name | Description |
var |
array<PBInterface>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRegistryResource
Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format:
projects/{project}/locations/{location}/mcpServers/{mcp_server}projects/{project}/locations/{location}/agents/{agent}projects/{project}/locations/{location}/endpoints/{endpoint}
| Returns | |
|---|---|
| Type | Description |
string |
|
setRegistryResource
Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format:
projects/{project}/locations/{location}/mcpServers/{mcp_server}projects/{project}/locations/{location}/agents/{agent}projects/{project}/locations/{location}/endpoints/{endpoint}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Create time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Update time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSpec
| Returns | |
|---|---|
| Type | Description |
string |
|