Backstage
    Preparing search index...

    TaskContext

    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: AbortSignal
    createdBy?: string
    done: boolean
    isDryRun?: boolean
    secrets?: TaskSecrets
    taskId?: string

    Methods