Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateChannelDetails

Details required to update a Channel

Properties

Optional definedTags

definedTags: undefined | object

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

User provided description of the Channel.

Optional displayName

displayName: undefined | string

The user-friendly name for the Channel. It does not have to be unique.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Optional isEnabled

isEnabled: undefined | false | true

Whether the Channel should be enabled or disabled. Enabling a previously disabled Channel will cause the Channel to be started. Conversely, disabling a previously enabled Channel will stop the Channel. Both operations are executed asynchronously.

Optional source

source: model.UpdateChannelSourceFromMysqlDetails

Optional target

target: model.UpdateChannelTargetFromDbSystemDetails

Functions

getDeserializedJsonObj

getJsonObj