Interface ISchedulesApiClient
Interface for API client job operations.
Inherited Members
Namespace: Tableau.Migration.Api
Assembly: Tableau.Migration.dll
Syntax
public interface ISchedulesApiClient : IContentApiClient, IReadApiClient<IServerSchedule>Methods
AddFlowTaskToScheduleAsync(Guid, Guid, IEnumerable<FlowParameterSpec>?, CancellationToken)
Adds a flow task to an existing schedule.
Declaration
Task<IResult<IScheduleFlowRunTask>> AddFlowTaskToScheduleAsync(Guid scheduleId, Guid flowId, IEnumerable<FlowParameterSpec>? flowParameterSpecs = null, CancellationToken cancel = default)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | scheduleId | The schedule's ID. The schedule must have Flow as the schedule type. |
| Guid | flowId | The ID of the flow to add to the schedule. |
| IEnumerable<FlowParameterSpec> | flowParameterSpecs | Optional flow parameter specifications. |
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult<IScheduleFlowRunTask>> | The flow run task result. |
GetAllScheduleExtractRefreshTasksAsync(Guid, CancellationToken)
Gets all the extract refresh tasks for a given schedule ID.
Declaration
Task<IResult<IImmutableList<IScheduleExtractRefreshTask>>> GetAllScheduleExtractRefreshTasksAsync(Guid scheduleId, CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | scheduleId | The schedule's ID. |
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult<IImmutableList<IScheduleExtractRefreshTask>>> | The extract refresh tasks for the given schedule ID. |
GetScheduleExtractRefreshTasksAsync(Guid, int, int, CancellationToken)
Gets the paged list of extract refresh tasks for a given schedule ID.
Declaration
Task<IPagedResult<IScheduleExtractRefreshTask>> GetScheduleExtractRefreshTasksAsync(Guid scheduleId, int pageNumber, int pageSize, CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | scheduleId | The schedule's ID. |
| int | pageNumber | The 1-indexed page number. |
| int | pageSize | The size of the page. |
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IPagedResult<IScheduleExtractRefreshTask>> | The extract refresh tasks for the given schedule ID. |