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 |
Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}/sfdcChannels/{sfdcChannel}. |
displayName |
Client level unique name/alias to easily reference a channel. |
description |
The description for this channel |
channelTopic |
The Channel topic defined by salesforce once an channel is opened |
isActive |
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 |
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: |
updateTime |
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: |
deleteTime |
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: |
lastReplayId |
Last sfdc message replay id for channel |
Methods |
|
---|---|
|
Creates an sfdc channel record. |
|
Deletes an sfdc channel. |
|
Gets an sfdc channel. |
|
Lists all sfdc channels that match the filter. |
|
Updates an sfdc channel. |