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

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

string

The description for this channel
channelTopic

string

The Channel topic defined by salesforce once an channel is opened
isActive

boolean

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Time when the channel was last updated

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
deleteTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lastReplayId

string

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.