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

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource's name.
bigqueryProfile	object	BigQuery Connection Profile configuration. (id: BigQueryProfile)
createTime	string (google-datetime)	Output only. The create time of the resource.
displayName	string	Required. Display name.
forwardSshConnectivity	object	Forward SSH tunnel connectivity. (id: ForwardSshTunnelConnectivity)
gcsProfile	object	Cloud Storage ConnectionProfile configuration. (id: GcsProfile)
labels	object	Labels.
mongodbProfile	object	MongoDB Connection Profile configuration. (id: MongodbProfile)
mysqlProfile	object	MySQL ConnectionProfile configuration. (id: MysqlProfile)
oracleProfile	object	Oracle ConnectionProfile configuration. (id: OracleProfile)
postgresqlProfile	object	PostgreSQL Connection Profile configuration. (id: PostgresqlProfile)
privateConnectivity	object	Private connectivity. (id: PrivateConnectivity)
salesforceProfile	object	Salesforce Connection Profile configuration. (id: SalesforceProfile)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
sqlServerProfile	object	SQLServer Connection Profile configuration. (id: SqlServerProfile)
staticServiceIpConnectivity	object	Static Service IP connectivity. (id: StaticServiceIpConnectivity)
updateTime	string (google-datetime)	Output only. The update time of the resource.

list

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The resource's name.
bigqueryProfile	object	BigQuery Connection Profile configuration. (id: BigQueryProfile)
createTime	string (google-datetime)	Output only. The create time of the resource.
displayName	string	Required. Display name.
forwardSshConnectivity	object	Forward SSH tunnel connectivity. (id: ForwardSshTunnelConnectivity)
gcsProfile	object	Cloud Storage ConnectionProfile configuration. (id: GcsProfile)
labels	object	Labels.
mongodbProfile	object	MongoDB Connection Profile configuration. (id: MongodbProfile)
mysqlProfile	object	MySQL ConnectionProfile configuration. (id: MysqlProfile)
oracleProfile	object	Oracle ConnectionProfile configuration. (id: OracleProfile)
postgresqlProfile	object	PostgreSQL Connection Profile configuration. (id: PostgresqlProfile)
privateConnectivity	object	Private connectivity. (id: PrivateConnectivity)
salesforceProfile	object	Salesforce Connection Profile configuration. (id: SalesforceProfile)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
sqlServerProfile	object	SQLServer Connection Profile configuration. (id: SqlServerProfile)
staticServiceIpConnectivity	object	Static Service IP connectivity. (id: StaticServiceIpConnectivity)
updateTime	string (google-datetime)	Output only. The update time of the resource.

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	pageSize, pageToken, filter, orderBy	Use this method to list connection profiles created in a project and location.
create	insert	projectsId, locationsId	connectionProfileId, requestId, validateOnly, force	Use this method to create a connection profile in a project and location.
patch	update	projectsId, locationsId, connectionProfilesId	updateMask, requestId, validateOnly, force	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,
displayName,
forwardSshConnectivity,
gcsProfile,
labels,
mongodbProfile,
mysqlProfile,
oracleProfile,
postgresqlProfile,
privateConnectivity,
salesforceProfile,
satisfiesPzi,
satisfiesPzs,
sqlServerProfile,
staticServiceIpConnectivity,
updateTime
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,
displayName,
forwardSshConnectivity,
gcsProfile,
labels,
mongodbProfile,
mysqlProfile,
oracleProfile,
postgresqlProfile,
privateConnectivity,
salesforceProfile,
satisfiesPzi,
satisfiesPzs,
sqlServerProfile,
staticServiceIpConnectivity,
updateTime
FROM google.datastream.connection_profiles
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
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__labels,
data__displayName,
data__oracleProfile,
data__gcsProfile,
data__mysqlProfile,
data__bigqueryProfile,
data__postgresqlProfile,
data__sqlServerProfile,
data__salesforceProfile,
data__mongodbProfile,
data__staticServiceIpConnectivity,
data__forwardSshConnectivity,
data__privateConnectivity,
projectsId,
locationsId,
connectionProfileId,
requestId,
validateOnly,
force
)
SELECT 
'{{ labels }}',
'{{ displayName }}',
'{{ oracleProfile }}',
'{{ gcsProfile }}',
'{{ mysqlProfile }}',
'{{ bigqueryProfile }}',
'{{ postgresqlProfile }}',
'{{ sqlServerProfile }}',
'{{ salesforceProfile }}',
'{{ mongodbProfile }}',
'{{ staticServiceIpConnectivity }}',
'{{ forwardSshConnectivity }}',
'{{ privateConnectivity }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ connectionProfileId }}',
'{{ requestId }}',
'{{ validateOnly }}',
'{{ force }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: connection_profiles
  props:
    - name: projectsId
      value: string
      description: Required parameter for the connection_profiles resource.
    - name: locationsId
      value: string
      description: Required parameter for the connection_profiles resource.
    - name: labels
      value: object
      description: >
        Labels.
        
    - name: displayName
      value: string
      description: >
        Required. Display name.
        
    - name: oracleProfile
      value: object
      description: >
        Oracle ConnectionProfile configuration.
        
    - name: gcsProfile
      value: object
      description: >
        Cloud Storage ConnectionProfile configuration.
        
    - name: mysqlProfile
      value: object
      description: >
        MySQL ConnectionProfile configuration.
        
    - name: bigqueryProfile
      value: object
      description: >
        BigQuery Connection Profile configuration.
        
    - name: postgresqlProfile
      value: object
      description: >
        PostgreSQL Connection Profile configuration.
        
    - name: sqlServerProfile
      value: object
      description: >
        SQLServer Connection Profile configuration.
        
    - name: salesforceProfile
      value: object
      description: >
        Salesforce Connection Profile configuration.
        
    - name: mongodbProfile
      value: object
      description: >
        MongoDB Connection Profile configuration.
        
    - name: staticServiceIpConnectivity
      value: object
      description: >
        Static Service IP connectivity.
        
    - name: forwardSshConnectivity
      value: object
      description: >
        Forward SSH tunnel connectivity.
        
    - name: privateConnectivity
      value: object
      description: >
        Private connectivity.
        
    - name: connectionProfileId
      value: string
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean
    - name: force
      value: boolean

UPDATE examples

patch

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

UPDATE google.datastream.connection_profiles
SET 
data__labels = '{{ labels }}',
data__displayName = '{{ displayName }}',
data__oracleProfile = '{{ oracleProfile }}',
data__gcsProfile = '{{ gcsProfile }}',
data__mysqlProfile = '{{ mysqlProfile }}',
data__bigqueryProfile = '{{ bigqueryProfile }}',
data__postgresqlProfile = '{{ postgresqlProfile }}',
data__sqlServerProfile = '{{ sqlServerProfile }}',
data__salesforceProfile = '{{ salesforceProfile }}',
data__mongodbProfile = '{{ mongodbProfile }}',
data__staticServiceIpConnectivity = '{{ staticServiceIpConnectivity }}',
data__forwardSshConnectivity = '{{ forwardSshConnectivity }}',
data__privateConnectivity = '{{ privateConnectivity }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND connectionProfilesId = '{{ connectionProfilesId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
AND validateOnly = {{ validateOnly}}
AND force = {{ force}}
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=
'{
"connectionProfile": "{{ connectionProfile }}", 
"connectionProfileName": "{{ connectionProfileName }}", 
"fullHierarchy": {{ fullHierarchy }}, 
"hierarchyDepth": {{ hierarchyDepth }}, 
"oracleRdbms": "{{ oracleRdbms }}", 
"mysqlRdbms": "{{ mysqlRdbms }}", 
"postgresqlRdbms": "{{ postgresqlRdbms }}", 
"sqlServerRdbms": "{{ sqlServerRdbms }}", 
"salesforceOrg": "{{ salesforceOrg }}", 
"mongodbCluster": "{{ mongodbCluster }}"
}';