Interface TopicUpdate

Parameters

• path: string

• patch: string | Array<object>

• Optional constraint: UpdateConstraint

Returns Result<JsonPatchResult>

a Result that resolves when a response is received from the server.

If the task fails, the Result will reject with an error. Common reasons for failure include:

• the patch is not a valid JSON Patch;
• applying the patch fails;
• there is no topic bound to path;
• the patch cannot be applied to the topic, for example if the topic type is not DataTypes.json.
• updates cannot be applied to the topic because an exclusive update source is registered for its path;
• the topic is managed by a component (such as fan-out) that prohibits updates from the caller;
• the cluster was repartitioning;
• the calling session does not have the UPDATE_TOPIC permission for path;
• the session is closed.

Parameters

• path: string

• dataType: DataType<any, any, any>

• Optional options: TopicUpdateOptions

Returns UpdateStream

an update stream

Returns UpdateStreamBuilder

an update stream builder

Parameters

• path: string

• dataType: DataType<any, any, any>

• value: any

• Optional options: TopicUpdateOptions

Returns Result<void | TopicCreationResult>

a Result that resolves when a response is received from the server. If a topic specification is provided in the options, the Result will resolve with a TopicCreationResult that contains the specification of the topic that was created.

If the task fails, the Result will resolve with an Error.