Interface IFlowsApiClient

Interface for API client prep flow operations.

Inherited Members

IApiPageAccessor<IFlow>.GetPageAsync(int, int, CancellationToken)

IPagedListApiClient<IFlow>.GetPager(int)

IPagedListApiClient<IFlow>.GetAllAsync(int, CancellationToken)

IContentApiClient.UrlPrefix

IPullApiClient<IFlow, IPublishableFlow>.PullAsync(IFlow, CancellationToken)

IPublishApiClient<IPublishableFlow, IFlow>.PublishAsync(IPublishableFlow, CancellationToken)

Namespace: Tableau.Migration.Api

Assembly: Tableau.Migration.dll

Syntax

public interface IFlowsApiClient : IApiPageAccessor<IFlow>, IPagedListApiClient<IFlow>, IContentApiClient, IPullApiClient<IFlow, IPublishableFlow>, IPublishApiClient<IPublishableFlow, IFlow>

Methods

DownloadFlowAsync(Guid, CancellationToken)

Downloads the prep flow file for the given ID.

Declaration

Task<IAsyncDisposableResult<FileDownload>> DownloadFlowAsync(Guid flowId, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	flowId	The ID to download the flow file for.
CancellationToken	cancel	A cancellation token to obey.

Returns

Type	Description
Task<IAsyncDisposableResult<FileDownload>>	The file download result.

GetAllFlowsAsync(int, int, CancellationToken)

Gets all prep flows in the current site.

Declaration

Task<IPagedResult<IFlow>> GetAllFlowsAsync(int pageNumber, int pageSize, CancellationToken cancel)

Parameters

Type	Name	Description
int	pageNumber	The 1-indexed page number.
int	pageSize	The size of the page.
CancellationToken	cancel	A cancellation token to obey.

Returns

Type	Description
Task<IPagedResult<IFlow>>	A list of a page of prep flows in the current site.

PublishFlowAsync(IPublishFlowOptions, CancellationToken)

Uploads the input prep flow file.

Declaration

Task<IResult<IFlow>> PublishFlowAsync(IPublishFlowOptions options, CancellationToken cancel)

Parameters

Type	Name	Description
IPublishFlowOptions	options	The new prep flows's details.
CancellationToken	cancel	A cancellation token to obey.

Returns

Type	Description
Task<IResult<IFlow>>	The published prep flow.