connections

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

Overview

Name	connections
Type	Resource
Id	google.dlp.connections

Fields

The following fields are returned by SELECT queries:

projects_locations_connections_get

Name	Datatype	Description
name	string	Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.
cloudSql	object	Connect to a Cloud SQL instance. (id: GooglePrivacyDlpV2CloudSqlProperties)
errors	array	Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
state	string	Required. The connection's state in its lifecycle. (CONNECTION_STATE_UNSPECIFIED, MISSING_CREDENTIALS, AVAILABLE, ERROR)

organizations_locations_connections_get

Name	Datatype	Description
name	string	Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.
cloudSql	object	Connect to a Cloud SQL instance. (id: GooglePrivacyDlpV2CloudSqlProperties)
errors	array	Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
state	string	Required. The connection's state in its lifecycle. (CONNECTION_STATE_UNSPECIFIED, MISSING_CREDENTIALS, AVAILABLE, ERROR)

projects_locations_connections_list

Name	Datatype	Description
name	string	Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.
cloudSql	object	Connect to a Cloud SQL instance. (id: GooglePrivacyDlpV2CloudSqlProperties)
errors	array	Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
state	string	Required. The connection's state in its lifecycle. (CONNECTION_STATE_UNSPECIFIED, MISSING_CREDENTIALS, AVAILABLE, ERROR)

organizations_locations_connections_list

Name	Datatype	Description
name	string	Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.
cloudSql	object	Connect to a Cloud SQL instance. (id: GooglePrivacyDlpV2CloudSqlProperties)
errors	array	Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
state	string	Required. The connection's state in its lifecycle. (CONNECTION_STATE_UNSPECIFIED, MISSING_CREDENTIALS, AVAILABLE, ERROR)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_connections_get	select	projectsId, locationsId, connectionsId		Get a Connection by name.
organizations_locations_connections_get	select	organizationsId, locationsId, connectionsId		Get a Connection by name.
projects_locations_connections_list	select	projectsId, locationsId	pageSize, pageToken, filter	Lists Connections in a parent. Use SearchConnections to see all connections within an organization.
organizations_locations_connections_list	select	organizationsId, locationsId	pageToken, filter, pageSize	Lists Connections in a parent. Use SearchConnections to see all connections within an organization.
projects_locations_connections_create	insert	projectsId, locationsId		Create a Connection to an external data source.
organizations_locations_connections_create	insert	organizationsId, locationsId		Create a Connection to an external data source.
projects_locations_connections_patch	update	projectsId, locationsId, connectionsId		Update a Connection.
organizations_locations_connections_patch	update	organizationsId, locationsId, connectionsId		Update a Connection.
projects_locations_connections_delete	delete	projectsId, locationsId, connectionsId		Delete a Connection.
organizations_locations_connections_delete	delete	organizationsId, locationsId, connectionsId		Delete a Connection.
projects_locations_connections_search	exec	projectsId, locationsId	pageToken, filter, pageSize	Searches for Connections in a parent.
organizations_locations_connections_search	exec	organizationsId, locationsId	pageSize, pageToken, filter	Searches for Connections in a parent.

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
connectionsId	string
locationsId	string
organizationsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_connections_get

Get a Connection by name.

SELECT
name,
cloudSql,
errors,
state
FROM google.dlp.connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND connectionsId = '{{ connectionsId }}' -- required
;

organizations_locations_connections_get

Get a Connection by name.

SELECT
name,
cloudSql,
errors,
state
FROM google.dlp.connections
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND connectionsId = '{{ connectionsId }}' -- required
;

projects_locations_connections_list

Lists Connections in a parent. Use SearchConnections to see all connections within an organization.

SELECT
name,
cloudSql,
errors,
state
FROM google.dlp.connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
;

organizations_locations_connections_list

Lists Connections in a parent. Use SearchConnections to see all connections within an organization.

SELECT
name,
cloudSql,
errors,
state
FROM google.dlp.connections
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

projects_locations_connections_create

Create a Connection to an external data source.

INSERT INTO google.dlp.connections (
data__connection,
projectsId,
locationsId
)
SELECT 
'{{ connection }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
cloudSql,
errors,
state
;

organizations_locations_connections_create

Create a Connection to an external data source.

INSERT INTO google.dlp.connections (
data__connection,
organizationsId,
locationsId
)
SELECT 
'{{ connection }}',
'{{ organizationsId }}',
'{{ locationsId }}'
RETURNING
name,
cloudSql,
errors,
state
;

Manifest

# Description fields are for documentation purposes
- name: connections
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the connections resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the connections resource.
  - name: organizationsId
    value: "{{ organizationsId }}"
    description: Required parameter for the connections resource.
  - name: connection
    description: |
      A data connection to allow the DLP API to profile data in locations that require additional configuration.
    value:
      name: "{{ name }}"
      errors:
        - timestamps: "{{ timestamps }}"
          extraInfo: "{{ extraInfo }}"
          details:
            message: "{{ message }}"
            details: "{{ details }}"
            code: {{ code }}
      cloudSql:
        connectionName: "{{ connectionName }}"
        usernamePassword:
          username: "{{ username }}"
          passwordSecretVersionName: "{{ passwordSecretVersionName }}"
        maxConnections: {{ maxConnections }}
        cloudSqlIam: "{{ cloudSqlIam }}"
        databaseEngine: "{{ databaseEngine }}"
      state: "{{ state }}"

UPDATE examples

projects_locations_connections_patch

Update a Connection.

UPDATE google.dlp.connections
SET 
data__updateMask = '{{ updateMask }}',
data__connection = '{{ connection }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectionsId = '{{ connectionsId }}' --required
RETURNING
name,
cloudSql,
errors,
state;

organizations_locations_connections_patch

Update a Connection.

UPDATE google.dlp.connections
SET 
data__updateMask = '{{ updateMask }}',
data__connection = '{{ connection }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectionsId = '{{ connectionsId }}' --required
RETURNING
name,
cloudSql,
errors,
state;

DELETE examples

projects_locations_connections_delete

Delete a Connection.

DELETE FROM google.dlp.connections
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectionsId = '{{ connectionsId }}' --required
;

organizations_locations_connections_delete

Delete a Connection.

DELETE FROM google.dlp.connections
WHERE organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectionsId = '{{ connectionsId }}' --required
;

Lifecycle Methods

projects_locations_connections_search

Searches for Connections in a parent.

EXEC google.dlp.connections.projects_locations_connections_search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@pageToken='{{ pageToken }}', 
@filter='{{ filter }}', 
@pageSize='{{ pageSize }}'
;

organizations_locations_connections_search

Searches for Connections in a parent.

EXEC google.dlp.connections.organizations_locations_connections_search 
@organizationsId='{{ organizationsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@pageSize='{{ pageSize }}', 
@pageToken='{{ pageToken }}', 
@filter='{{ filter }}'
;