connection_profiles

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

Overview

Name	connection_profiles
Type	Resource
Id	google.datastream.connection_profiles

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Identifier. The resource's name.
bigqueryProfile	object	Profile for connecting to a BigQuery destination. (id: BigQueryProfile)
createTime	string (google-datetime)	Output only. The create time of the resource.
dataverseProfile	object	Profile for connecting to a Dataverse source. (id: DataverseProfile)
displayName	string	Required. Display name.
forwardSshConnectivity	object	Forward SSH tunnel connectivity. (id: ForwardSshTunnelConnectivity)
gcsProfile	object	Profile for connecting to a Cloud Storage destination. (id: GcsProfile)
labels	object	Labels.
mongodbProfile	object	Profile for connecting to a MongoDB source. (id: MongodbProfile)
mysqlProfile	object	Profile for connecting to a MySQL source. (id: MysqlProfile)
oracleProfile	object	Profile for connecting to an Oracle source. (id: OracleProfile)
postgresqlProfile	object	Profile for connecting to a PostgreSQL source. (id: PostgresqlProfile)
privateConnectivity	object	Private connectivity. (id: PrivateConnectivity)
salesforceMarketingCloudProfile	object	Profile for connecting to a Salesforce Marketing Cloud source. (id: SalesforceMarketingCloudProfile)
salesforceProfile	object	Profile for connecting to a Salesforce source. (id: SalesforceProfile)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
serviceNowProfile	object	Profile for connecting to a ServiceNow source. (id: ServiceNowProfile)
spannerProfile	object	Profile for connecting to a Spanner source. (id: SpannerProfile)
sqlServerProfile	object	Profile for connecting to a SQLServer source. (id: SqlServerProfile)
staticServiceIpConnectivity	object	Static Service IP connectivity. (id: StaticServiceIpConnectivity)
updateTime	string (google-datetime)	Output only. The update time of the resource.
workdayProfile	object	Optional. Profile for connecting to a Workday source. (id: WorkdayProfile)

list

Name	Datatype	Description
name	string	Output only. Identifier. The resource's name.
bigqueryProfile	object	Profile for connecting to a BigQuery destination. (id: BigQueryProfile)
createTime	string (google-datetime)	Output only. The create time of the resource.
dataverseProfile	object	Profile for connecting to a Dataverse source. (id: DataverseProfile)
displayName	string	Required. Display name.
forwardSshConnectivity	object	Forward SSH tunnel connectivity. (id: ForwardSshTunnelConnectivity)
gcsProfile	object	Profile for connecting to a Cloud Storage destination. (id: GcsProfile)
labels	object	Labels.
mongodbProfile	object	Profile for connecting to a MongoDB source. (id: MongodbProfile)
mysqlProfile	object	Profile for connecting to a MySQL source. (id: MysqlProfile)
oracleProfile	object	Profile for connecting to an Oracle source. (id: OracleProfile)
postgresqlProfile	object	Profile for connecting to a PostgreSQL source. (id: PostgresqlProfile)
privateConnectivity	object	Private connectivity. (id: PrivateConnectivity)
salesforceMarketingCloudProfile	object	Profile for connecting to a Salesforce Marketing Cloud source. (id: SalesforceMarketingCloudProfile)
salesforceProfile	object	Profile for connecting to a Salesforce source. (id: SalesforceProfile)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
serviceNowProfile	object	Profile for connecting to a ServiceNow source. (id: ServiceNowProfile)
spannerProfile	object	Profile for connecting to a Spanner source. (id: SpannerProfile)
sqlServerProfile	object	Profile for connecting to a SQLServer source. (id: SqlServerProfile)
staticServiceIpConnectivity	object	Static Service IP connectivity. (id: StaticServiceIpConnectivity)
updateTime	string (google-datetime)	Output only. The update time of the resource.
workdayProfile	object	Optional. Profile for connecting to a Workday source. (id: WorkdayProfile)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, connectionProfilesId		Use this method to get details about a connection profile.
list	select	projectsId, locationsId	pageToken, filter, pageSize, orderBy	Use this method to list connection profiles created in a project and location.
create	insert	projectsId, locationsId	force, connectionProfileId, requestId, validateOnly	Use this method to create a connection profile in a project and location.
patch	update	projectsId, locationsId, connectionProfilesId	force, validateOnly, requestId, updateMask	Use this method to update the parameters of a connection profile.
delete	delete	projectsId, locationsId, connectionProfilesId	requestId	Use this method to delete a connection profile.
discover	exec	projectsId, locationsId		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.

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
connectionProfilesId	string
locationsId	string
projectsId	string
connectionProfileId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Use this method to get details about a connection profile.

SELECT
name,
bigqueryProfile,
createTime,
dataverseProfile,
displayName,
forwardSshConnectivity,
gcsProfile,
labels,
mongodbProfile,
mysqlProfile,
oracleProfile,
postgresqlProfile,
privateConnectivity,
salesforceMarketingCloudProfile,
salesforceProfile,
satisfiesPzi,
satisfiesPzs,
serviceNowProfile,
spannerProfile,
sqlServerProfile,
staticServiceIpConnectivity,
updateTime,
workdayProfile
FROM google.datastream.connection_profiles
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND connectionProfilesId = '{{ connectionProfilesId }}' -- required
;

list

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

SELECT
name,
bigqueryProfile,
createTime,
dataverseProfile,
displayName,
forwardSshConnectivity,
gcsProfile,
labels,
mongodbProfile,
mysqlProfile,
oracleProfile,
postgresqlProfile,
privateConnectivity,
salesforceMarketingCloudProfile,
salesforceProfile,
satisfiesPzi,
satisfiesPzs,
serviceNowProfile,
spannerProfile,
sqlServerProfile,
staticServiceIpConnectivity,
updateTime,
workdayProfile
FROM google.datastream.connection_profiles
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Use this method to create a connection profile in a project and location.

INSERT INTO google.datastream.connection_profiles (
data__bigqueryProfile,
data__staticServiceIpConnectivity,
data__workdayProfile,
data__privateConnectivity,
data__sqlServerProfile,
data__mongodbProfile,
data__salesforceProfile,
data__oracleProfile,
data__forwardSshConnectivity,
data__spannerProfile,
data__mysqlProfile,
data__displayName,
data__postgresqlProfile,
data__serviceNowProfile,
data__gcsProfile,
data__labels,
data__salesforceMarketingCloudProfile,
data__dataverseProfile,
projectsId,
locationsId,
force,
connectionProfileId,
requestId,
validateOnly
)
SELECT 
'{{ bigqueryProfile }}',
'{{ staticServiceIpConnectivity }}',
'{{ workdayProfile }}',
'{{ privateConnectivity }}',
'{{ sqlServerProfile }}',
'{{ mongodbProfile }}',
'{{ salesforceProfile }}',
'{{ oracleProfile }}',
'{{ forwardSshConnectivity }}',
'{{ spannerProfile }}',
'{{ mysqlProfile }}',
'{{ displayName }}',
'{{ postgresqlProfile }}',
'{{ serviceNowProfile }}',
'{{ gcsProfile }}',
'{{ labels }}',
'{{ salesforceMarketingCloudProfile }}',
'{{ dataverseProfile }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ force }}',
'{{ connectionProfileId }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: connection_profiles
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the connection_profiles resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the connection_profiles resource.
  - name: bigqueryProfile
    value: "{{ bigqueryProfile }}"
    description: |
      Profile for connecting to a BigQuery destination.
  - name: staticServiceIpConnectivity
    value: "{{ staticServiceIpConnectivity }}"
    description: |
      Static Service IP connectivity.
  - name: workdayProfile
    description: |
      Optional. Profile for connecting to a Workday source.
    value:
      host: "{{ host }}"
      oauthRefreshTokenCredentials:
        oauthClientCredentials:
          clientId: "{{ clientId }}"
          clientSecret:
            rawValue: "{{ rawValue }}"
            secretVersion: "{{ secretVersion }}"
        refreshToken:
          rawValue: "{{ rawValue }}"
          secretVersion: "{{ secretVersion }}"
      tenant: "{{ tenant }}"
  - name: privateConnectivity
    description: |
      Private connectivity.
    value:
      privateConnection: "{{ privateConnection }}"
  - name: sqlServerProfile
    description: |
      Profile for connecting to a SQLServer source.
    value:
      secretManagerStoredPassword: "{{ secretManagerStoredPassword }}"
      username: "{{ username }}"
      port: {{ port }}
      password: "{{ password }}"
      database: "{{ database }}"
      hostname: "{{ hostname }}"
      sslConfig:
        encryptionNotEnforced: "{{ encryptionNotEnforced }}"
        basicEncryption: "{{ basicEncryption }}"
        encryptionAndServerValidation:
          caCertificate: "{{ caCertificate }}"
          serverCertificateHostname: "{{ serverCertificateHostname }}"
  - name: mongodbProfile
    description: |
      Profile for connecting to a MongoDB source.
    value:
      srvConnectionFormat: "{{ srvConnectionFormat }}"
      secretManagerStoredPassword: "{{ secretManagerStoredPassword }}"
      username: "{{ username }}"
      password: "{{ password }}"
      replicaSet: "{{ replicaSet }}"
      sslConfig:
        clientKeySet: {{ clientKeySet }}
        caCertificateSet: {{ caCertificateSet }}
        caCertificate: "{{ caCertificate }}"
        clientCertificateSet: {{ clientCertificateSet }}
        clientKey: "{{ clientKey }}"
        secretManagerStoredClientKey: "{{ secretManagerStoredClientKey }}"
        clientCertificate: "{{ clientCertificate }}"
      additionalOptions: "{{ additionalOptions }}"
      standardConnectionFormat:
        directConnection: {{ directConnection }}
      hostAddresses:
        - port: {{ port }}
          hostname: "{{ hostname }}"
  - name: salesforceProfile
    description: |
      Profile for connecting to a Salesforce source.
    value:
      userCredentials:
        username: "{{ username }}"
        secretManagerStoredPassword: "{{ secretManagerStoredPassword }}"
        secretManagerStoredSecurityToken: "{{ secretManagerStoredSecurityToken }}"
        securityToken: "{{ securityToken }}"
        password: "{{ password }}"
      oauth2ClientCredentials:
        clientSecret: "{{ clientSecret }}"
        clientId: "{{ clientId }}"
        secretManagerStoredClientSecret: "{{ secretManagerStoredClientSecret }}"
      domain: "{{ domain }}"
  - name: oracleProfile
    description: |
      Profile for connecting to an Oracle source.
    value:
      connectionAttributes: "{{ connectionAttributes }}"
      oracleAsmConfig:
        port: {{ port }}
        connectionAttributes: "{{ connectionAttributes }}"
        password: "{{ password }}"
        hostname: "{{ hostname }}"
        asmService: "{{ asmService }}"
        oracleSslConfig:
          caCertificate: "{{ caCertificate }}"
          serverCertificateDistinguishedName: "{{ serverCertificateDistinguishedName }}"
          caCertificateSet: {{ caCertificateSet }}
        secretManagerStoredPassword: "{{ secretManagerStoredPassword }}"
        username: "{{ username }}"
      hostname: "{{ hostname }}"
      databaseService: "{{ databaseService }}"
      port: {{ port }}
      password: "{{ password }}"
      oracleSslConfig:
        caCertificate: "{{ caCertificate }}"
        serverCertificateDistinguishedName: "{{ serverCertificateDistinguishedName }}"
        caCertificateSet: {{ caCertificateSet }}
      secretManagerStoredPassword: "{{ secretManagerStoredPassword }}"
      username: "{{ username }}"
  - name: forwardSshConnectivity
    description: |
      Forward SSH tunnel connectivity.
    value:
      hostname: "{{ hostname }}"
      privateKey: "{{ privateKey }}"
      password: "{{ password }}"
      port: {{ port }}
      username: "{{ username }}"
  - name: spannerProfile
    description: |
      Profile for connecting to a Spanner source.
    value:
      host: "{{ host }}"
      database: "{{ database }}"
  - name: mysqlProfile
    description: |
      Profile for connecting to a MySQL source.
    value:
      port: {{ port }}
      password: "{{ password }}"
      hostname: "{{ hostname }}"
      sslConfig:
        caCertificate: "{{ caCertificate }}"
        clientCertificateSet: {{ clientCertificateSet }}
        clientKey: "{{ clientKey }}"
        clientCertificate: "{{ clientCertificate }}"
        clientKeySet: {{ clientKeySet }}
        caCertificateSet: {{ caCertificateSet }}
      secretManagerStoredPassword: "{{ secretManagerStoredPassword }}"
      username: "{{ username }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. Display name.
  - name: postgresqlProfile
    description: |
      Profile for connecting to a PostgreSQL source.
    value:
      secretManagerStoredPassword: "{{ secretManagerStoredPassword }}"
      username: "{{ username }}"
      password: "{{ password }}"
      database: "{{ database }}"
      hostname: "{{ hostname }}"
      sslConfig:
        serverAndClientVerification:
          caCertificate: "{{ caCertificate }}"
          serverCertificateHostname: "{{ serverCertificateHostname }}"
          clientCertificate: "{{ clientCertificate }}"
          clientKey: "{{ clientKey }}"
        serverVerification:
          caCertificate: "{{ caCertificate }}"
          serverCertificateHostname: "{{ serverCertificateHostname }}"
      port: {{ port }}
  - name: serviceNowProfile
    description: |
      Profile for connecting to a ServiceNow source.
    value:
      instance: "{{ instance }}"
      oauthClientCredentials:
        clientId: "{{ clientId }}"
        clientSecret:
          rawValue: "{{ rawValue }}"
          secretVersion: "{{ secretVersion }}"
      userPasswordCredentials:
        password:
          rawValue: "{{ rawValue }}"
          secretVersion: "{{ secretVersion }}"
        username: "{{ username }}"
  - name: gcsProfile
    description: |
      Profile for connecting to a Cloud Storage destination.
    value:
      bucket: "{{ bucket }}"
      rootPath: "{{ rootPath }}"
  - name: labels
    value: "{{ labels }}"
    description: |
      Labels.
  - name: salesforceMarketingCloudProfile
    description: |
      Profile for connecting to a Salesforce Marketing Cloud source.
    value:
      subdomain: "{{ subdomain }}"
      oauthClientCredentials:
        clientId: "{{ clientId }}"
        clientSecret:
          rawValue: "{{ rawValue }}"
          secretVersion: "{{ secretVersion }}"
  - name: dataverseProfile
    description: |
      Profile for connecting to a Dataverse source.
    value:
      tenantId: "{{ tenantId }}"
      environmentUrl: "{{ environmentUrl }}"
      oauthClientCredentials:
        clientId: "{{ clientId }}"
        clientSecret:
          rawValue: "{{ rawValue }}"
          secretVersion: "{{ secretVersion }}"
  - name: force
    value: {{ force }}
  - name: connectionProfileId
    value: "{{ connectionProfileId }}"
  - name: requestId
    value: "{{ requestId }}"
  - name: validateOnly
    value: {{ validateOnly }}

UPDATE examples

patch

Use this method to update the parameters of a connection profile.

UPDATE google.datastream.connection_profiles
SET 
data__bigqueryProfile = '{{ bigqueryProfile }}',
data__staticServiceIpConnectivity = '{{ staticServiceIpConnectivity }}',
data__workdayProfile = '{{ workdayProfile }}',
data__privateConnectivity = '{{ privateConnectivity }}',
data__sqlServerProfile = '{{ sqlServerProfile }}',
data__mongodbProfile = '{{ mongodbProfile }}',
data__salesforceProfile = '{{ salesforceProfile }}',
data__oracleProfile = '{{ oracleProfile }}',
data__forwardSshConnectivity = '{{ forwardSshConnectivity }}',
data__spannerProfile = '{{ spannerProfile }}',
data__mysqlProfile = '{{ mysqlProfile }}',
data__displayName = '{{ displayName }}',
data__postgresqlProfile = '{{ postgresqlProfile }}',
data__serviceNowProfile = '{{ serviceNowProfile }}',
data__gcsProfile = '{{ gcsProfile }}',
data__labels = '{{ labels }}',
data__salesforceMarketingCloudProfile = '{{ salesforceMarketingCloudProfile }}',
data__dataverseProfile = '{{ dataverseProfile }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectionProfilesId = '{{ connectionProfilesId }}' --required
AND force = {{ force}}
AND validateOnly = {{ validateOnly}}
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Use this method to delete a connection profile.

DELETE FROM google.datastream.connection_profiles
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectionProfilesId = '{{ connectionProfilesId }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

discover

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.

EXEC google.datastream.connection_profiles.discover 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"postgresqlRdbms": "{{ postgresqlRdbms }}", 
"spannerDatabase": "{{ spannerDatabase }}", 
"mysqlRdbms": "{{ mysqlRdbms }}", 
"salesforceOrg": "{{ salesforceOrg }}", 
"oracleRdbms": "{{ oracleRdbms }}", 
"sourceCatalog": "{{ sourceCatalog }}", 
"sqlServerRdbms": "{{ sqlServerRdbms }}", 
"connectionProfileName": "{{ connectionProfileName }}", 
"mongodbCluster": "{{ mongodbCluster }}", 
"connectionProfile": "{{ connectionProfile }}", 
"fullHierarchy": {{ fullHierarchy }}, 
"hierarchyDepth": {{ hierarchyDepth }}
}'
;