REST Resource: projects.locations.sfdcInstances.sfdcChannels

Resource: SfdcChannel

The SfdcChannel that points to a CDC or Platform Event Channel.

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "channelTopic": string,
  "isActive": boolean,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "lastReplayId": string
}
Fields
name

string

Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}/sfdcChannels/{sfdcChannel}.

displayName

string

Optional. Client level unique name/alias to easily reference a channel.

description

string

Optional. The description for this channel

channelTopic

string

Required. The Channel topic defined by salesforce once a channel is opened

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.

createTime

string (Timestamp format)

Output only. Time when the channel is created

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. Time when the channel was last updated

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

deleteTime

string (Timestamp format)

Output only. Time when the channel was deleted. Empty if not deleted.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

lastReplayId

string

Output only. Last sfdc message replay id for channel

Methods

create

Creates an sfdc channel record.

delete

Deletes an sfdc channel.

get

Gets an sfdc channel.

list

Lists all sfdc channels that match the filter.

patch

Updates an sfdc channel.