Interface ISourceEndpoint

IMigrationEndpoint interface for locations that serve as a source to load Tableau data from. This interface can be obtained through scoped dependency injection for the current in-progress migration.

Inherited Members

IMigrationEndpoint.InitializeAsync(CancellationToken)

IMigrationEndpoint.GetPager<TContent>(int)

IMigrationEndpoint.GetSessionAsync(CancellationToken)

IMigrationEndpoint.GetContentClient<TContent>()

IAsyncDisposable.DisposeAsync()

Namespace: Tableau.Migration.Engine.Endpoints

Assembly: Tableau.Migration.dll

Syntax

public interface ISourceEndpoint : IMigrationEndpoint, IAsyncDisposable

Methods

GetPermissionsAsync(Type, IContentReference, CancellationToken)

Gets permissions for the content item.

Declaration

Task<IResult<IPermissions>> GetPermissionsAsync(Type type, IContentReference contentItem, CancellationToken cancel)

Parameters

Type	Name	Description
Type	type	The content type.
IContentReference	contentItem	The content item to get permissions for.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<IPermissions>>	The result of the permissions operation.

GetPermissionsAsync<TContent>(IContentReference, CancellationToken)

Gets permissions for the content item.

Declaration

Task<IResult<IPermissions>> GetPermissionsAsync<TContent>(IContentReference contentItem, CancellationToken cancel) where TContent : IPermissionsContent

Parameters

Type	Name	Description
IContentReference	contentItem	The content item to get permissions for.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<IPermissions>>	The result of the permissions operation.

Type Parameters

Name	Description
TContent	The content type.

ListConnectionsAsync<TContent>(Guid, CancellationToken)

List the content item's connections.

Declaration

Task<IResult<ImmutableList<IConnection>>> ListConnectionsAsync<TContent>(Guid contentItemId, CancellationToken cancel) where TContent : IWithConnections

Parameters

Type	Name	Description
Guid	contentItemId	The ID of the content item.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<ImmutableList<IConnection>>>	An immutable list of connections.

Type Parameters

Name	Description
TContent

PullAsync<TContent, TPrepare>(TContent, CancellationToken)

Pulls enough information to prepare and publish the content item.

Declaration

Task<IResult<TPrepare>> PullAsync<TContent, TPrepare>(TContent contentItem, CancellationToken cancel) where TPrepare : class

Parameters

Type	Name	Description
TContent	contentItem	The content item to pull.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<TPrepare>>	The result of the pull operation with the item to prepare and publish.

Type Parameters

Name	Description
TContent	The content type.
TPrepare	The preparation type.

RetrieveKeychainsAsync<TContent>(Guid, IDestinationSiteInfo, CancellationToken)

Retrieves the encrypted keychains for the content item.

Declaration

Task<IResult<IEmbeddedCredentialKeychainResult>> RetrieveKeychainsAsync<TContent>(Guid contentItemId, IDestinationSiteInfo destinationSiteInfo, CancellationToken cancel) where TContent : IWithEmbeddedCredentials

Parameters

Type	Name	Description
Guid	contentItemId	The ID of the content item.
IDestinationSiteInfo	destinationSiteInfo	The destination site information.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<IEmbeddedCredentialKeychainResult>>	The operation result.

Type Parameters

Name	Description
TContent

RetrieveUserSavedCredentialsAsync(Guid, IDestinationSiteInfo, CancellationToken)

Retrieves saved credentials for a specific user.

Declaration

Task<IResult<IEmbeddedCredentialKeychainResult>> RetrieveUserSavedCredentialsAsync(Guid userId, IDestinationSiteInfo destinationSiteInfo, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	userId	The user's ID.
IDestinationSiteInfo	destinationSiteInfo	The destination site information.
CancellationToken	cancel	The cancellation token.

Returns

Type	Description
Task<IResult<IEmbeddedCredentialKeychainResult>>	The user's saved credentials.