Tableau Migration SDK 5.1.1
  • Articles
  • Code Samples
  • Python API Reference
  • C# API Reference
Show / Hide Table of Contents
  • Tableau.Migration
    • Api
      • EmbeddedCredentials
        • IEmbeddedCredentialsApiClient
        • IEmbeddedCredentialsContentApiClient
      • Labels
        • ILabelsApiClientFactory
        • ILabelsApiClient<TContent>
        • ILabelsContentApiClient<TContent>
      • Models
        • Cloud
          • CreateExtractRefreshTaskOptions
          • CreateSubscriptionOptions
          • ICreateExtractRefreshTaskOptions
          • ICreateSubscriptionOptions
        • ApplyKeychainOptions
        • CreateProjectOptions
        • DestinationSiteInfo
        • EmbeddedCredentialKeychainResult
        • FailedJobException
        • FileDownload
        • IAddUserResult
        • IAddUserToGroupResult
        • IApplyKeychainOptions
        • ICreateProjectOptions
        • ICustomViewAsUserDefaultViewResult
        • IDestinationSiteInfo
        • IEmbeddedCredentialKeychainResult
        • IImportJob
        • IJob
        • IKeychainUserMapping
        • ILabelUpdateOptions
        • IPublishCustomViewOptions
        • IPublishDataSourceOptions
        • IPublishFileOptions
        • IPublishFlowOptions
        • IPublishWorkbookOptions
        • IServerInfo
        • ISignInResult
        • IStatusNote
        • IUpdateConnectionOptions
        • IUpdateDataSourceResult
        • IUpdateProjectResult
        • IUpdateUserResult
        • IUpdateWorkbookResult
        • KeychainUserMapping
        • LabelUpdateOptions
        • PublishCustomViewOptions
        • PublishDataSourceOptions
        • PublishFlowOptions
        • PublishWorkbookOptions
        • TimeoutJobException
        • UpdateConnectionOptions
      • Permissions
        • IDefaultPermissionsApiClient
        • IPermissionsApiClient
        • IPermissionsApiClientFactory
        • IPermissionsContentApiClient
      • Publishing
        • ICustomViewPublisher
        • IDataSourcePublisher
        • IFilePublisher<TPublishOptions, TPublishResult>
        • IFlowPublisher
        • IWorkbookPublisher
      • Rest
        • Models
          • Requests
            • Cloud
              • CreateExtractRefreshTaskRequest
              • CreateExtractRefreshTaskRequest.ExtractRefreshType
              • CreateExtractRefreshTaskRequest.ExtractRefreshType.DataSourceType
              • CreateExtractRefreshTaskRequest.ExtractRefreshType.WorkbookType
              • CreateExtractRefreshTaskRequest.ScheduleType
              • CreateExtractRefreshTaskRequest.ScheduleType.FrequencyDetailsType
              • CreateExtractRefreshTaskRequest.ScheduleType.FrequencyDetailsType.IntervalType
              • CreateSubscriptionRequest
              • CreateSubscriptionRequest.ScheduleType
              • CreateSubscriptionRequest.ScheduleType.FrequencyDetailsType
              • CreateSubscriptionRequest.ScheduleType.FrequencyDetailsType.IntervalType
              • CreateSubscriptionRequest.SubscriptionType
              • CreateSubscriptionRequest.SubscriptionType.ContentType
              • CreateSubscriptionRequest.SubscriptionType.UserType
              • UpdateSubscriptionRequest
              • UpdateSubscriptionRequest.ScheduleType
              • UpdateSubscriptionRequest.ScheduleType.FrequencyDetailsType
              • UpdateSubscriptionRequest.ScheduleType.FrequencyDetailsType.IntervalType
              • UpdateSubscriptionRequest.SubcriptionType
              • UpdateSubscriptionRequest.SubcriptionType.ContentType
              • UpdateSubscriptionRequest.SubcriptionType.UserType
            • AddTagsRequest
            • AddTagsRequest.TagType
            • AddUserToGroupRequest
            • AddUserToGroupRequest.UserType
            • AddUserToSiteRequest
            • AddUserToSiteRequest.UserType
            • ApplyKeychainRequest
            • ApplyKeychainRequest.UserLuidPairType
            • CommitCustomViewPublishRequest
            • CommitCustomViewPublishRequest.CustomViewType
            • CommitCustomViewPublishRequest.CustomViewType.OwnerType
            • CommitCustomViewPublishRequest.CustomViewType.WorkbookType
            • CommitDataSourcePublishRequest
            • CommitDataSourcePublishRequest.DataSourceType
            • CommitDataSourcePublishRequest.DataSourceType.ProjectType
            • CommitFlowPublishRequest
            • CommitFlowPublishRequest.FlowType
            • CommitFlowPublishRequest.FlowType.ProjectType
            • CommitWorkbookPublishRequest
            • CommitWorkbookPublishRequest.WorkbookType
            • CommitWorkbookPublishRequest.WorkbookType.ConnectionType
            • CommitWorkbookPublishRequest.WorkbookType.ConnectionType.ConnectionCredentialsType
            • CommitWorkbookPublishRequest.WorkbookType.ProjectType
            • CommitWorkbookPublishRequest.WorkbookType.ViewType
            • CreateLocalGroupRequest
            • CreateLocalGroupRequest.GroupType
            • CreateProjectRequest
            • CreateProjectRequest.ProjectType
            • GetLabelsRequest
            • GetLabelsRequest.ContentType
            • ImportGroupRequest
            • ImportGroupRequest.GroupType
            • ImportGroupRequest.GroupType.ImportType
            • ImportUsersFromCsvRequest
            • ImportUsersFromCsvRequest.UserType
            • PermissionsAddRequest
            • RetrieveKeychainRequest
            • RetrieveUserSavedCredentialsRequest
            • SetCustomViewDefaultUsersRequest
            • SetCustomViewDefaultUsersRequest.UserType
            • SignInRequest
            • SignInRequest.CredentialsType
            • SignInRequest.CredentialsType.SiteType
            • TableauServerRequest
            • UpdateConnectionRequest
            • UpdateConnectionRequest.ConnectionType
            • UpdateCustomViewRequest
            • UpdateCustomViewRequest.CustomViewType
            • UpdateCustomViewRequest.CustomViewType.OwnerType
            • UpdateDataSourceRequest
            • UpdateDataSourceRequest.DataSourceType
            • UpdateDataSourceRequest.DataSourceType.OwnerType
            • UpdateDataSourceRequest.DataSourceType.ProjectType
            • UpdateLabelsRequest
            • UpdateLabelsRequest.ContentType
            • UpdateLabelsRequest.LabelType
            • UpdateProjectRequest
            • UpdateProjectRequest.ProjectType
            • UpdateProjectRequest.ProjectType.OwnerType
            • UpdateSiteRequest
            • UpdateSiteRequest.SiteType
            • UpdateUserRequest
            • UpdateUserRequest.UserType
            • UpdateWorkbookRequest
            • UpdateWorkbookRequest.WorkbookType
            • UpdateWorkbookRequest.WorkbookType.OwnerType
            • UpdateWorkbookRequest.WorkbookType.ProjectType
            • UploadUserSavedCredentialsRequest
          • Responses
            • Cloud
              • CreateExtractRefreshTaskResponse
              • CreateExtractRefreshTaskResponse.ExtractRefreshType
              • CreateExtractRefreshTaskResponse.ExtractRefreshType.DataSourceType
              • CreateExtractRefreshTaskResponse.ExtractRefreshType.WorkbookType
              • CreateExtractRefreshTaskResponse.ScheduleType
              • CreateExtractRefreshTaskResponse.ScheduleType.FrequencyDetailsType
              • CreateExtractRefreshTaskResponse.ScheduleType.FrequencyDetailsType.IntervalType
              • CreateSubscriptionResponse
              • CreateSubscriptionResponse.SubscriptionType
              • CreateSubscriptionResponse.SubscriptionType.ContentType
              • CreateSubscriptionResponse.SubscriptionType.ScheduleType
              • CreateSubscriptionResponse.SubscriptionType.ScheduleType.FrequencyDetailsType
              • CreateSubscriptionResponse.SubscriptionType.ScheduleType.FrequencyDetailsType.IntervalType
              • CreateSubscriptionResponse.SubscriptionType.UserType
              • ExtractRefreshTasksResponse
              • ExtractRefreshTasksResponse.TaskType
              • ExtractRefreshTasksResponse.TaskType.ExtractRefreshType
              • ExtractRefreshTasksResponse.TaskType.ExtractRefreshType.DataSourceType
              • ExtractRefreshTasksResponse.TaskType.ExtractRefreshType.ScheduleType
              • ExtractRefreshTasksResponse.TaskType.ExtractRefreshType.ScheduleType.FrequencyDetailsType
              • ExtractRefreshTasksResponse.TaskType.ExtractRefreshType.ScheduleType.FrequencyDetailsType.IntervalType
              • ExtractRefreshTasksResponse.TaskType.ExtractRefreshType.WorkbookType
              • GetSubscriptionsResponse
              • GetSubscriptionsResponse.SubscriptionType
              • GetSubscriptionsResponse.SubscriptionType.ContentType
              • GetSubscriptionsResponse.SubscriptionType.ScheduleType
              • GetSubscriptionsResponse.SubscriptionType.ScheduleType.FrequencyDetailsType
              • GetSubscriptionsResponse.SubscriptionType.ScheduleType.FrequencyDetailsType.IntervalType
              • GetSubscriptionsResponse.SubscriptionType.UserType
              • ICloudExtractRefreshType
              • ICloudExtractRefreshType<TWorkbook, TDataSource>
              • ICloudScheduleType
              • UpdateSubscriptionResponse
              • UpdateSubscriptionResponse.ScheduleType
              • UpdateSubscriptionResponse.ScheduleType.FrequencyDetailsType
              • UpdateSubscriptionResponse.ScheduleType.FrequencyDetailsType.IntervalType
              • UpdateSubscriptionResponse.SubscriptionType
              • UpdateSubscriptionResponse.SubscriptionType.ContentType
              • UpdateSubscriptionResponse.SubscriptionType.UserType
            • Server
              • ExtractRefreshTasksResponse
              • ExtractRefreshTasksResponse.TaskType
              • ExtractRefreshTasksResponse.TaskType.ExtractRefreshType
              • ExtractRefreshTasksResponse.TaskType.ExtractRefreshType.DataSourceType
              • ExtractRefreshTasksResponse.TaskType.ExtractRefreshType.ScheduleType
              • ExtractRefreshTasksResponse.TaskType.ExtractRefreshType.WorkbookType
              • GetSubscriptionsResponse
              • GetSubscriptionsResponse.SubscriptionType
              • GetSubscriptionsResponse.SubscriptionType.ContentType
              • GetSubscriptionsResponse.SubscriptionType.ScheduleType
              • GetSubscriptionsResponse.SubscriptionType.UserType
              • IServerExtractRefreshType
              • IServerExtractRefreshType<TWorkbook, TDataSource>
              • IServerScheduleType
              • ScheduleExtractRefreshTasksResponse
              • ScheduleExtractRefreshTasksResponse.ExtractType
              • ScheduleExtractRefreshTasksResponse.ExtractType.DataSourceType
              • ScheduleExtractRefreshTasksResponse.ExtractType.WorkbookType
              • ScheduleResponse
              • ScheduleResponse.ScheduleType
              • ScheduleResponse.ScheduleType.FrequencyDetailsType
              • ScheduleResponse.ScheduleType.FrequencyDetailsType.IntervalType
            • AddTagsResponse
            • AddTagsResponse.TagType
            • AddUserResponse
            • AddUserResponse.UserType
            • ConnectionResponse
            • ConnectionResponse.ConnectionType
            • ConnectionsResponse
            • ConnectionsResponse.ConnectionType
            • CreateGroupResponse
            • CreateGroupResponse.GroupType
            • CreateGroupResponse.GroupType.ImportType
            • CreateProjectResponse
            • CreateProjectResponse.ProjectType
            • CreateProjectResponse.ProjectType.OwnerType
            • CustomViewAsUsersDefaultViewResponse
            • CustomViewAsUsersDefaultViewResponse.CustomViewAsUserDefaultViewType
            • CustomViewAsUsersDefaultViewResponse.CustomViewAsUserDefaultViewType.UserType
            • CustomViewResponse
            • CustomViewResponse.CustomViewType
            • CustomViewResponse.CustomViewType.OwnerType
            • CustomViewResponse.CustomViewType.ViewType
            • CustomViewResponse.CustomViewType.WorkbookType
            • CustomViewsResponse
            • CustomViewsResponse.CustomViewResponseType
            • CustomViewsResponse.CustomViewResponseType.OwnerType
            • CustomViewsResponse.CustomViewResponseType.ViewType
            • CustomViewsResponse.CustomViewResponseType.WorkbookType
            • DataSourceResponse
            • DataSourceResponse.DataSourceType
            • DataSourceResponse.DataSourceType.OwnerType
            • DataSourceResponse.DataSourceType.ProjectType
            • DataSourceResponse.DataSourceType.TagType
            • DataSourcesResponse
            • DataSourcesResponse.DataSourceType
            • DataSourcesResponse.DataSourceType.OwnerType
            • DataSourcesResponse.DataSourceType.ProjectType
            • DataSourcesResponse.DataSourceType.TagType
            • EmptyTableauServerResponse
            • FileUploadResponse
            • FileUploadResponse.FileUploadType
            • FlowResponse
            • FlowResponse.FlowType
            • FlowResponse.FlowType.OwnerType
            • FlowResponse.FlowType.ProjectType
            • FlowResponse.FlowType.TagType
            • FlowsResponse
            • FlowsResponse.FlowType
            • FlowsResponse.FlowType.OwnerType
            • FlowsResponse.FlowType.ProjectType
            • FlowsResponse.FlowType.TagType
            • GroupResponse
            • GroupResponse.GroupType
            • GroupResponse.GroupType.DomainType
            • GroupsResponse
            • GroupsResponse.GroupType
            • GroupsResponse.GroupType.DomainType
            • GroupsResponse.GroupType.ImportType
            • IExtractRefreshType
            • IExtractRefreshType<TWorkbook, TDataSource>
            • IScheduleFrequencyDetailsType
            • IScheduleIntervalType
            • IScheduleReferenceType
            • ISubscriptionContentType
            • ImportJobResponse
            • ImportJobResponse.ImportJobType
            • JobResponse
            • JobResponse.JobType
            • JobResponse.JobType.StatusNoteType
            • LabelsResponse
            • LabelsResponse.LabelType
            • LabelsResponse.LabelType.OwnerType
            • LabelsResponse.LabelType.SiteType
            • MetricsResponse
            • MetricsResponse.MetricType
            • MetricsResponse.MetricType.ProjectType
            • MetricsResponse.MetricType.TagType
            • MetricsResponse.MetricType.UnderlyingViewType
            • MetricsResponse.MetricType.UserType
            • PagedTableauServerResponse<TItem>
            • PermissionsResponse
            • ProjectsResponse
            • ProjectsResponse.ProjectType
            • ProjectsResponse.ProjectType.ContentCountsType
            • ProjectsResponse.ProjectType.UserType
            • RetrieveKeychainResponse
            • RetrieveSavedCredentialsResponse
            • ServerInfoResponse
            • ServerInfoResponse.ServerInfoType
            • ServerInfoResponse.ServerInfoType.ProductVersionType
            • ServerInfoResponse.ServerInfoType.RestApiVersionType
            • ServerSessionResponse
            • ServerSessionResponse.SessionType
            • ServerSessionResponse.SessionType.SiteType
            • ServerSessionResponse.SessionType.UserType
            • SignInResponse
            • SignInResponse.CredentialsType
            • SignInResponse.CredentialsType.SiteType
            • SignInResponse.CredentialsType.UserType
            • SiteAuthConfigurationsResponse
            • SiteAuthConfigurationsResponse.SiteAuthConfigurationType
            • SiteResponse
            • SiteResponse.SiteType
            • SitesResponse
            • SitesResponse.SiteType
            • TableauServerListResponse<TItem>
            • TableauServerResponse
            • TableauServerResponse<TItem>
            • TableauServerWithParentResponse<TItem>
            • UpdateCustomViewResponse
            • UpdateCustomViewResponse.CustomViewResponseType
            • UpdateCustomViewResponse.CustomViewResponseType.OwnerType
            • UpdateCustomViewResponse.CustomViewResponseType.ViewType
            • UpdateCustomViewResponse.CustomViewResponseType.WorkbookType
            • UpdateDataSourceResponse
            • UpdateDataSourceResponse.DataSourceType
            • UpdateDataSourceResponse.DataSourceType.JobType
            • UpdateDataSourceResponse.DataSourceType.OwnerType
            • UpdateDataSourceResponse.DataSourceType.ProjectType
            • UpdateProjectResponse
            • UpdateProjectResponse.ProjectType
            • UpdateProjectResponse.ProjectType.OwnerType
            • UpdateUserResponse
            • UpdateUserResponse.UserType
            • UpdateWorkbookResponse
            • UpdateWorkbookResponse.WorkbookType
            • UserResponse
            • UsersResponse
            • UsersResponse.UserType
            • UsersResponse.UserType.DomainType
            • UsersWithCustomViewAsDefaultViewResponse
            • UsersWithCustomViewAsDefaultViewResponse.UserType
            • ViewResponse
            • ViewResponse.ViewType
            • ViewResponse.ViewType.ProjectReferenceType
            • ViewResponse.ViewType.TagType
            • ViewResponse.ViewType.WorkbookReferenceType
            • VirtualConnectionsResponse
            • VirtualConnectionsResponse.VirtualConnectionType
            • WorkbookResponse
            • WorkbookResponse.DataAccelerationConfigType
            • WorkbookResponse.WorkbookType
            • WorkbookResponse.WorkbookType.LocationType
            • WorkbookResponse.WorkbookType.OwnerType
            • WorkbookResponse.WorkbookType.ProjectType
            • WorkbookResponse.WorkbookType.TagType
            • WorkbookResponse.WorkbookType.WorkbookViewReferenceType
            • WorkbookResponse.WorkbookType.WorkbookViewReferenceType.ViewTagType
            • WorkbooksResponse
            • WorkbooksResponse.WorkbookType
            • WorkbooksResponse.WorkbookType.LocationType
            • WorkbooksResponse.WorkbookType.OwnerType
            • WorkbooksResponse.WorkbookType.ProjectType
            • WorkbooksResponse.WorkbookType.TagType
          • Types
            • AuthenticationTypes
            • CapabilityType
            • CustomViewFileTypes
            • DataSourceFileTypes
            • ExtractRefreshType
            • FlowFileTypes
            • GranteeCapabilityType
            • GranteeCapabilityType.GroupType
            • GranteeCapabilityType.UserType
            • ParentContentType
            • PermissionsContentItemType
            • PermissionsType
            • ScheduleFrequencies
            • ScheduleTypes
            • WeekDays
            • WorkbookFileTypes
          • AdministratorLevels
          • ContentPermissions
          • Error
          • ExtractEncryptionModes
          • IConnectionType
          • ICustomViewType
          • IDataSourceDetailsType
          • IDataSourceType
          • IFlowType
          • ILocationType
          • IProjectNamedReferenceType
          • IProjectReferenceType
          • IProjectType
          • IScheduleType
          • ISubscriptionType
          • ITableauServerListResponse<TItems>
          • ITableauServerResponse
          • ITableauServerResponse<TItem>
          • ITableauServerWithParentResponse<TItem>
          • ITagType
          • IUserType
          • IViewReferenceType
          • IViewType
          • IWithDataSourceReferenceType
          • IWithOwnerType
          • IWithProjectNamedReferenceType
          • IWithProjectReferenceType
          • IWithScheduleReferenceType
          • IWithTagTypes
          • IWithWorkbookNamedReferenceType
          • IWithWorkbookReferenceType
          • IWorkbookDetailsType
          • IWorkbookNamedReferenceType
          • IWorkbookReferenceType
          • IWorkbookType
          • IWorkbookViewReferenceType
          • LabelCategories
          • LabelContentTypes
          • LicenseLevels
          • Pagination
          • ParentContentTypeNames
          • PermissionsCapabilityModes
          • PermissionsCapabilityNames
          • SiteRoleMapping
          • SiteRoleMappingItem
          • SiteRoles
        • INamedContent
        • IPermissionsUriBuilder
        • IRestIdentifiable
        • RestException
      • Search
        • ApiContentCache<TContent>
        • ApiContentReferenceFinderFactory
        • BulkApiContentReferenceCache<TContent>
      • Simulation
        • Rest
          • Api
            • AuthRestApiSimulator
            • CustomViewsRestApiSimulator
            • DataSourcesRestApiSimulator
            • EmbeddedCredentialsRestApiSimulatorBase<TContent, TTag>
            • FileUploadsRestApiSimulator
            • GroupsRestApiSimulator
            • JobsRestApiSimulator
            • PermissionsRestApiSimulatorBase<TContent>
            • ProjectsRestApiSimulator
            • SchedulesRestApiSimulator
            • SitesRestApiSimulator
            • SubscriptionsRestApiSimulator
            • TagsRestApiSimulatorBase<TContent, TTag>
            • TasksRestApiSimulator
            • UsersRestApiSimulator
            • ViewsRestApiSimulator
            • WorkbooksRestApiSimulator
          • RestApiSimulator
        • ITableauApiSimulatorCollection
        • ITableauApiSimulatorFactory
        • SimulatedConnection
        • SimulatedConnectionCredentials
        • SimulatedCustomViewData
        • SimulatedCustomViewData.SimulatedCustomViewType
        • SimulatedDataSourceData
        • SimulatedDataWithConnections
        • SimulatedWorkbookData
        • SimulatedWorkbookData.SimulatedViewType
        • TableauApiResponseSimulator
        • TableauApiSimulator
        • TableauApiSimulatorCollection
        • TableauApiSimulatorFactory
        • TableauData
      • Tags
        • ITagsApiClient
        • ITagsApiClientFactory
        • ITagsContentApiClient
      • IApiClient
      • IApiClientInput
      • IApiContentUrl
      • IApiPageAccessor<TContent>
      • IAuthenticationConfigurationsApiClient
      • IAuthenticationTokenProvider
      • IBatchPublishApiClient<TPublish>
      • ICloudSubscriptionsApiClient
      • ICloudTasksApiClient
      • IConnectionManager
      • IConnectionsApiClient
      • IContentApiClient
      • ICustomViewsApiClient
      • IDataSourcesApiClient
      • IDeleteApiClient
      • IFlowsApiClient
      • IGroupsApiClient
      • IJobsApiClient
      • IOwnershipApiClient
      • IPagedListApiClient<TContent>
      • IProjectsApiClient
      • IPublishApiClient<TPublish>
      • IPublishApiClient<TPublish, TPublishResult>
      • IPullApiClient<TContent, TPrepare>
      • IReadApiClient<TContent>
      • ISchedulesApiClient
      • IScopedApiClientFactory
      • IServerSessionProvider
      • IServerSubscriptionsApiClient
      • IServerTasksApiClient
      • ISitesApiClient
      • ISubscriptionsApiClient
      • ITableauServerVersionProvider
      • ITasksApiClient
      • IUsersApiClient
      • IViewsApiClient
      • IViewsApiClientFactory
      • IWorkbooksApiClient
      • PublishContentWithFileOptions
      • RefreshAuthenticationTokenDelegate
      • TableauServerVersion
      • TableauSiteConnectionConfiguration
    • Config
      • ConfigReader
      • ContentTypesOptions
      • ContentTypesOptions.Defaults
      • DefaultPermissionsContentTypeOptions
      • FileOptions
      • FileOptions.Defaults
      • IConfigReader
      • JobOptions
      • JobOptions.Defaults
      • MigrationSdkOptions
      • MigrationSdkOptions.Defaults
      • NetworkOptions
      • NetworkOptions.Defaults
      • PreflightOptions
      • PreflightOptions.Defaults
      • ResilienceOptions
      • ResilienceOptions.Defaults
    • Content
      • Files
        • Xml
          • XContainerExtensions
          • XElementExtensions
          • XFeatureFlagName
          • XNameExtensions
        • Aes256EncryptionFactory
        • ContentFileHandle
        • ContentFileStream
        • ContentTypeFilePathResolver
        • DirectoryContentFileStore
        • EncryptedFileHandle
        • EncryptedFileStore
        • EncryptedFileStream
        • IContentFileHandle
        • IContentFilePathResolver
        • IContentFileStore
        • IContentFileStream
        • ISymmetricEncryptionFactory
        • ITableauFileEditor
        • ITableauFileXmlStream
        • SeekableCryptoStream
        • TableauFileEditor
        • TableauFileXmlStream
        • TemporaryDirectoryContentFileStore
      • Permissions
        • Capability
        • DefaultPermissionsContentTypeUrlSegments
        • GranteeCapability
        • GranteeType
        • ICapability
        • IGranteeCapability
        • IPermissions
      • Schedules
        • Cloud
          • ICloudExtractRefreshTask
          • ICloudSchedule
        • Server
          • IScheduleExtractRefreshTask
          • IScheduleExtractRefreshTasks
          • IServerExtractRefreshTask
          • IServerSchedule
          • ScheduleExtractRefreshTask
          • ScheduleExtractRefreshTasks
        • ExtractRefreshContentType
        • IExtractRefreshTask<TSchedule>
        • IFrequencyDetails
        • IInterval
        • ISchedule
        • IWithSchedule<TSchedule>
        • InvalidScheduleException
      • Search
        • CachedContentReferenceFinder<TContent>
        • ContentReferenceCacheBase
        • IContentCacheFactory
        • IContentCache<TContent>
        • IContentReferenceCache
        • IContentReferenceFinder
        • IContentReferenceFinderFactory
        • IContentReferenceFinder<TContent>
      • ConcurrentSet<T>
      • ContainerContentBase
      • ContentBase
      • ContentReferenceStub
      • IAuthenticationConfiguration
      • IChildPermissionsContent
      • ICloudSubscription
      • IConnection
      • IConnectionsContent
      • IContainerContent
      • ICustomView
      • IDataSource
      • IDataSourceDetails
      • IDelible
      • IDescriptionContent
      • IExtractContent
      • IFileContent
      • IFlow
      • IGroup
      • IGroupUser
      • ILabel
      • IMappableContainerContent
      • IMappableContent
      • IPermissionsContent
      • IProject
      • IPublishableCustomView
      • IPublishableDataSource
      • IPublishableFlow
      • IPublishableGroup
      • IPublishableWorkbook
      • IPublishedContent
      • IRequiresEmbeddedCredentialMigration
      • IRequiresLabelUpdate
      • IRequiresOwnerUpdate
      • IServerSession
      • IServerSubscription
      • ISite
      • ISiteSettings
      • ISiteSettingsUpdate
      • ISubscriptionContent
      • ISubscription<TSchedule>
      • ITag
      • IUser
      • IUsernameContent
      • IView
      • IWithConnections
      • IWithDomain
      • IWithEmbeddedCredentials
      • IWithLabels
      • IWithOwner
      • IWithTags
      • IWithWorkbook
      • IWorkbook
      • IWorkbookDetails
      • MappableContainerContentBase
      • Tag
      • TagLabelComparer
      • UserAuthenticationType
      • UsernameContentBase
    • Engine
      • Actions
        • IMigrateContentAction<TContent>
        • IMigrationAction
        • IMigrationActionResult
        • MigrateContentAction<TContent>
        • PreflightAction
      • Conversion
        • ExtractRefreshTasks
          • IExtractRefreshTaskConverter<TSourceTask, TTargetTask>
        • Schedules
          • IScheduleConverter<TSourceSchedule, TTargetSchedule>
        • Subscriptions
          • ISubscriptionConverter<TSourceSubscription, TTargetSubscription>
        • DirectContentItemConverter<TPrepare, TPublish>
        • IContentItemConverter<TPrepare, TPublish>
      • Endpoints
        • ContentClients
          • ContentClientBase<TContent>
          • IContentClientFactory
          • IContentClient<TContent>
          • IViewsContentClient
          • IWorkbooksContentClient
          • ViewsContentClient
          • WorkbooksContentClient
        • Search
          • BulkApiAuthenticationConfigurationsCache
          • BulkDestinationCache<TContent>
          • BulkDestinationProjectCache
          • BulkSourceCache<TContent>
          • IDestinationAuthenticationConfigurationsCache
          • IDestinationContentReferenceFinderFactory
          • IDestinationContentReferenceFinder<TContent>
          • ILockedProjectCache
          • ISourceContentReferenceFinderFactory
          • ISourceContentReferenceFinder<TContent>
          • IUserSavedCredentialsCache
          • ManifestDestinationContentReferenceFinderFactory
          • ManifestDestinationContentReferenceFinder<TContent>
          • ManifestSourceContentReferenceFinderFactory
          • ManifestSourceContentReferenceFinder<TContent>
        • IDestinationApiEndpoint
        • IDestinationEndpoint
        • IMigrationApiEndpoint
        • IMigrationEndpoint
        • IMigrationEndpointFactory
        • IMigrationPlanEndpointConfiguration
        • ISourceApiEndpoint
        • ISourceEndpoint
        • ITableauApiEndpointConfiguration
        • MigrationEndpointFactory
        • TableauApiDestinationEndpoint
        • TableauApiEndpointBase
        • TableauApiEndpointConfiguration
        • TableauApiSourceEndpoint
      • Hooks
        • ActionCompleted
          • SubscriptionsEnabledActionCompletedHook
        • Filters
          • Default
            • GroupAllUsersFilter
            • GroupAllUsersFilterOptions
            • PreviouslyMigratedFilterOptions
            • PreviouslyMigratedFilter<TContent>
            • SystemOwnershipFilter<TContent>
            • UserSiteRoleSupportUserFilter
          • ContentFilterBase<TContent>
          • ContentFilterBuilder
          • ContentLocationInPathFilter<TContent>
          • IContentFilterBuilder
          • IContentFilterRunner
          • IContentFilter<TContent>
        • Mappings
          • Default
            • AuthenticationTypeDomainMapping
            • AuthenticationTypeDomainMappingBase
            • AuthenticationTypeDomainMappingOptions
            • CallbackAuthenticationTypeDomainMapping
            • IAuthenticationTypeDomainMapping
            • ITableauCloudUsernameMapping
            • TableauCloudUsernameMapping
            • TableauCloudUsernameMappingOptions
          • ContentMappingBase<TContent>
          • ContentMappingBuilder
          • ContentMappingContext<TContent>
          • IContentMappingBuilder
          • IContentMappingRunner
          • IContentMapping<TContent>
        • PostPublish
          • Default
            • ChildItemsPermissionsPostPublishHook<TPublish, TResult>
            • CustomViewDefaultUsersPostPublishHook
            • EmbeddedCredentialsItemPostPublishHook<TPublish, TResult>
            • OwnerItemPostPublishHook<TPublish, TResult>
            • PermissionPostPublishHookBase<TPublish, TResult>
            • PermissionsItemPostPublishHook<TPublish, TResult>
            • ProjectPostPublishHook
            • TagItemPostPublishHook<TPublish, TResult>
          • BulkPostPublishContext<TPublish>
          • BulkPostPublishHookBase<TSource>
          • ContentItemPostPublishContext<TPublish, TResult>
          • ContentItemPostPublishHookBase<TContent>
          • ContentItemPostPublishHookBase<TPublish, TResult>
          • IBulkPostPublishHook<TSource>
          • IContentItemPostPublishHook<TPublish, TResult>
        • Transformers
          • Default
            • CustomViewDefaultUserReferencesTransformer
            • EncryptExtractTransformer<TIExtractContent>
            • GroupUsersTransformer
            • IMappedUserTransformer
            • IPermissionsTransformer
            • IUserReferenceTransformer
            • MappedReferenceExtractRefreshTaskTransformer
            • MappedUserTransformer
            • OwnershipTransformer<TContent>
            • PermissionsTransformer
            • TableauServerConnectionUrlTransformer
            • UserAuthenticationTypeTransformer
            • UserAuthenticationTypeTransformerOptions
            • UserTableauCloudSiteRoleTransformer
            • WorkbookReferenceTransformer<TContent>
          • ContentTransformerBase<TPublish>
          • ContentTransformerBuilder
          • IContentTransformerBuilder
          • IContentTransformerRunner
          • IContentTransformer<TPublish>
          • IXmlContentTransformer<TPublish>
          • XmlContentTransformerBase<TPublish>
        • ContentTypeHookBuilderBase
        • IContentBatchMigrationCompletedHook<TContent>
        • IContentTypeHookBuilder
        • IInitializeMigrationHook
        • IInitializeMigrationHookResult
        • IMigrationActionCompletedHook
        • IMigrationCapabilityManager
        • IMigrationHookBuilder
        • IMigrationHookFactory
        • IMigrationHookFactoryCollection
        • IMigrationHookRunner
        • IMigrationHook<TContext>
        • ISubscriptionsCapabilityManager
        • MigrationHookBuilder
        • MigrationHookBuilderBase
        • MigrationHookFactory
        • MigrationHookFactoryCollection
      • Manifest
        • Logging
          • LoggingMigrationManifest
          • LoggingMigrationManifestContentTypePartition
          • LoggingMigrationManifestEntryCollection
        • IMigrationManifestContentTypePartition
        • IMigrationManifestContentTypePartitionEditor
        • IMigrationManifestEditor
        • IMigrationManifestEntry
        • IMigrationManifestEntryBuilder
        • IMigrationManifestEntryCollection
        • IMigrationManifestEntryCollectionEditor
        • IMigrationManifestEntryEditor
        • IMigrationManifestFactory
        • MigrationManifest
        • MigrationManifestContentTypePartition
        • MigrationManifestEntry
        • MigrationManifestEntryCollection
        • MigrationManifestEntryStatus
        • MigrationManifestFactory
        • MigrationManifestSerializer
      • Migrators
        • Batch
          • BulkPublishContentBatchMigrator<TContent>
          • BulkPublishContentBatchMigrator<TContent, TPrepare, TPublish>
          • ContentBatchMigratorBase<TContent>
          • ContentBatchMigratorBase<TContent, TPrepare, TPublish>
          • ContentMigrationBatch<TContent, TPublish>
          • IContentBatchMigrationResult<TContent>
          • IContentBatchMigrator<TContent>
          • ItemPublishContentBatchMigrator<TContent>
          • ItemPublishContentBatchMigrator<TContent, TPrepare>
          • ItemPublishContentBatchMigrator<TContent, TPublish, TResult>
          • ItemPublishContentBatchMigrator<TContent, TPrepare, TPublish, TResult>
          • ParallelContentBatchMigratorBatchBase<TContent>
          • ParallelContentBatchMigratorBatchBase<TContent, TPrepare, TPublish>
        • ContentMigrator<TContent>
        • IContentItemMigrationResult<TContent>
        • IContentMigrator<TContent>
        • Migrator
      • Options
        • IMigrationPlanOptionsBuilder
        • IMigrationPlanOptionsCollection
        • IMigrationPlanOptionsProvider<TOptions>
        • MigrationPlanOptionsBuilder
        • MigrationPlanOptionsCollection
        • MigrationPlanOptionsProvider<TOptions>
      • Pipelines
        • CloudToCloudMigrationPipeline
        • CustomMigrationPipelineFactory<TPipeline>
        • IMigrationPipeline
        • IMigrationPipelineFactory
        • IMigrationPipelineRunner
        • MigrationPipelineBase
        • MigrationPipelineContentType
        • MigrationPipelineContentType<TContent>
        • MigrationPipelineFactory
        • MigrationPipelineRunner
        • ServerToCloudMigrationPipeline
        • ServerToServerMigrationPipeline
      • Preparation
        • ContentItemPreparerBase<TContent, TPrepare, TPublish>
        • EndpointContentItemPreparer<TContent, TPrepare, TPublish>
        • ExtractRefreshTaskServerToCloudPreparer
        • IContentItemPreparer<TContent, TPublish>
        • SourceContentItemPreparer<TContent>
        • SourceContentItemPreparer<TContent, TPublish>
      • ContentMigrationItem<TContent>
      • IMigration
      • IMigrationInput
      • Migration
      • MigrationDirectoryContentFileStore
      • MigrationInput
      • MigrationPlan
      • MigrationPlanBuilder
      • ServerToCloudMigrationPlanBuilder
    • Interop
      • Hooks
        • ISyncContentBatchMigrationCompletedHook<TContent>
        • ISyncInitializeMigrationHook
        • ISyncMigrationActionCompletedHook
        • ISyncMigrationHook<TContext>
      • Logging
        • INonGenericLogger
        • NonGenericLoggerBase
      • IServiceCollectionExtensions
      • InteropHelper
    • JsonConverters
      • Exceptions
        • MismatchException
        • UnknownException
      • SerializableObjects
        • SerializableContentLocation
        • SerializableContentReference
        • SerializableEntryCollection
        • SerializableException
        • SerializableManifestEntry
        • SerializableMigrationManifest
      • ExceptionJsonConverterFactory
      • ExceptionJsonConverter<TException>
      • FailedJobExceptionJsonConverter
      • PythonExceptionConverter
      • RestExceptionJsonConverter
      • SerializedExceptionJsonConverter
    • Net
      • Resilience
        • IResilienceStrategyBuilder
      • Rest
        • Fields
          • Field
          • IFieldBuilder
        • Filtering
          • Filter
          • FilterOperator
          • IFilterBuilder
        • Paging
          • IPageBuilder
          • Page
        • Sorting
          • ISortBuilder
          • Sort
        • IRestRequestBuilder
        • IRestRequestBuilderFactory
      • Simulation
        • Requests
          • IPathRequestMatcher
          • IRequestMatcher
          • PathRequestMatcher
        • Responses
          • EmptyResponseBuilder
          • IResponseBuilder
          • StaticStringResponseBuilder
          • TooManyRequestsResponseBuilder
        • IResponseSimulator
        • IResponseSimulatorProvider
        • MethodSimulator
        • UriExtensions
      • IHttpClient
      • IHttpContentRequestBuilder<TBuilderInterface>
      • IHttpContentSerializer
      • IHttpDeleteRequestBuilder
      • IHttpGetRequestBuilder
      • IHttpPatchRequestBuilder
      • IHttpPostRequestBuilder
      • IHttpPutRequestBuilder
      • IHttpRequestBuilder
      • IHttpRequestBuilderFactory
      • IHttpRequestBuilder<TBuilderInterface>
      • IHttpResponseMessage
      • IHttpResponseMessage<TContent>
      • IHttpStreamProcessor
      • IQueryStringBuilder
      • IRequestBuilder
      • IRequestBuilderFactory
      • IRequestBuilderFactoryInput
      • IRequestBuilderFactoryInputInitializer
      • IRequestBuilderFactory<TRequestBuilder>
      • IRequestBuilder<TBuilder>
      • ITableauSerializer
    • Paging
      • IPageInfo
      • IPagedResult<TItem>
      • IPager<TContent>
      • IndexedPagerBase<TContent>
    • Resources
      • ISharedResourcesLocalizer
    • Constants
    • ContentLocation
    • DateTimeExtensions
    • EquatableException<T>
    • ExceptionComparer
    • IAsyncDisposableResult<T>
    • IContentReference
    • IMemoryStreamManager
    • IMigrationCapabilities
    • IMigrationCapabilitiesEditor
    • IMigrationManifest
    • IMigrationPlan
    • IMigrationPlanBuilder
    • IMigrationPlanBuilderFactory
    • IMigrator
    • IResult
    • IResult<T>
    • IServerToCloudMigrationPlanBuilder
    • IServiceCollectionExtensions
    • ITaskDelayer
    • MigrationCompletionStatus
    • MigrationResult
    • PipelineProfile
    • StringEnum<T>
    • TableauInstanceType
    • TableauInstanceTypeNotSupportedException
    • TaskExtensions
    • TypeExtensions

Class MigrationPipelineContentType

Object that represents a definition of a content type that a pipeline migrates.

Inheritance
object
MigrationPipelineContentType
MigrationPipelineContentType<TContent>
Implements
IEquatable<MigrationPipelineContentType>
Namespace: Tableau.Migration.Engine.Pipelines
Assembly: Tableau.Migration.dll
Syntax
public record MigrationPipelineContentType : IEquatable<MigrationPipelineContentType>

Constructors

MigrationPipelineContentType(Type)

Object that represents a definition of a content type that a pipeline migrates.

Declaration
public MigrationPipelineContentType(Type ContentType)
Parameters
Type Name Description
Type ContentType

The content type. Content type is returned from list step, pre-pull.

Fields

CloudToCloudExtractRefreshTasks

Gets the Cloud to Cloud extract refresh tasks MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType CloudToCloudExtractRefreshTasks
Field Value
Type Description
MigrationPipelineContentType

CloudToCloudSubscriptions

Gets the Cloud to Cloud subscriptions MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType CloudToCloudSubscriptions
Field Value
Type Description
MigrationPipelineContentType

CustomViews

Gets the custom views MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType CustomViews
Field Value
Type Description
MigrationPipelineContentType

DataSources

Gets the data sources MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType DataSources
Field Value
Type Description
MigrationPipelineContentType

Groups

Gets the groups MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType Groups
Field Value
Type Description
MigrationPipelineContentType

Projects

Gets the projects MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType Projects
Field Value
Type Description
MigrationPipelineContentType

ServerToCloudExtractRefreshTasks

Gets the Server to Cloud extract refresh tasks MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType ServerToCloudExtractRefreshTasks
Field Value
Type Description
MigrationPipelineContentType

ServerToCloudSubscriptions

Gets the Server to Cloud subscriptions MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType ServerToCloudSubscriptions
Field Value
Type Description
MigrationPipelineContentType

ServerToServerExtractRefreshTasks

Gets the Server to Server extract refresh tasks MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType ServerToServerExtractRefreshTasks
Field Value
Type Description
MigrationPipelineContentType

ServerToServerSubscriptions

Gets the Server to Server subscriptions MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType ServerToServerSubscriptions
Field Value
Type Description
MigrationPipelineContentType

Users

Gets the user MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType Users
Field Value
Type Description
MigrationPipelineContentType

Views

Gets the views MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType Views
Field Value
Type Description
MigrationPipelineContentType

Workbooks

Gets the workbooks MigrationPipelineContentType.

Declaration
public static readonly MigrationPipelineContentType Workbooks
Field Value
Type Description
MigrationPipelineContentType

Properties

ContentType

The content type. Content type is returned from list step, pre-pull.

Declaration
public Type ContentType { get; init; }
Property Value
Type Description
Type

PrepareType

Gets the preparation type that is pulled and converted for publishing. The Prepare type is the post-pull, pre-conversion type.

Declaration
public Type PrepareType { get; }
Property Value
Type Description
Type

PublishType

Gets the publish type. The publish type is post-conversion, ready to publish.

Declaration
public Type PublishType { get; }
Property Value
Type Description
Type

ResultType

Gets the result type returned by publishing.

Declaration
public Type ResultType { get; }
Property Value
Type Description
Type

Types

Gets the types for this instance.

Declaration
public IImmutableList<Type> Types { get; }
Property Value
Type Description
IImmutableList<Type>

Methods

GetAllMigrationPipelineContentTypes()

Gets all static instances of MigrationPipelineContentType.

Declaration
public static IEnumerable<MigrationPipelineContentType> GetAllMigrationPipelineContentTypes()
Returns
Type Description
IEnumerable<MigrationPipelineContentType>

GetConfigKey()

Gets the config key for this content type.

Declaration
public string GetConfigKey()
Returns
Type Description
string

The config key string.

GetConfigKeyForType(Type)

Gets the config key for a content type.

Declaration
public static string GetConfigKeyForType(Type contentType)
Parameters
Type Name Description
Type contentType

The content type.

Returns
Type Description
string

The config key string.

GetContentTypeForInterface(Type)

Gets the ContentType value if it implements the given interface, or null if it does not.

Declaration
public Type[]? GetContentTypeForInterface(Type @interface)
Parameters
Type Name Description
Type interface

The interface to search for.

Returns
Type Description
Type[]

GetDisplayNameForType(Type, bool)

Gets the friendly display name for a content type.

Declaration
public static string GetDisplayNameForType(Type contentType, bool plural = false)
Parameters
Type Name Description
Type contentType

The content type.

bool plural

Whether the display name should be in plural form.

Returns
Type Description
string

The display name string.

GetMigrationPipelineContentTypes(PipelineProfile)

Gets the content types for a given profile.

Declaration
public static ImmutableArray<MigrationPipelineContentType> GetMigrationPipelineContentTypes(PipelineProfile profile)
Parameters
Type Name Description
PipelineProfile profile

Profile to get the types for.

Returns
Type Description
ImmutableArray<MigrationPipelineContentType>

Array of content types supported by the given pipeline profile.

GetPostPublishTypesForInterface(Type)

Gets the PublishType and ResultType array if it implements the given interface, or null if it does not.

Declaration
public Type[]? GetPostPublishTypesForInterface(Type @interface)
Parameters
Type Name Description
Type interface

The interface to search for.

Returns
Type Description
Type[]

GetPublishTypeForInterface(Type)

Gets the PublishType value if it implements the given interface, or null if it does not.

Declaration
public Type[]? GetPublishTypeForInterface(Type @interface)
Parameters
Type Name Description
Type interface

The interface to search for.

Returns
Type Description
Type[]

WithPrepareType(Type)

Creates a new MigrationPipelineContentType instance with the specified preparation type. Preperation type is post-pull, pre-conversion.

Declaration
public MigrationPipelineContentType WithPrepareType(Type prepareType)
Parameters
Type Name Description
Type prepareType

The preparation type.

Returns
Type Description
MigrationPipelineContentType

WithPrepareType<TPrepare>()

Creates a new MigrationPipelineContentType instance with the specified preparation type. Preperation type is post-pull, pre-conversion.

Declaration
public MigrationPipelineContentType WithPrepareType<TPrepare>()
Returns
Type Description
MigrationPipelineContentType
Type Parameters
Name Description
TPrepare

WithPublishType(Type)

Creates a new MigrationPipelineContentType instance with the specified publish type. Publish type is post-conversion, ready to publish.

Declaration
public MigrationPipelineContentType WithPublishType(Type publishType)
Parameters
Type Name Description
Type publishType

The publish type.

Returns
Type Description
MigrationPipelineContentType

WithPublishType<TPublish>()

Creates a new MigrationPipelineContentType instance with the specified publish type. Publish type is post-conversion, ready to publish.

Declaration
public MigrationPipelineContentType WithPublishType<TPublish>()
Returns
Type Description
MigrationPipelineContentType
Type Parameters
Name Description
TPublish

WithResultType(Type)

Creates a new MigrationPipelineContentType instance with the specified result type. Result type is post-publish.

Declaration
public MigrationPipelineContentType WithResultType(Type resultType)
Parameters
Type Name Description
Type resultType

The result type.

Returns
Type Description
MigrationPipelineContentType

WithResultType<TResult>()

Creates a new MigrationPipelineContentType instance with the specified result type. Result type is post-publish.

Declaration
public MigrationPipelineContentType WithResultType<TResult>()
Returns
Type Description
MigrationPipelineContentType
Type Parameters
Name Description
TResult

Implements

IEquatable<T>
In this article