Interface ISitesApiClient

Interface for authenticated site-specific API clients

Inherited Members

IAsyncDisposable.DisposeAsync()

IContentApiClient.UrlPrefix

Namespace: Tableau.Migration.Api

Assembly: Tableau.Migration.dll

Syntax

public interface ISitesApiClient : IAsyncDisposable, IContentApiClient

Properties

AuthenticationConfigurations

Gets the API client for authentication configuration operations.

Declaration

IAuthenticationConfigurationsApiClient AuthenticationConfigurations { get; }

Property Value

Type	Description
IAuthenticationConfigurationsApiClient

CloudSubscriptions

Gets the API client for Tableau Cloud subscription operations.

Declaration

ICloudSubscriptionsApiClient CloudSubscriptions { get; }

Property Value

Type	Description
ICloudSubscriptionsApiClient

CloudTasks

Gets the API client for Tableau Cloud task operations.

Declaration

ICloudTasksApiClient CloudTasks { get; }

Property Value

Type	Description
ICloudTasksApiClient

CustomViews

Gets the API client for custom view operations.

Declaration

ICustomViewsApiClient CustomViews { get; }

Property Value

Type	Description
ICustomViewsApiClient

DataSources

Gets the API client for data source operations.

Declaration

IDataSourcesApiClient DataSources { get; }

Property Value

Type	Description
IDataSourcesApiClient

Flows

Gets the API client for prep flow operations.

Declaration

IFlowsApiClient Flows { get; }

Property Value

Type	Description
IFlowsApiClient

Groups

Gets the API client for group operations.

Declaration

IGroupsApiClient Groups { get; }

Property Value

Type	Description
IGroupsApiClient

Jobs

Gets the API client for job operations.

Declaration

IJobsApiClient Jobs { get; }

Property Value

Type	Description
IJobsApiClient

Projects

Gets the API client for project operations.

Declaration

IProjectsApiClient Projects { get; }

Property Value

Type	Description
IProjectsApiClient

Schedules

Gets the API client for schedule operations.

Declaration

ISchedulesApiClient Schedules { get; }

Property Value

Type	Description
ISchedulesApiClient

ServerSubscriptions

Gets the API client for Tableau Server subscription operations.

Declaration

IServerSubscriptionsApiClient ServerSubscriptions { get; }

Property Value

Type	Description
IServerSubscriptionsApiClient

ServerTasks

Gets the API client for Tableau Server task operations.

Declaration

IServerTasksApiClient ServerTasks { get; }

Property Value

Type	Description
IServerTasksApiClient

Users

Gets the API client for user operations.

Declaration

IUsersApiClient Users { get; }

Property Value

Type	Description
IUsersApiClient

Views

Gets the API client for view operations.

Declaration

IViewsApiClient Views { get; }

Property Value

Type	Description
IViewsApiClient

Workbooks

Gets the API client for workbook operations.

Declaration

IWorkbooksApiClient Workbooks { get; }

Property Value

Type	Description
IWorkbooksApiClient

Methods

GetBatchPublishApiClient<TPublish>()

Gets the IBatchPublishApiClient<TPublish> for the given content publish type.

Declaration

IBatchPublishApiClient<TPublish> GetBatchPublishApiClient<TPublish>()

Returns

Type	Description
IBatchPublishApiClient<TPublish>	The batch publish API client for the given content publish type.

Type Parameters

Name	Description
TPublish	The content publish type.

Exceptions

Type	Condition
ArgumentException	If a batch publish API client for the given content publish type is not supported.

GetConnectionsApiClient<TContent>()

Gets the IConnectionsApiClient for the given content type.

Declaration

IConnectionsApiClient GetConnectionsApiClient<TContent>() where TContent : IWithConnections

Returns

Type	Description
IConnectionsApiClient	The embedded connections API client for the given content type.

Type Parameters

Name	Description
TContent	The content type.

Exceptions

Type	Condition
ArgumentException	If a ownership API client for the given content type is not supported.

GetDeleteApiClient<TContent>()

Gets the IDeleteApiClient for the given content type.

Declaration

IDeleteApiClient GetDeleteApiClient<TContent>() where TContent : IDelible

Returns

Type	Description
IDeleteApiClient	The embedded delete API client for the given content type.

Type Parameters

Name	Description
TContent	The content type.

Exceptions

Type	Condition
ArgumentException	If a delete API client for the given content type is not supported.

GetEmbeddedCredentialsApiClient<TContent>()

Gets the IEmbeddedCredentialsApiClient for the given content type.

Declaration

IEmbeddedCredentialsContentApiClient GetEmbeddedCredentialsApiClient<TContent>() where TContent : IWithEmbeddedCredentials

Returns

Type	Description
IEmbeddedCredentialsContentApiClient	The embedded embedded-credentials API client for the given content type.

Type Parameters

Name	Description
TContent	The content type.

Exceptions

Type	Condition
ArgumentException	If a ownership API client for the given content type is not supported.

GetListApiClient<TContent>()

Gets the IPagedListApiClient<TContent> for the given content type.

Declaration

IPagedListApiClient<TContent> GetListApiClient<TContent>()

Returns

Type	Description
IPagedListApiClient<TContent>	The list API client for the given content type.

Type Parameters

Name	Description
TContent	The content type.

Exceptions

Type	Condition
ArgumentException	If a list API client for the given content type is not supported.

GetOwnershipApiClient<TContent>()

Gets the IOwnershipApiClient for the given content type.

Declaration

IOwnershipApiClient GetOwnershipApiClient<TContent>() where TContent : IWithOwner

Returns

Type	Description
IOwnershipApiClient	The ownership API client for the given content type.

Type Parameters

Name	Description
TContent	The content type.

Exceptions

Type	Condition
ArgumentException	If a ownership API client for the given content type is not supported.

GetPermissionsApiClient(Type)

Gets the IPermissionsApiClient for the given content type.

Declaration

IPermissionsApiClient GetPermissionsApiClient(Type type)

Parameters

Type	Name	Description
Type	type

Returns

Type	Description
IPermissionsApiClient	The permissions API client for the given content type.

Exceptions

Type	Condition
ArgumentException	If a permissions API client for the given content type is not supported.

GetPermissionsApiClient<TContent>()

Gets the IPermissionsApiClient for the given content type.

Declaration

IPermissionsApiClient GetPermissionsApiClient<TContent>()

Returns

Type	Description
IPermissionsApiClient	The permissions API client for the given content type.

Type Parameters

Name	Description
TContent	The content type.

Exceptions

Type	Condition
ArgumentException	If a permissions API client for the given content type is not supported.

GetPublishApiClient<TPublish, TPublishResult>()

Gets the IPublishApiClient<TPublish, TPublishResult> for the given content publish type.

Declaration

IPublishApiClient<TPublish, TPublishResult> GetPublishApiClient<TPublish, TPublishResult>() where TPublishResult : class, IContentReference

Returns

Type	Description
IPublishApiClient<TPublish, TPublishResult>	The publish API client for the given content publish type.

Type Parameters

Name	Description
TPublish	The content publish type.
TPublishResult	The publish result type.

Exceptions

Type	Condition
ArgumentException	If a publish API client for the given content publish type is not supported.

GetPullApiClient<TContent, TPrepare>()

Gets the IPullApiClient<TContent, TPrepare> for the given content and prepare types.

Declaration

IPullApiClient<TContent, TPrepare> GetPullApiClient<TContent, TPrepare>() where TPrepare : class

Returns

Type	Description
IPullApiClient<TContent, TPrepare>	The pull API client for the given content and prepare types.

Type Parameters

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

Exceptions

Type	Condition
ArgumentException	If a pull API client for the given types is not supported.

GetReadApiClient<TContent>()

Gets the IReadApiClient<TContent> for the given content type.

Declaration

IReadApiClient<TContent>? GetReadApiClient<TContent>() where TContent : class

Returns

Type	Description
IReadApiClient<TContent>	The read API client for the given content type, or null if the given content type is not supported.

Type Parameters

Name	Description
TContent	The content type.

GetSiteAsync(Guid, CancellationToken)

Gets the site with the specified ID.

Declaration

Task<IResult<ISite>> GetSiteAsync(Guid siteId, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	siteId	The site's ID.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<ISite>>	The site with the specified ID.

GetSiteAsync(string, CancellationToken)

Gets the site with the specified content URL.

Declaration

Task<IResult<ISite>> GetSiteAsync(string contentUrl, CancellationToken cancel)

Parameters

Type	Name	Description
string	contentUrl	The site's content URL.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<ISite>>	The site with the specified content URL.

GetTagsApiClient<TContent>()

Gets the ITagsApiClient for the given content type.

Declaration

ITagsApiClient GetTagsApiClient<TContent>() where TContent : IWithTags

Returns

Type	Description
ITagsApiClient	The tags API client for the given content type.

Type Parameters

Name	Description
TContent	The content type.

Exceptions

Type	Condition
ArgumentException	If a tags API client for the given content type is not supported.

UpdateSiteAsync(ISiteSettingsUpdate, CancellationToken)

Updates the site.

Declaration

Task<IResult<ISite>> UpdateSiteAsync(ISiteSettingsUpdate update, CancellationToken cancel)

Parameters

Type	Name	Description
ISiteSettingsUpdate	update	The settings to update on the site..
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<ISite>>	The site information returned after the update.