sfdc_channels

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

Overview

Name	sfdc_channels
Type	Resource
Id	google.integrations.sfdc_channels

Fields

The following fields are returned by SELECT queries:

projects_locations_products_sfdc_instances_sfdc_channels_get

Successful response

Name	Datatype	Description
name	string	Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
channelTopic	string	Required. The Channel topic defined by salesforce once an channel is opened
createTime	string (google-datetime)	Output only. Time when the channel is created
deleteTime	string (google-datetime)	Output only. Time when the channel was deleted. Empty if not deleted.
description	string	Optional. The description for this channel
displayName	string	Optional. Client level unique name/alias to easily reference a channel.
isActive	boolean	Output only. Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
lastReplayId	string	Output only. Last sfdc messsage replay id for channel
updateTime	string (google-datetime)	Output only. Time when the channel was last updated

projects_locations_products_sfdc_instances_sfdc_channels_list

Successful response

Name	Datatype	Description
name	string	Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
channelTopic	string	Required. The Channel topic defined by salesforce once an channel is opened
createTime	string (google-datetime)	Output only. Time when the channel is created
deleteTime	string (google-datetime)	Output only. Time when the channel was deleted. Empty if not deleted.
description	string	Optional. The description for this channel
displayName	string	Optional. Client level unique name/alias to easily reference a channel.
isActive	boolean	Output only. Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
lastReplayId	string	Output only. Last sfdc messsage replay id for channel
updateTime	string (google-datetime)	Output only. Time when the channel was last updated

projects_locations_sfdc_instances_sfdc_channels_get

Successful response

Name	Datatype	Description
name	string	Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
channelTopic	string	Required. The Channel topic defined by salesforce once an channel is opened
createTime	string (google-datetime)	Output only. Time when the channel is created
deleteTime	string (google-datetime)	Output only. Time when the channel was deleted. Empty if not deleted.
description	string	Optional. The description for this channel
displayName	string	Optional. Client level unique name/alias to easily reference a channel.
isActive	boolean	Output only. Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
lastReplayId	string	Output only. Last sfdc messsage replay id for channel
updateTime	string (google-datetime)	Output only. Time when the channel was last updated

projects_locations_sfdc_instances_sfdc_channels_list

Successful response

Name	Datatype	Description
name	string	Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
channelTopic	string	Required. The Channel topic defined by salesforce once an channel is opened
createTime	string (google-datetime)	Output only. Time when the channel is created
deleteTime	string (google-datetime)	Output only. Time when the channel was deleted. Empty if not deleted.
description	string	Optional. The description for this channel
displayName	string	Optional. Client level unique name/alias to easily reference a channel.
isActive	boolean	Output only. Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
lastReplayId	string	Output only. Last sfdc messsage replay id for channel
updateTime	string (google-datetime)	Output only. Time when the channel 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_sfdc_channels_get	select	projectsId, locationsId, productsId, sfdcInstancesId, sfdcChannelsId		Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
projects_locations_products_sfdc_instances_sfdc_channels_list	select	projectsId, locationsId, productsId, sfdcInstancesId	pageSize, pageToken, filter, readMask	Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
projects_locations_sfdc_instances_sfdc_channels_get	select	projectsId, locationsId, sfdcInstancesId, sfdcChannelsId		Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
projects_locations_sfdc_instances_sfdc_channels_list	select	projectsId, locationsId, sfdcInstancesId	pageSize, pageToken, filter, readMask	Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
projects_locations_products_sfdc_instances_sfdc_channels_create	insert	projectsId, locationsId, productsId, sfdcInstancesId		Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
projects_locations_sfdc_instances_sfdc_channels_create	insert	projectsId, locationsId, sfdcInstancesId		Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
projects_locations_products_sfdc_instances_sfdc_channels_patch	update	projectsId, locationsId, productsId, sfdcInstancesId, sfdcChannelsId	updateMask	Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
projects_locations_sfdc_instances_sfdc_channels_patch	update	projectsId, locationsId, sfdcInstancesId, sfdcChannelsId	updateMask	Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
projects_locations_products_sfdc_instances_sfdc_channels_delete	delete	projectsId, locationsId, productsId, sfdcInstancesId, sfdcChannelsId		Deletes an sfdc channel.
projects_locations_sfdc_instances_sfdc_channels_delete	delete	projectsId, locationsId, sfdcInstancesId, sfdcChannelsId		Deletes an sfdc channel.

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
sfdcChannelsId	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_sfdc_channels_get

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

SELECT
name,
channelTopic,
createTime,
deleteTime,
description,
displayName,
isActive,
lastReplayId,
updateTime
FROM google.integrations.sfdc_channels
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND productsId = '{{ productsId }}' -- required
AND sfdcInstancesId = '{{ sfdcInstancesId }}' -- required
AND sfdcChannelsId = '{{ sfdcChannelsId }}' -- required;

projects_locations_products_sfdc_instances_sfdc_channels_list

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

SELECT
name,
channelTopic,
createTime,
deleteTime,
description,
displayName,
isActive,
lastReplayId,
updateTime
FROM google.integrations.sfdc_channels
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND productsId = '{{ productsId }}' -- required
AND sfdcInstancesId = '{{ sfdcInstancesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND readMask = '{{ readMask }}';

projects_locations_sfdc_instances_sfdc_channels_get

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

SELECT
name,
channelTopic,
createTime,
deleteTime,
description,
displayName,
isActive,
lastReplayId,
updateTime
FROM google.integrations.sfdc_channels
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sfdcInstancesId = '{{ sfdcInstancesId }}' -- required
AND sfdcChannelsId = '{{ sfdcChannelsId }}' -- required;

projects_locations_sfdc_instances_sfdc_channels_list

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

SELECT
name,
channelTopic,
createTime,
deleteTime,
description,
displayName,
isActive,
lastReplayId,
updateTime
FROM google.integrations.sfdc_channels
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND sfdcInstancesId = '{{ sfdcInstancesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND readMask = '{{ readMask }}';

INSERT examples

projects_locations_products_sfdc_instances_sfdc_channels_create

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

INSERT INTO google.integrations.sfdc_channels (
data__name,
data__displayName,
data__description,
data__channelTopic,
projectsId,
locationsId,
productsId,
sfdcInstancesId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ channelTopic }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ productsId }}',
'{{ sfdcInstancesId }}'
RETURNING
name,
channelTopic,
createTime,
deleteTime,
description,
displayName,
isActive,
lastReplayId,
updateTime
;

projects_locations_sfdc_instances_sfdc_channels_create

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

INSERT INTO google.integrations.sfdc_channels (
data__name,
data__displayName,
data__description,
data__channelTopic,
projectsId,
locationsId,
sfdcInstancesId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ channelTopic }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ sfdcInstancesId }}'
RETURNING
name,
channelTopic,
createTime,
deleteTime,
description,
displayName,
isActive,
lastReplayId,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: sfdc_channels
  props:
    - name: projectsId
      value: string
      description: Required parameter for the sfdc_channels resource.
    - name: locationsId
      value: string
      description: Required parameter for the sfdc_channels resource.
    - name: productsId
      value: string
      description: Required parameter for the sfdc_channels resource.
    - name: sfdcInstancesId
      value: string
      description: Required parameter for the sfdc_channels resource.
    - name: name
      value: string
      description: >
        Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
        
    - name: displayName
      value: string
      description: >
        Optional. Client level unique name/alias to easily reference a channel.
        
    - name: description
      value: string
      description: >
        Optional. The description for this channel
        
    - name: channelTopic
      value: string
      description: >
        Required. The Channel topic defined by salesforce once an channel is opened
        

UPDATE examples

projects_locations_products_sfdc_instances_sfdc_channels_patch

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

UPDATE google.integrations.sfdc_channels
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__channelTopic = '{{ channelTopic }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND productsId = '{{ productsId }}' --required
AND sfdcInstancesId = '{{ sfdcInstancesId }}' --required
AND sfdcChannelsId = '{{ sfdcChannelsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
channelTopic,
createTime,
deleteTime,
description,
displayName,
isActive,
lastReplayId,
updateTime;

projects_locations_sfdc_instances_sfdc_channels_patch

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

UPDATE google.integrations.sfdc_channels
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__channelTopic = '{{ channelTopic }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND sfdcInstancesId = '{{ sfdcInstancesId }}' --required
AND sfdcChannelsId = '{{ sfdcChannelsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
channelTopic,
createTime,
deleteTime,
description,
displayName,
isActive,
lastReplayId,
updateTime;

DELETE examples

projects_locations_products_sfdc_instances_sfdc_channels_delete

Deletes an sfdc channel.

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

projects_locations_sfdc_instances_sfdc_channels_delete

Deletes an sfdc channel.

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