Hierarchy

Index

Constructors

constructor

Properties

assetName

assetName: string

Unique identifier name of the <a href="https://docs.kelvininc.com/latest/kelvin-overview/kelvin-platform/kelvin-assets/\" target="_blank">Kelvin Asset.

created

created: Date

Time of creation of this Kelvin Control Change in ISO 8601 UTC date/time format. Example; "2022-08-22T08:41:01.657916Z".

createdBy

createdBy: string

Who created the Kelvin Control Change.

For a user this will normally be a user name or user email address and for a workload it will be the workload's unique name.

createdType

createdType: string

Type of process that created the Kelvin Control Change.

There are two types; user which is a normal user registered on the Kelvin Platform or workload which is an automated process like a Kelvin Rule or from a program in a Kelvin App.

id

id: string

Unique identifier id for the Kelvin Control Change.

lastMessage

lastMessage: string

Last message received from the Kelvin Control Change Manager.

For example some messages received could be The system considers the Managed Control Change to be successfully applied. or The Control Change was sent to the Bridge. At this stage, the system is monitoring according to the Acceptance Criteria parameters and the retry logic..

lastState

lastState: string

Current state of the last Kelvin Control Change.

Available states are; pending, sent, applied and failed. check out Kelvin Control Change Statuses in the Kelvin Documentation for more details about each status.

metricName

metricName: string

Unique identifier name of the Kelvin Metric.

oldPayload

oldPayload: any

The original value payload before the change was applied

payload

payload: any

The new value payload to be applied.

statusLog

Array of dictionary objects with the details of each status change including the timestamp, state, message and payload value.

timestamp

timestamp: Date

Time when created_by sent the Kelvin Control Change request to the Kelvin Platform. The date-time is in ISO 8601 UTC date/time format. Example; "2022-08-22T08:41:01.657916Z".

updated

updated: Date

Time of last state change of this Kelvin Control Change in ISO 8601 UTC date/time format. Example; "2022-08-22T08:41:01.657916Z".

Methods

clone

getClass

  • getClass(): Function

mapping

  • mapping(): {}

serializeArray

  • serializeArray(obj: any[]): Object

serializeObject

  • serializeObject(obj: any): any

serializeObjectInstance

  • serializeObjectInstance(obj: Object): Object

stringify

  • stringify(): string

toJSONObject

  • toJSONObject(): Object