connection_profiles

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

Overview

Name	connection_profiles
Type	Resource
Id	google.datastream.connection_profiles

Fields

Name	Datatype	Description
name	string	Output only. The resource's name.
bigqueryProfile	object	BigQuery warehouse profile.
createTime	string	Output only. The create time of the resource.
displayName	string	Required. Display name.
forwardSshConnectivity	object	Forward SSH Tunnel connectivity.
gcsProfile	object	Cloud Storage bucket profile.
labels	object	Labels.
mysqlProfile	object	MySQL database profile.
oracleProfile	object	Oracle database profile.
postgresqlProfile	object	PostgreSQL database profile.
privateConnectivity	object	Private Connectivity
sqlServerProfile	object	SQLServer database profile
staticServiceIpConnectivity	object	Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile.
updateTime	string	Output only. The update time of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	connectionProfilesId, locationsId, projectsId	Use this method to get details about a connection profile.
list	SELECT	locationsId, projectsId	Use this method to list connection profiles created in a project and location.
create	INSERT	locationsId, projectsId	Use this method to create a connection profile in a project and location.
delete	DELETE	connectionProfilesId, locationsId, projectsId	Use this method to delete a connection profile.
patch	UPDATE	connectionProfilesId, locationsId, projectsId	Use this method to update the parameters of a connection profile.
discover	EXEC	locationsId, projectsId	Use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects of a parent data object that's optionally supplied in the request.

SELECT examples

Use this method to list connection profiles created in a project and location.

SELECT
name,
bigqueryProfile,
createTime,
displayName,
forwardSshConnectivity,
gcsProfile,
labels,
mysqlProfile,
oracleProfile,
postgresqlProfile,
privateConnectivity,
sqlServerProfile,
staticServiceIpConnectivity,
updateTime
FROM google.datastream.connection_profiles
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new connection_profiles resource.

All Properties

/*+ create */
INSERT INTO google.datastream.connection_profiles (
locationsId,
projectsId,
labels,
displayName,
oracleProfile,
gcsProfile,
mysqlProfile,
bigqueryProfile,
postgresqlProfile,
sqlServerProfile,
staticServiceIpConnectivity,
forwardSshConnectivity,
privateConnectivity
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ labels }}',
'{{ displayName }}',
'{{ oracleProfile }}',
'{{ gcsProfile }}',
'{{ mysqlProfile }}',
'{{ bigqueryProfile }}',
'{{ postgresqlProfile }}',
'{{ sqlServerProfile }}',
'{{ staticServiceIpConnectivity }}',
'{{ forwardSshConnectivity }}',
'{{ privateConnectivity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: displayName
      value: string
    - name: oracleProfile
      value:
        - name: hostname
          value: string
        - name: port
          value: integer
        - name: username
          value: string
        - name: password
          value: string
        - name: databaseService
          value: string
        - name: connectionAttributes
          value: object
        - name: oracleSslConfig
          value:
            - name: caCertificate
              value: string
            - name: caCertificateSet
              value: boolean
    - name: gcsProfile
      value:
        - name: bucket
          value: string
        - name: rootPath
          value: string
    - name: mysqlProfile
      value:
        - name: hostname
          value: string
        - name: port
          value: integer
        - name: username
          value: string
        - name: password
          value: string
        - name: sslConfig
          value:
            - name: clientKey
              value: string
            - name: clientKeySet
              value: boolean
            - name: clientCertificate
              value: string
            - name: clientCertificateSet
              value: boolean
            - name: caCertificate
              value: string
            - name: caCertificateSet
              value: boolean
    - name: bigqueryProfile
      value: []
    - name: postgresqlProfile
      value:
        - name: hostname
          value: string
        - name: port
          value: integer
        - name: username
          value: string
        - name: password
          value: string
        - name: database
          value: string
    - name: sqlServerProfile
      value:
        - name: hostname
          value: string
        - name: port
          value: integer
        - name: username
          value: string
        - name: password
          value: string
        - name: database
          value: string
    - name: staticServiceIpConnectivity
      value: []
    - name: forwardSshConnectivity
      value:
        - name: hostname
          value: string
        - name: username
          value: string
        - name: port
          value: integer
        - name: password
          value: string
        - name: privateKey
          value: string
    - name: privateConnectivity
      value:
        - name: privateConnection
          value: string

UPDATE example

Updates a connection_profiles resource.

/*+ update */
UPDATE google.datastream.connection_profiles
SET 
labels = '{{ labels }}',
displayName = '{{ displayName }}',
oracleProfile = '{{ oracleProfile }}',
gcsProfile = '{{ gcsProfile }}',
mysqlProfile = '{{ mysqlProfile }}',
bigqueryProfile = '{{ bigqueryProfile }}',
postgresqlProfile = '{{ postgresqlProfile }}',
sqlServerProfile = '{{ sqlServerProfile }}',
staticServiceIpConnectivity = '{{ staticServiceIpConnectivity }}',
forwardSshConnectivity = '{{ forwardSshConnectivity }}',
privateConnectivity = '{{ privateConnectivity }}'
WHERE 
connectionProfilesId = '{{ connectionProfilesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified connection_profiles resource.

/*+ delete */
DELETE FROM google.datastream.connection_profiles
WHERE connectionProfilesId = '{{ connectionProfilesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';