service_connection_maps

Creates, updates, deletes, gets or lists a service_connection_maps resource.

Overview

Name	service_connection_maps
Type	Resource
Id	google.networkconnectivity.service_connection_maps

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names
consumerPscConfigs	array	The PSC configurations on consumer side.
consumerPscConnections	array	Output only. PSC connection details on consumer side.
createTime	string (google-datetime)	Output only. Time when the ServiceConnectionMap was created.
description	string	A description of this resource.
etag	string	Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
infrastructure	string	Output only. The infrastructure used for connections between consumers/producers. (INFRASTRUCTURE_UNSPECIFIED, PSC)
labels	object	User-defined labels.
producerPscConfigs	array	The PSC configurations on producer side.
serviceClass	string	The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnectivity.serviceClasses.use IAM permission for the service class.
serviceClassUri	string	Output only. The service class uri this ServiceConnectionMap is for.
token	string	The token provided by the consumer. This token authenticates that the consumer can create a connection within the specified project and network.
updateTime	string (google-datetime)	Output only. Time when the ServiceConnectionMap was updated.

list

Name	Datatype	Description
name	string	Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names
consumerPscConfigs	array	The PSC configurations on consumer side.
consumerPscConnections	array	Output only. PSC connection details on consumer side.
createTime	string (google-datetime)	Output only. Time when the ServiceConnectionMap was created.
description	string	A description of this resource.
etag	string	Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
infrastructure	string	Output only. The infrastructure used for connections between consumers/producers. (INFRASTRUCTURE_UNSPECIFIED, PSC)
labels	object	User-defined labels.
producerPscConfigs	array	The PSC configurations on producer side.
serviceClass	string	The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnectivity.serviceClasses.use IAM permission for the service class.
serviceClassUri	string	Output only. The service class uri this ServiceConnectionMap is for.
token	string	The token provided by the consumer. This token authenticates that the consumer can create a connection within the specified project and network.
updateTime	string (google-datetime)	Output only. Time when the ServiceConnectionMap was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, serviceConnectionMapsId		Gets details of a single ServiceConnectionMap.
list	select	projectsId, locationsId	orderBy, pageSize, filter, pageToken	Lists ServiceConnectionMaps in a given project and location.
create	insert	projectsId, locationsId	serviceConnectionMapId, requestId	Creates a new ServiceConnectionMap in a given project and location.
patch	update	projectsId, locationsId, serviceConnectionMapsId	requestId, updateMask	Updates the parameters of a single ServiceConnectionMap.
delete	delete	projectsId, locationsId, serviceConnectionMapsId	etag, requestId	Deletes a single ServiceConnectionMap.

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
locationsId	string
projectsId	string
serviceConnectionMapsId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
serviceConnectionMapId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single ServiceConnectionMap.

SELECT
name,
consumerPscConfigs,
consumerPscConnections,
createTime,
description,
etag,
infrastructure,
labels,
producerPscConfigs,
serviceClass,
serviceClassUri,
token,
updateTime
FROM google.networkconnectivity.service_connection_maps
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND serviceConnectionMapsId = '{{ serviceConnectionMapsId }}' -- required
;

list

Lists ServiceConnectionMaps in a given project and location.

SELECT
name,
consumerPscConfigs,
consumerPscConnections,
createTime,
description,
etag,
infrastructure,
labels,
producerPscConfigs,
serviceClass,
serviceClassUri,
token,
updateTime
FROM google.networkconnectivity.service_connection_maps
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new ServiceConnectionMap in a given project and location.

INSERT INTO google.networkconnectivity.service_connection_maps (
data__serviceClass,
data__labels,
data__producerPscConfigs,
data__consumerPscConfigs,
data__etag,
data__token,
data__description,
data__name,
projectsId,
locationsId,
serviceConnectionMapId,
requestId
)
SELECT 
'{{ serviceClass }}',
'{{ labels }}',
'{{ producerPscConfigs }}',
'{{ consumerPscConfigs }}',
'{{ etag }}',
'{{ token }}',
'{{ description }}',
'{{ name }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ serviceConnectionMapId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: service_connection_maps
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the service_connection_maps resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the service_connection_maps resource.
  - name: serviceClass
    value: "{{ serviceClass }}"
    description: |
      The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnectivity.serviceClasses.use IAM permission for the service class.
  - name: labels
    value: "{{ labels }}"
    description: |
      User-defined labels.
  - name: producerPscConfigs
    description: |
      The PSC configurations on producer side.
    value:
      - serviceAttachmentUri: "{{ serviceAttachmentUri }}"
        automatedDnsCreationSpec:
          dnsSuffix: "{{ dnsSuffix }}"
          ttl: "{{ ttl }}"
          hostname: "{{ hostname }}"
  - name: consumerPscConfigs
    description: |
      The PSC configurations on consumer side.
    value:
      - disableGlobalAccess: {{ disableGlobalAccess }}
        project: "{{ project }}"
        ipVersion: "{{ ipVersion }}"
        producerInstanceMetadata: "{{ producerInstanceMetadata }}"
        consumerInstanceProject: "{{ consumerInstanceProject }}"
        producerInstanceId: "{{ producerInstanceId }}"
        serviceAttachmentIpAddressMap: "{{ serviceAttachmentIpAddressMap }}"
        state: "{{ state }}"
        network: "{{ network }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  - name: token
    value: "{{ token }}"
    description: |
      The token provided by the consumer. This token authenticates that the consumer can create a connection within the specified project and network.
  - name: description
    value: "{{ description }}"
    description: |
      A description of this resource.
  - name: name
    value: "{{ name }}"
    description: |
      Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names
  - name: serviceConnectionMapId
    value: "{{ serviceConnectionMapId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the parameters of a single ServiceConnectionMap.

UPDATE google.networkconnectivity.service_connection_maps
SET 
data__serviceClass = '{{ serviceClass }}',
data__labels = '{{ labels }}',
data__producerPscConfigs = '{{ producerPscConfigs }}',
data__consumerPscConfigs = '{{ consumerPscConfigs }}',
data__etag = '{{ etag }}',
data__token = '{{ token }}',
data__description = '{{ description }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND serviceConnectionMapsId = '{{ serviceConnectionMapsId }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single ServiceConnectionMap.

DELETE FROM google.networkconnectivity.service_connection_maps
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND serviceConnectionMapsId = '{{ serviceConnectionMapsId }}' --required
AND etag = '{{ etag }}'
AND requestId = '{{ requestId }}'
;