Interface IMigrationEndpoint
Interface for an object that represents a location to move Tableau data to or from.
Inherited Members
Namespace: Tableau.Migration.Engine.Endpoints
Assembly: Tableau.Migration.dll
Syntax
public interface IMigrationEndpoint : IAsyncDisposableMethods
GetContentClient<TContentClient, TContent>()
Gets a content client for the given content type.
Declaration
TContentClient GetContentClient<TContentClient, TContent>() where TContentClient : IContentClient<TContent>Returns
| Type | Description |
|---|---|
| TContentClient | The content client. |
Type Parameters
| Name | Description |
|---|---|
| TContentClient | The content client type. |
| TContent | The content type. |
GetCurrentSiteAsync(CancellationToken)
Gets the current site information.
Declaration
Task<IResult<ISite>> GetCurrentSiteAsync(CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult<ISite>> | An awaitable task with the site result. |
GetEndpointCache<TCache, TKey, TValue>()
Gets an migration cache that belongs to the endpoint scope.
Declaration
TCache GetEndpointCache<TCache, TKey, TValue>() where TCache : IMigrationCache<TKey, TValue> where TKey : notnull where TValue : classReturns
| Type | Description |
|---|---|
| TCache | The cache. |
Type Parameters
| Name | Description |
|---|---|
| TCache | The cache type. |
| TKey | The cache key type. |
| TValue | The cache value type. |
GetFavoritesContentClient()
Gets a favorites content client.
Declaration
IFavoritesContentClient GetFavoritesContentClient()Returns
| Type | Description |
|---|---|
| IFavoritesContentClient | The content client. |
GetPager<TContent>(int)
Gets a pager to list all the content the user has access to.
Declaration
IPager<TContent> GetPager<TContent>(int pageSize)Parameters
| Type | Name | Description |
|---|---|---|
| int | pageSize | The page size to use. |
Returns
| Type | Description |
|---|---|
| IPager<TContent> | A pager to list content with. |
Type Parameters
| Name | Description |
|---|---|
| TContent | The content type. |
GetSessionAsync(CancellationToken)
Gets the current server session information.
Declaration
Task<IResult<IServerSession>> GetSessionAsync(CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult<IServerSession>> | An awaitable task with the server session result. |
GetViewCache()
Gets the cache of views in the endpoint scope.
Declaration
IEndpointViewCache GetViewCache()Returns
| Type | Description |
|---|---|
| IEndpointViewCache | The view cache. |
GetViewsContentClient()
Gets a views content client.
Declaration
IViewsContentClient GetViewsContentClient()Returns
| Type | Description |
|---|---|
| IViewsContentClient | The content client. |
GetWorkbookContentClient()
Gets a workbook content client.
Declaration
IWorkbooksContentClient GetWorkbookContentClient()Returns
| Type | Description |
|---|---|
| IWorkbooksContentClient | The content client. |
GetWorkbookViewsCache()
Gets the cache of views by workbook in the endpoint scope.
Declaration
IEndpointWorkbookViewsCache GetWorkbookViewsCache()Returns
| Type | Description |
|---|---|
| IEndpointWorkbookViewsCache | The workbook views cache. |
InitializeAsync(CancellationToken)
Performs pre-migration initialization.
Declaration
Task<IResult> InitializeAsync(CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult> | An awaitable task with the initialization result. |