Interface TaskContext

TaskContext

Deprecated

this interface is planned to be removed. Please reach out to us in an issue if you're using this interface and your use cases.

interface TaskContext {
    cancelSignal: AbortSignal;
    createdBy?: string;
    done: boolean;
    isDryRun?: boolean;
    secrets?: TaskSecrets;
    spec: TaskSpecV1beta3;
    taskId?: string;
    cleanWorkspace?(): Promise<void>;
    complete(result: TaskCompletionState, metadata?: JsonObject): Promise<void>;
    emitLog(message: string, logMetadata?: JsonObject): Promise<void>;
    getInitiatorCredentials(): Promise<BackstageCredentials>;
    getTaskState?(): Promise<{ state?: JsonObject } | undefined>;
    getWorkspaceName(): Promise<string>;
    rehydrateWorkspace?(
        options: { targetPath: string; taskId: string },
    ): Promise<void>;
    serializeWorkspace?(options: { path: string }): Promise<void>;
    updateCheckpoint?(options: UpdateTaskCheckpointOptions): Promise<void>;
}

Index

Properties

cancelSignal createdBy? done isDryRun? secrets? spec taskId?

Methods

cleanWorkspace? complete emitLog getInitiatorCredentials getTaskState? getWorkspaceName rehydrateWorkspace? serializeWorkspace? updateCheckpoint?

Properties

cancelSignal

cancelSignal: AbortSignal

`Optional`createdBy

createdBy?: string

done

done: boolean

`Optional`isDryRun

isDryRun?: boolean

`Optional`secrets

secrets?: TaskSecrets

spec

spec: TaskSpecV1beta3

`Optional`taskId

taskId?: string

Methods

`Optional`cleanWorkspace

cleanWorkspace?(): Promise<void>
Returns Promise<void>
- Defined in plugins/scaffolder-node/src/tasks/types.ts:183

complete

complete(result: TaskCompletionState, metadata?: JsonObject): Promise<void>
Parameters
- result: TaskCompletionState
- Optionalmetadata: JsonObject
Returns Promise<void>
- Defined in plugins/scaffolder-node/src/tasks/types.ts:168

emitLog

emitLog(message: string, logMetadata?: JsonObject): Promise<void>
Parameters
- message: string
- OptionallogMetadata: JsonObject
Returns Promise<void>
- Defined in plugins/scaffolder-node/src/tasks/types.ts:170

getInitiatorCredentials

getInitiatorCredentials(): Promise<BackstageCredentials>
Returns Promise<BackstageCredentials>
- Defined in plugins/scaffolder-node/src/tasks/types.ts:192

`Optional`getTaskState

getTaskState?(): Promise<{ state?: JsonObject } | undefined>
Returns Promise<{ state?: JsonObject } | undefined>
- Defined in plugins/scaffolder-node/src/tasks/types.ts:172

getWorkspaceName

getWorkspaceName(): Promise<string>
Returns Promise<string>
- Defined in plugins/scaffolder-node/src/tasks/types.ts:190

`Optional`rehydrateWorkspace

rehydrateWorkspace?(
options: { targetPath: string; taskId: string },
): Promise<void>
Parameters
- options: { targetPath: string; taskId: string }
Returns Promise<void>
- Defined in plugins/scaffolder-node/src/tasks/types.ts:185

`Optional`serializeWorkspace

serializeWorkspace?(options: { path: string }): Promise<void>
Parameters
- options: { path: string }
Returns Promise<void>
- Defined in plugins/scaffolder-node/src/tasks/types.ts:181

`Optional`updateCheckpoint

updateCheckpoint?(options: UpdateTaskCheckpointOptions): Promise<void>
Parameters
- options: UpdateTaskCheckpointOptions
Returns Promise<void>
- Defined in plugins/scaffolder-node/src/tasks/types.ts:179