service_connection_policies

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

Overview

Name	`service_connection_policies`
Type	Resource
Id	`google.networkconnectivity.service_connection_policies`

Fields

The following fields are returned by SELECT queries:

get
list

Successful response

Name	Datatype	Description
`name`	`string`	Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
`createTime`	`string (google-datetime)`	Output only. Time when the ServiceConnectionPolicy 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 type of underlying resources used to create the connection.
`labels`	`object`	User-defined labels.
`network`	`string`	The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
`pscConfig`	`object`	Configuration used for Private Service Connect connections. Used when Infrastructure is PSC. (id: PscConfig)
`pscConnections`	`array`	Output only. [Output only] Information about each Private Service Connect connection.
`serviceClass`	`string`	The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
`updateTime`	`string (google-datetime)`	Output only. Time when the ServiceConnectionPolicy was updated.

Successful response

Name	Datatype	Description
`name`	`string`	Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
`createTime`	`string (google-datetime)`	Output only. Time when the ServiceConnectionPolicy 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 type of underlying resources used to create the connection.
`labels`	`object`	User-defined labels.
`network`	`string`	The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
`pscConfig`	`object`	Configuration used for Private Service Connect connections. Used when Infrastructure is PSC. (id: PscConfig)
`pscConnections`	`array`	Output only. [Output only] Information about each Private Service Connect connection.
`serviceClass`	`string`	The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
`updateTime`	`string (google-datetime)`	Output only. Time when the ServiceConnectionPolicy was updated.

Methods

The following methods are available for this resource:

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

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`
`serviceConnectionPoliciesId`	`string`
`etag`	`string`
`filter`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`requestId`	`string`
`serviceConnectionPolicyId`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Gets details of a single ServiceConnectionPolicy.

SELECT
name,
createTime,
description,
etag,
infrastructure,
labels,
network,
pscConfig,
pscConnections,
serviceClass,
updateTime
FROM google.networkconnectivity.service_connection_policies
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND serviceConnectionPoliciesId = '{{ serviceConnectionPoliciesId }}' -- required;

Lists ServiceConnectionPolicies in a given project and location.

SELECT
name,
createTime,
description,
etag,
infrastructure,
labels,
network,
pscConfig,
pscConnections,
serviceClass,
updateTime
FROM google.networkconnectivity.service_connection_policies
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

`INSERT` examples

create
Manifest

Creates a new ServiceConnectionPolicy in a given project and location.

INSERT INTO google.networkconnectivity.service_connection_policies (
data__name,
data__labels,
data__description,
data__network,
data__serviceClass,
data__pscConfig,
data__etag,
projectsId,
locationsId,
serviceConnectionPolicyId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ description }}',
'{{ network }}',
'{{ serviceClass }}',
'{{ pscConfig }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ serviceConnectionPolicyId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: service_connection_policies
  props:
    - name: projectsId
      value: string
      description: Required parameter for the service_connection_policies resource.
    - name: locationsId
      value: string
      description: Required parameter for the service_connection_policies resource.
    - name: name
      value: string
      description: >
        Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names
        
    - name: labels
      value: object
      description: >
        User-defined labels.
        
    - name: description
      value: string
      description: >
        A description of this resource.
        
    - name: network
      value: string
      description: >
        The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.
        
    - name: serviceClass
      value: string
      description: >
        The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.
        
    - name: pscConfig
      value: object
      description: >
        Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.
        
    - name: etag
      value: string
      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: serviceConnectionPolicyId
      value: string
    - name: requestId
      value: string

`UPDATE` examples

patch

Updates the parameters of a single ServiceConnectionPolicy.

UPDATE google.networkconnectivity.service_connection_policies
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__network = '{{ network }}',
data__serviceClass = '{{ serviceClass }}',
data__pscConfig = '{{ pscConfig }}',
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND serviceConnectionPoliciesId = '{{ serviceConnectionPoliciesId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

delete

Deletes a single ServiceConnectionPolicy.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​