agent_gateways

Creates, updates, deletes, gets or lists an agent_gateways resource.

Overview

Name	`agent_gateways`
Type	Resource
Id	`google.networkservices.agent_gateways`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`name`	`string`	Identifier. Name of the AgentGateway resource. It matches pattern `projects//locations//agentGateways/`.
`agentGatewayCard`	`object`	Output only. Field for populated AgentGateway card. (id: AgentGatewayAgentGatewayOutputCard)
`createTime`	`string (google-datetime)`	Output only. The timestamp when the resource was created.
`description`	`string`	Optional. A free-text description of the resource. Max length 1024 characters.
`etag`	`string`	Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
`googleManaged`	`object`	Optional. Proxy is orchestrated and managed by GoogleCloud in a tenant project. (id: AgentGatewayGoogleManaged)
`labels`	`object`	Optional. Set of label tags associated with the AgentGateway resource.
`networkConfig`	`object`	Optional. Network configuration for the AgentGateway. (id: AgentGatewayNetworkConfig)
`protocols`	`array`	Optional. Deprecated.
`registries`	`array`	Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/`
`selfManaged`	`object`	Optional. Attach to existing Application Load Balancers or Secure Web Proxies. (id: AgentGatewaySelfManaged)
`updateTime`	`string (google-datetime)`	Output only. The timestamp when the resource was updated.

Name	Datatype	Description
`name`	`string`	Identifier. Name of the AgentGateway resource. It matches pattern `projects//locations//agentGateways/`.
`agentGatewayCard`	`object`	Output only. Field for populated AgentGateway card. (id: AgentGatewayAgentGatewayOutputCard)
`createTime`	`string (google-datetime)`	Output only. The timestamp when the resource was created.
`description`	`string`	Optional. A free-text description of the resource. Max length 1024 characters.
`etag`	`string`	Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
`googleManaged`	`object`	Optional. Proxy is orchestrated and managed by GoogleCloud in a tenant project. (id: AgentGatewayGoogleManaged)
`labels`	`object`	Optional. Set of label tags associated with the AgentGateway resource.
`networkConfig`	`object`	Optional. Network configuration for the AgentGateway. (id: AgentGatewayNetworkConfig)
`protocols`	`array`	Optional. Deprecated.
`registries`	`array`	Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/`
`selfManaged`	`object`	Optional. Attach to existing Application Load Balancers or Secure Web Proxies. (id: AgentGatewaySelfManaged)
`updateTime`	`string (google-datetime)`	Output only. The timestamp when the resource was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `agentGatewaysId`		Gets details of a single AgentGateway.
`list`	`select`	`projectsId`, `locationsId`	`pageSize`, `pageToken`, `returnPartialSuccess`	Lists AgentGateways in a given project and location.
`create`	`insert`	`projectsId`, `locationsId`	`agentGatewayId`	Creates a new AgentGateway in a given project and location.
`patch`	`update`	`projectsId`, `locationsId`, `agentGatewaysId`	`updateMask`	Updates the parameters of a single AgentGateway.
`delete`	`delete`	`projectsId`, `locationsId`, `agentGatewaysId`	`etag`	Deletes a single AgentGateway.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`agentGatewaysId`	`string`
`locationsId`	`string`
`projectsId`	`string`
`agentGatewayId`	`string`
`etag`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`returnPartialSuccess`	`boolean`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Gets details of a single AgentGateway.

SELECT
name,
agentGatewayCard,
createTime,
description,
etag,
googleManaged,
labels,
networkConfig,
protocols,
registries,
selfManaged,
updateTime
FROM google.networkservices.agent_gateways
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentGatewaysId = '{{ agentGatewaysId }}' -- required
;

Lists AgentGateways in a given project and location.

SELECT
name,
agentGatewayCard,
createTime,
description,
etag,
googleManaged,
labels,
networkConfig,
protocols,
registries,
selfManaged,
updateTime
FROM google.networkservices.agent_gateways
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

`INSERT` examples

create
Manifest

Creates a new AgentGateway in a given project and location.

INSERT INTO google.networkservices.agent_gateways (
data__googleManaged,
data__selfManaged,
data__name,
data__labels,
data__description,
data__etag,
data__protocols,
data__registries,
data__networkConfig,
projectsId,
locationsId,
agentGatewayId
)
SELECT 
'{{ googleManaged }}',
'{{ selfManaged }}',
'{{ name }}',
'{{ labels }}',
'{{ description }}',
'{{ etag }}',
'{{ protocols }}',
'{{ registries }}',
'{{ networkConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentGatewayId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: agent_gateways
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the agent_gateways resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the agent_gateways resource.
  - name: googleManaged
    description: |
      Optional. Proxy is orchestrated and managed by GoogleCloud in a tenant project.
    value:
      governedAccessPath: "{{ governedAccessPath }}"
  - name: selfManaged
    description: |
      Optional. Attach to existing Application Load Balancers or Secure Web Proxies.
    value:
      resourceUri: "{{ resourceUri }}"
      resourceUris:
        - "{{ resourceUris }}"
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Set of label tags associated with the AgentGateway resource.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. A free-text description of the resource. Max length 1024 characters.
  - name: etag
    value: "{{ etag }}"
    description: |
      Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
  - name: protocols
    value:
      - "{{ protocols }}"
    description: |
      Optional. Deprecated.
  - name: registries
    value:
      - "{{ registries }}"
    description: |
      Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/`
  - name: networkConfig
    description: |
      Optional. Network configuration for the AgentGateway.
    value:
      egress:
        networkAttachment: "{{ networkAttachment }}"
      dnsPeeringConfig:
        domains:
          - "{{ domains }}"
        targetProject: "{{ targetProject }}"
        targetNetwork: "{{ targetNetwork }}"
  - name: agentGatewayId
    value: "{{ agentGatewayId }}"

`UPDATE` examples

patch

Updates the parameters of a single AgentGateway.

UPDATE google.networkservices.agent_gateways
SET 
data__googleManaged = '{{ googleManaged }}',
data__selfManaged = '{{ selfManaged }}',
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__etag = '{{ etag }}',
data__protocols = '{{ protocols }}',
data__registries = '{{ registries }}',
data__networkConfig = '{{ networkConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentGatewaysId = '{{ agentGatewaysId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

delete

Deletes a single AgentGateway.

DELETE FROM google.networkservices.agent_gateways
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentGatewaysId = '{{ agentGatewaysId }}' --required
AND etag = '{{ etag }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​