Type Alias Reload

type Reload = {
    appId: string;
    creationTime: string;
    endTime?: string;
    engineTime?: string;
    errorCode?: string;
    errorMessage?: string;
    id: string;
    links?: ReloadLinks;
    log?: string;
    partial?: Partial;
    startTime?: string;
    status: Status;
    tenantId: string;
    type: Type;
    userId: string;
    weight?: Weight;
}
Index

Properties

appId creationTime endTime? engineTime? errorCode? errorMessage? id links? log? partial? startTime? status tenantId type userId weight?

Properties

appId: string

The ID of the app.

creationTime: string

The time the reload job was created.

endTime?: string

The time the reload job finished.

engineTime?: string

The timestamp returned from the Sense engine upon successful reload.

errorCode?: string

The error code when the status is FAILED.

errorMessage?: string

The error message when the status is FAILED.

id: string

The ID of the reload.

links?: ReloadLinks
log?: string

The log describing the result of the latest reload execution from the request.

partial?: Partial

The boolean value used to present the reload is partial or not.

startTime?: string

The time the reload job was consumed from the queue.

status: Status

The status of the reload. There are seven statuses. QUEUED, RELOADING, CANCELING are the active statuses. SUCCEEDED, FAILED, CANCELED, EXCEEDED_LIMIT are the end statuses.

tenantId: string

The ID of the tenant who owns the reload.

type: Type

What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data, choreographer = reload triggered by choreographer.

userId: string

The ID of the user who created the reload.

weight?: Weight

The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1.

Settings

Member Visibility

On This Page

Properties