Job.SuspendJobAsync

Description

Suspends the job with specified SuspendedJobInfo details from the connected AI Command Center.

Signature [C#]

Task SuspendJobAsync(SuspendedJobInfo suspendedJobInfo, string persistenceFilePath);

Properties

Input

Parameter	Type	Required / default	Description
suspendedJobInfo	SuspendedJobInfo	Required	Specify the information to suspend the job.
persistenceFilePath	string	Required	Specify the persistence file path.

Remarks

Use SuspendJobAsync API to suspend the job with specified SuspendedJobInfo from the connected AI Command Center.

Example

The caller supplies the job suspension details and persistence file required by the SDK.

public async Task SuspendJobAsync(IControlRoomContext context, SuspendedJobInfo suspendedJobInfo, string persistenceFilePath)
{
    await context.Jobs.SuspendJobAsync(suspendedJobInfo, persistenceFilePath);
}

Use the persistence file produced by the relevant workflow; do not substitute an arbitrary empty file. See SDK usage for failure handling.