Interface IJobsApiClient

Interface for API client job operations.

Inherited Members

IContentApiClient.UrlPrefix

Namespace: Tableau.Migration.Api

Assembly: Tableau.Migration.dll

Syntax

public interface IJobsApiClient : IContentApiClient

Methods

GetJobStatusAsync(Guid, CancellationToken)

Gets the status for a given job ID.

Declaration

Task<IResult<IJob>> GetJobStatusAsync(Guid jobId, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	jobId	The job's ID.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<IJob>>	The status for the given job ID.

WaitForJobAsync(Guid, CancellationToken)

Waits for the job with the given ID to complete.

Declaration

Task<IResult> WaitForJobAsync(Guid jobId, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	jobId	The job's ID.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult>	The status for the given job ID.