sfdc_instances

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

Overview

Name	sfdc_instances
Type	Resource
Id	google.integrations.sfdc_instances

Fields

The following fields are returned by SELECT queries:

projects_locations_products_sfdc_instances_get

Successful response

Name	Datatype	Description
name	string	Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
authConfigId	array	A list of AuthConfigs that can be tried to open the channel to SFDC
createTime	string (google-datetime)	Output only. Time when the instance is created
deleteTime	string (google-datetime)	Output only. Time when the instance was deleted. Empty if not deleted.
description	string	Optional. A description of the sfdc instance.
displayName	string	Optional. User selected unique name/alias to easily reference an instance.
serviceAuthority	string	Optional. URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
sfdcOrgId	string	The SFDC Org Id. This is defined in salesforce.
updateTime	string (google-datetime)	Output only. Time when the instance was last updated

projects_locations_products_sfdc_instances_list

Successful response

Name	Datatype	Description
name	string	Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
authConfigId	array	A list of AuthConfigs that can be tried to open the channel to SFDC
createTime	string (google-datetime)	Output only. Time when the instance is created
deleteTime	string (google-datetime)	Output only. Time when the instance was deleted. Empty if not deleted.
description	string	Optional. A description of the sfdc instance.
displayName	string	Optional. User selected unique name/alias to easily reference an instance.
serviceAuthority	string	Optional. URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
sfdcOrgId	string	The SFDC Org Id. This is defined in salesforce.
updateTime	string (google-datetime)	Output only. Time when the instance was last updated

projects_locations_sfdc_instances_get

Successful response

Name	Datatype	Description
name	string	Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
authConfigId	array	A list of AuthConfigs that can be tried to open the channel to SFDC
createTime	string (google-datetime)	Output only. Time when the instance is created
deleteTime	string (google-datetime)	Output only. Time when the instance was deleted. Empty if not deleted.
description	string	Optional. A description of the sfdc instance.
displayName	string	Optional. User selected unique name/alias to easily reference an instance.
serviceAuthority	string	Optional. URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
sfdcOrgId	string	The SFDC Org Id. This is defined in salesforce.
updateTime	string (google-datetime)	Output only. Time when the instance was last updated

projects_locations_sfdc_instances_list

Successful response

Name	Datatype	Description
name	string	Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
authConfigId	array	A list of AuthConfigs that can be tried to open the channel to SFDC
createTime	string (google-datetime)	Output only. Time when the instance is created
deleteTime	string (google-datetime)	Output only. Time when the instance was deleted. Empty if not deleted.
description	string	Optional. A description of the sfdc instance.
displayName	string	Optional. User selected unique name/alias to easily reference an instance.
serviceAuthority	string	Optional. URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
sfdcOrgId	string	The SFDC Org Id. This is defined in salesforce.
updateTime	string (google-datetime)	Output only. Time when the instance was last updated

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_products_sfdc_instances_get	select	projectsId, locationsId, productsId, sfdcInstancesId		Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
projects_locations_products_sfdc_instances_list	select	projectsId, locationsId, productsId	pageSize, pageToken, filter, readMask	Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
projects_locations_sfdc_instances_get	select	projectsId, locationsId, sfdcInstancesId		Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
projects_locations_sfdc_instances_list	select	projectsId, locationsId	pageSize, pageToken, filter, readMask	Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
projects_locations_products_sfdc_instances_create	insert	projectsId, locationsId, productsId		Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
projects_locations_sfdc_instances_create	insert	projectsId, locationsId		Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
projects_locations_products_sfdc_instances_patch	update	projectsId, locationsId, productsId, sfdcInstancesId	updateMask	Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
projects_locations_sfdc_instances_patch	update	projectsId, locationsId, sfdcInstancesId	updateMask	Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
projects_locations_products_sfdc_instances_delete	delete	projectsId, locationsId, productsId, sfdcInstancesId		Deletes an sfdc instance.
projects_locations_sfdc_instances_delete	delete	projectsId, locationsId, sfdcInstancesId		Deletes an sfdc instance.

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
productsId	string
projectsId	string
sfdcInstancesId	string
filter	string
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_products_sfdc_instances_get

Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.

SELECT
name,
authConfigId,
createTime,
deleteTime,
description,
displayName,
serviceAuthority,
sfdcOrgId,
updateTime
FROM google.integrations.sfdc_instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND productsId = '{{ productsId }}' -- required
AND sfdcInstancesId = '{{ sfdcInstancesId }}' -- required;

projects_locations_products_sfdc_instances_list

Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.

SELECT
name,
authConfigId,
createTime,
deleteTime,
description,
displayName,
serviceAuthority,
sfdcOrgId,
updateTime
FROM google.integrations.sfdc_instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND productsId = '{{ productsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND readMask = '{{ readMask }}';

projects_locations_sfdc_instances_get

Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.

SELECT
name,
authConfigId,
createTime,
deleteTime,
description,
displayName,
serviceAuthority,
sfdcOrgId,
updateTime
FROM google.integrations.sfdc_instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sfdcInstancesId = '{{ sfdcInstancesId }}' -- required;

projects_locations_sfdc_instances_list

Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.

SELECT
name,
authConfigId,
createTime,
deleteTime,
description,
displayName,
serviceAuthority,
sfdcOrgId,
updateTime
FROM google.integrations.sfdc_instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND readMask = '{{ readMask }}';

INSERT examples

projects_locations_products_sfdc_instances_create

Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.

INSERT INTO google.integrations.sfdc_instances (
data__name,
data__displayName,
data__description,
data__sfdcOrgId,
data__authConfigId,
data__serviceAuthority,
projectsId,
locationsId,
productsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ sfdcOrgId }}',
'{{ authConfigId }}',
'{{ serviceAuthority }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ productsId }}'
RETURNING
name,
authConfigId,
createTime,
deleteTime,
description,
displayName,
serviceAuthority,
sfdcOrgId,
updateTime
;

projects_locations_sfdc_instances_create

Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.

INSERT INTO google.integrations.sfdc_instances (
data__name,
data__displayName,
data__description,
data__sfdcOrgId,
data__authConfigId,
data__serviceAuthority,
projectsId,
locationsId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ sfdcOrgId }}',
'{{ authConfigId }}',
'{{ serviceAuthority }}',
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
authConfigId,
createTime,
deleteTime,
description,
displayName,
serviceAuthority,
sfdcOrgId,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: sfdc_instances
  props:
    - name: projectsId
      value: string
      description: Required parameter for the sfdc_instances resource.
    - name: locationsId
      value: string
      description: Required parameter for the sfdc_instances resource.
    - name: productsId
      value: string
      description: Required parameter for the sfdc_instances resource.
    - name: name
      value: string
      description: >
        Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
        
    - name: displayName
      value: string
      description: >
        Optional. User selected unique name/alias to easily reference an instance.
        
    - name: description
      value: string
      description: >
        Optional. A description of the sfdc instance.
        
    - name: sfdcOrgId
      value: string
      description: >
        The SFDC Org Id. This is defined in salesforce.
        
    - name: authConfigId
      value: array
      description: >
        A list of AuthConfigs that can be tried to open the channel to SFDC
        
    - name: serviceAuthority
      value: string
      description: >
        Optional. URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
        

UPDATE examples

projects_locations_products_sfdc_instances_patch

Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.

UPDATE google.integrations.sfdc_instances
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__sfdcOrgId = '{{ sfdcOrgId }}',
data__authConfigId = '{{ authConfigId }}',
data__serviceAuthority = '{{ serviceAuthority }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND productsId = '{{ productsId }}' --required
AND sfdcInstancesId = '{{ sfdcInstancesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
authConfigId,
createTime,
deleteTime,
description,
displayName,
serviceAuthority,
sfdcOrgId,
updateTime;

projects_locations_sfdc_instances_patch

Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.

UPDATE google.integrations.sfdc_instances
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__sfdcOrgId = '{{ sfdcOrgId }}',
data__authConfigId = '{{ authConfigId }}',
data__serviceAuthority = '{{ serviceAuthority }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND sfdcInstancesId = '{{ sfdcInstancesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
authConfigId,
createTime,
deleteTime,
description,
displayName,
serviceAuthority,
sfdcOrgId,
updateTime;

DELETE examples

projects_locations_products_sfdc_instances_delete

Deletes an sfdc instance.

DELETE FROM google.integrations.sfdc_instances
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND productsId = '{{ productsId }}' --required
AND sfdcInstancesId = '{{ sfdcInstancesId }}' --required;

projects_locations_sfdc_instances_delete

Deletes an sfdc instance.

DELETE FROM google.integrations.sfdc_instances
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND sfdcInstancesId = '{{ sfdcInstancesId }}' --required;