Class TableauData

Object that represents data stored by a Tableau Server/Cloud site to be accessible to APIs through a TableauApiSimulator.

Inheritance

object

TableauData

Namespace: Tableau.Migration.Api.Simulation

Assembly: Tableau.Migration.dll

Syntax

public sealed class TableauData

Constructors

TableauData(UserType?, string)

Creates a new TableauData object.

Declaration

public TableauData(UsersResponse.UserType? defaultSignedInUser, string defaultDomain = "local")

Parameters

Type	Name	Description
UsersResponse.UserType	defaultSignedInUser
string	defaultDomain

Properties

AllUsersGroup

Gets or sets the "All Users" group.

Declaration

public GroupsResponse.GroupType AllUsersGroup { get; set; }

Property Value

Type	Description
GroupsResponse.GroupType

CloudExtractRefreshTasks

Gets or sets the Tableau Cloud extract refresh tasks.

Declaration

public ConcurrentSet<ExtractRefreshTasksResponse.TaskType> CloudExtractRefreshTasks { get; set; }

Property Value

Type	Description
ConcurrentSet<ExtractRefreshTasksResponse.TaskType>

CustomViewDefaultUsers

Gets or sets the custom view default users contents, by ID.

Declaration

public ConcurrentDictionary<Guid, List<UsersWithCustomViewAsDefaultViewResponse.UserType>> CustomViewDefaultUsers { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Guid, List<UsersWithCustomViewAsDefaultViewResponse.UserType>>

CustomViewFiles

Gets or sets the custom view fileData contents, by ID.

Declaration

public ConcurrentDictionary<Guid, byte[]> CustomViewFiles { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Guid, byte[]>

CustomViews

Gets or sets the custom views.

Declaration

public ConcurrentSet<CustomViewResponse.CustomViewType> CustomViews { get; set; }

Property Value

Type	Description
ConcurrentSet<CustomViewResponse.CustomViewType>

DataSourceFiles

Gets or sets the data source fileData contents, by ID.

Declaration

public ConcurrentDictionary<Guid, byte[]> DataSourceFiles { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Guid, byte[]>

DataSourcePermissions

Gets or sets the data source permissions.

Declaration

public ConcurrentDictionary<Guid, PermissionsType> DataSourcePermissions { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Guid, PermissionsType>

DataSources

Gets or sets the data sources.

Declaration

public ConcurrentSet<DataSourceResponse.DataSourceType> DataSources { get; set; }

Property Value

Type	Description
ConcurrentSet<DataSourceResponse.DataSourceType>

DefaultDomain

Gets the default domain of the site.

Declaration

public string DefaultDomain { get; set; }

Property Value

Type	Description
string

DefaultProject

Gets or sets the "Default" project.

Declaration

public ProjectsResponse.ProjectType DefaultProject { get; set; }

Property Value

Type	Description
ProjectsResponse.ProjectType

DefaultProjectPermissions

Gets or sets the project default permissions.

Declaration

public ConcurrentDictionary<Guid, IDictionary<string, PermissionsType>> DefaultProjectPermissions { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Guid, IDictionary<string, PermissionsType>>

Files

Gets or sets the uploaded files, by session Id.

Declaration

public ConcurrentDictionary<string, IEnumerable<byte>> Files { get; set; }

Property Value

Type	Description
ConcurrentDictionary<string, IEnumerable<byte>>

GroupUsers

Gets the users that belong to groups, by ID.

Declaration

public ConcurrentDictionary<Guid, ConcurrentSet<Guid>> GroupUsers { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Guid, ConcurrentSet<Guid>>

Groups

Gets or sets the groups.

Declaration

public ConcurrentSet<GroupsResponse.GroupType> Groups { get; set; }

Property Value

Type	Description
ConcurrentSet<GroupsResponse.GroupType>

IsTableauServer

Gets the flag indicating whether the current Tableau Data is for Tableau Server (true) or Tableau Cloud (false).

Declaration

public bool IsTableauServer { get; set; }

Property Value

Type	Description
bool

Jobs

Gets or sets the jobs.

Declaration

public ConcurrentSet<JobResponse.JobType> Jobs { get; set; }

Property Value

Type	Description
ConcurrentSet<JobResponse.JobType>

ProjectPermissions

Gets or sets the project permissions.

Declaration

public ConcurrentDictionary<Guid, PermissionsType> ProjectPermissions { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Guid, PermissionsType>

Projects

Gets or sets the projects.

Declaration

public ConcurrentSet<ProjectsResponse.ProjectType> Projects { get; set; }

Property Value

Type	Description
ConcurrentSet<ProjectsResponse.ProjectType>

ScheduleExtractRefreshTasks

Gets or sets the schedules extract refresh tasks.

Declaration

public ConcurrentSet<ScheduleExtractRefreshTasksResponse.ExtractType> ScheduleExtractRefreshTasks { get; set; }

Property Value

Type	Description
ConcurrentSet<ScheduleExtractRefreshTasksResponse.ExtractType>

ScheduleExtracts

Gets the extract refresh tasks that users belong to, by ID.

Declaration

public ConcurrentDictionary<Guid, ConcurrentSet<Guid>> ScheduleExtracts { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Guid, ConcurrentSet<Guid>>

Schedules

Gets or sets the schedules.

Declaration

public ConcurrentSet<ScheduleResponse.ScheduleType> Schedules { get; set; }

Property Value

Type	Description
ConcurrentSet<ScheduleResponse.ScheduleType>

ServerExtractRefreshTasks

Gets or sets the Tableau Server extract refresh tasks.

Declaration

public ConcurrentSet<ExtractRefreshTasksResponse.TaskType> ServerExtractRefreshTasks { get; set; }

Property Value

Type	Description
ConcurrentSet<ExtractRefreshTasksResponse.TaskType>

ServerInfo

Gets or sets the server information.

Declaration

public ServerInfoResponse.ServerInfoType ServerInfo { get; set; }

Property Value

Type	Description
ServerInfoResponse.ServerInfoType

SignIn

Gets or sets the sign in result.

Declaration

public SignInResponse.CredentialsType? SignIn { get; set; }

Property Value

Type	Description
SignInResponse.CredentialsType

Sites

Gets or sets the sites.

Declaration

public ConcurrentSet<SiteResponse.SiteType> Sites { get; set; }

Property Value

Type	Description
ConcurrentSet<SiteResponse.SiteType>

UserGroups

Gets the groups that users belong to, by ID.

Declaration

public ConcurrentDictionary<Guid, ConcurrentSet<Guid>> UserGroups { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Guid, ConcurrentSet<Guid>>

UserImportJobs

Gets or sets the jobs.

Declaration

public ConcurrentSet<ImportJobResponse.ImportJobType> UserImportJobs { get; set; }

Property Value

Type	Description
ConcurrentSet<ImportJobResponse.ImportJobType>

Users

Gets or sets the users.

Declaration

public ConcurrentSet<UsersResponse.UserType> Users { get; set; }

Property Value

Type	Description
ConcurrentSet<UsersResponse.UserType>

ViewPermissions

Gets or sets the view permissions.

Declaration

public ConcurrentDictionary<Guid, PermissionsType> ViewPermissions { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Guid, PermissionsType>

Views

Gets or sets the users.

Declaration

public ConcurrentSet<WorkbookResponse.WorkbookType.ViewReferenceType> Views { get; set; }

Property Value

Type	Description
ConcurrentSet<WorkbookResponse.WorkbookType.ViewReferenceType>

WorkbookFiles

Gets or sets the workbook fileData contents, by ID.

Declaration

public ConcurrentDictionary<Guid, byte[]> WorkbookFiles { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Guid, byte[]>

WorkbookPermissions

Gets or sets the workbook permissions.

Declaration

public ConcurrentDictionary<Guid, PermissionsType> WorkbookPermissions { get; set; }

Property Value

Type	Description
ConcurrentDictionary<Guid, PermissionsType>

Workbooks

Gets or sets the workbooks.

Declaration

public ConcurrentSet<WorkbookResponse.WorkbookType> Workbooks { get; set; }

Property Value

Type	Description
ConcurrentSet<WorkbookResponse.WorkbookType>

Methods

AddExtractToSchedule(ExtractType, ScheduleType)

Add a schedule extract refresh task to a schedule.

Declaration

public void AddExtractToSchedule(ScheduleExtractRefreshTasksResponse.ExtractType extract, ScheduleResponse.ScheduleType schedule)

Parameters

Type	Name	Description
ScheduleExtractRefreshTasksResponse.ExtractType	extract	The schedule extract refresh task.
ScheduleResponse.ScheduleType	schedule	The schedule.

AddGroup(GroupType)

Adds a group.

Declaration

public void AddGroup(GroupsResponse.GroupType group)

Parameters

Type	Name	Description
GroupsResponse.GroupType	group	The group to add.

AddJob(JobType)

Adds a job.

Declaration

public void AddJob(JobResponse.JobType job)

Parameters

Type	Name	Description
JobResponse.JobType	job	The job to add.

AddProject(ProjectType, ProjectType?, bool)

Adds a project.

Declaration

public ProjectsResponse.ProjectType AddProject(ProjectsResponse.ProjectType project, ProjectsResponse.ProjectType? parentProject = null, bool useSignInOwner = false)

Parameters

Type	Name	Description
ProjectsResponse.ProjectType	project	The project to add.
ProjectsResponse.ProjectType	parentProject	A parent project to add and link the project to.
bool	useSignInOwner	Whether or not to assign the signed in user as the owner of the project.

Returns

Type	Description
ProjectsResponse.ProjectType

AddSchedule(ScheduleType)

Adds a schedule.

Declaration

public ScheduleResponse.ScheduleType AddSchedule(ScheduleResponse.ScheduleType schedule)

Parameters

Type	Name	Description
ScheduleResponse.ScheduleType	schedule	The schedule to add.

Returns

Type	Description
ScheduleResponse.ScheduleType

AddUser(UserType)

Adds an user.

Declaration

public UsersResponse.UserType AddUser(UsersResponse.UserType user)

Parameters

Type	Name	Description
UsersResponse.UserType	user	The user to add.

Returns

Type	Description
UsersResponse.UserType

AddUserToGroup(Guid, Guid)

Adds a user to a group.

Declaration

public void AddUserToGroup(Guid userId, Guid groupId)

Parameters

Type	Name	Description
Guid	userId	The user ID.
Guid	groupId	The group ID.

AddUserToGroup(UserType, GroupType)

Adds a user to a group.

Declaration

public void AddUserToGroup(UsersResponse.UserType user, GroupsResponse.GroupType group)

Parameters

Type	Name	Description
UsersResponse.UserType	user	The user.
GroupsResponse.GroupType	group	The group.

RemoveUserFromGroup(Guid, Guid)

Removes a user from a group.

Declaration

public void RemoveUserFromGroup(Guid userId, Guid groupId)

Parameters

Type	Name	Description
Guid	userId	The user ID.
Guid	groupId	The group ID.