agent_connectivity_templates

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

Overview

Name	agent_connectivity_templates
Type	Resource
Id	google.networkservices.agent_connectivity_templates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern projects/*/locations/*/agentConnectivityTemplates/.
accessPath	string	Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set. (ACCESS_PATH_UNSPECIFIED, CLIENT_TO_AGENT, AGENT_TO_ANYWHERE)
accessTypes	array	Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
agentCompute	string	Optional. The compute environment where the agent is hosted. Exactly one type of compute must be chosen. (AGENT_COMPUTE_UNSPECIFIED, GKE, CLOUD_RUN, BORG)
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
deploymentModel	string	Required. The deployment model for the gateway. (DEPLOYMENT_MODEL_UNSPECIFIED, CENTRALIZED, AMBIENT)
description	string	Optional. A free-text description of the resource. Max length 1024 characters.
egressNetworkConfig	object	Optional. Configuration for egress network traffic. (id: EgressNetworkConfig)
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.
labels	object	Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

list

Name	Datatype	Description
name	string	Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern projects/*/locations/*/agentConnectivityTemplates/.
accessPath	string	Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set. (ACCESS_PATH_UNSPECIFIED, CLIENT_TO_AGENT, AGENT_TO_ANYWHERE)
accessTypes	array	Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
agentCompute	string	Optional. The compute environment where the agent is hosted. Exactly one type of compute must be chosen. (AGENT_COMPUTE_UNSPECIFIED, GKE, CLOUD_RUN, BORG)
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
deploymentModel	string	Required. The deployment model for the gateway. (DEPLOYMENT_MODEL_UNSPECIFIED, CENTRALIZED, AMBIENT)
description	string	Optional. A free-text description of the resource. Max length 1024 characters.
egressNetworkConfig	object	Optional. Configuration for egress network traffic. (id: EgressNetworkConfig)
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.
labels	object	Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
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, agentConnectivityTemplatesId		Gets details of a single AgentConnectivityTemplate.
list	select	projectsId, locationsId	pageSize, pageToken, returnPartialSuccess	Lists AgentConnectivityTemplates in a given project and location.
create	insert	projectsId, locationsId	agentConnectivityTemplateId	Creates a new AgentConnectivityTemplate in a given project and location.
patch	update	projectsId, locationsId, agentConnectivityTemplatesId	updateMask	Updates the parameters of a single AgentConnectivityTemplate.
delete	delete	projectsId, locationsId, agentConnectivityTemplatesId	etag	Deletes a single AgentConnectivityTemplate.

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
agentConnectivityTemplatesId	string
locationsId	string
projectsId	string
agentConnectivityTemplateId	string
etag	string
pageSize	integer (int32)
pageToken	string
returnPartialSuccess	boolean
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single AgentConnectivityTemplate.

SELECT
name,
accessPath,
accessTypes,
agentCompute,
createTime,
deploymentModel,
description,
egressNetworkConfig,
etag,
labels,
updateTime
FROM google.networkservices.agent_connectivity_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentConnectivityTemplatesId = '{{ agentConnectivityTemplatesId }}' -- required
;

list

Lists AgentConnectivityTemplates in a given project and location.

SELECT
name,
accessPath,
accessTypes,
agentCompute,
createTime,
deploymentModel,
description,
egressNetworkConfig,
etag,
labels,
updateTime
FROM google.networkservices.agent_connectivity_templates
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

INSERT examples

create

Creates a new AgentConnectivityTemplate in a given project and location.

INSERT INTO google.networkservices.agent_connectivity_templates (
data__accessPath,
data__accessTypes,
data__agentCompute,
data__deploymentModel,
data__description,
data__egressNetworkConfig,
data__etag,
data__labels,
data__name,
projectsId,
locationsId,
agentConnectivityTemplateId
)
SELECT 
'{{ accessPath }}',
'{{ accessTypes }}',
'{{ agentCompute }}',
'{{ deploymentModel }}',
'{{ description }}',
'{{ egressNetworkConfig }}',
'{{ etag }}',
'{{ labels }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentConnectivityTemplateId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: agent_connectivity_templates
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the agent_connectivity_templates resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the agent_connectivity_templates resource.
  - name: accessPath
    value: "{{ accessPath }}"
    description: |
      Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.
    valid_values: ['ACCESS_PATH_UNSPECIFIED', 'CLIENT_TO_AGENT', 'AGENT_TO_ANYWHERE']
  - name: accessTypes
    value:
      - "{{ accessTypes }}"
    description: |
      Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.
  - name: agentCompute
    value: "{{ agentCompute }}"
    description: |
      Optional. The compute environment where the agent is hosted. Exactly one type of compute must be chosen.
    valid_values: ['AGENT_COMPUTE_UNSPECIFIED', 'GKE', 'CLOUD_RUN', 'BORG']
  - name: deploymentModel
    value: "{{ deploymentModel }}"
    description: |
      Required. The deployment model for the gateway.
    valid_values: ['DEPLOYMENT_MODEL_UNSPECIFIED', 'CENTRALIZED', 'AMBIENT']
  - name: description
    value: "{{ description }}"
    description: |
      Optional. A free-text description of the resource. Max length 1024 characters.
  - name: egressNetworkConfig
    description: |
      Optional. Configuration for egress network traffic.
    value:
      dnsPeeringConfig:
        domain: "{{ domain }}"
        targetNetwork: "{{ targetNetwork }}"
      networkAttachment: "{{ networkAttachment }}"
      trustConfig: "{{ trustConfig }}"
      vpcEgress: "{{ vpcEgress }}"
  - 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: labels
    value: "{{ labels }}"
    description: |
      Optional. Set of label tags associated with the AgentConnectivityTemplate resource.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.
  - name: agentConnectivityTemplateId
    value: "{{ agentConnectivityTemplateId }}"

UPDATE examples

patch

Updates the parameters of a single AgentConnectivityTemplate.

UPDATE google.networkservices.agent_connectivity_templates
SET 
data__accessPath = '{{ accessPath }}',
data__accessTypes = '{{ accessTypes }}',
data__agentCompute = '{{ agentCompute }}',
data__deploymentModel = '{{ deploymentModel }}',
data__description = '{{ description }}',
data__egressNetworkConfig = '{{ egressNetworkConfig }}',
data__etag = '{{ etag }}',
data__labels = '{{ labels }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentConnectivityTemplatesId = '{{ agentConnectivityTemplatesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single AgentConnectivityTemplate.

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