Interface ICloudTasksApiClient

Interface for API client Cloud tasks operations.

Inherited Members

IContentApiClient.UrlPrefix

IPublishApiClient<ICloudExtractRefreshTask, ICloudExtractRefreshTask>.PublishAsync(ICloudExtractRefreshTask, CancellationToken)

Namespace: Tableau.Migration.Api

Assembly: Tableau.Migration.dll

Syntax

public interface ICloudTasksApiClient : IContentApiClient, IPublishApiClient<ICloudExtractRefreshTask>, IPublishApiClient<ICloudExtractRefreshTask, ICloudExtractRefreshTask>

Methods

CreateExtractRefreshTaskAsync(ICreateExtractRefreshTaskOptions, CancellationToken)

Create an extract refresh task.

Declaration

Task<IResult<ICloudExtractRefreshTask>> CreateExtractRefreshTaskAsync(ICreateExtractRefreshTaskOptions options, CancellationToken cancel)

Parameters

Type	Name	Description
ICreateExtractRefreshTaskOptions	options	The new extract refresh task's details.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<ICloudExtractRefreshTask>>	The published extract refresh task.

DeleteExtractRefreshTaskAsync(Guid, CancellationToken)

Deletes an extract refresh task.

Declaration

Task<IResult> DeleteExtractRefreshTaskAsync(Guid extractRefreshTaskId, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	extractRefreshTaskId	The extract refresh task's ID.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult>

GetAllExtractRefreshTasksAsync(CancellationToken)

Gets a list of extract refresh tasks.

Declaration

Task<IResult<IImmutableList<ICloudExtractRefreshTask>>> GetAllExtractRefreshTasksAsync(CancellationToken cancel)

Parameters

Type	Name	Description
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<IImmutableList<ICloudExtractRefreshTask>>>