C# Class TableauServerUrls, TabMigrate

Creates the set of server specific URLs

Inheritance: ITableauServerSiteInfo

Datei anzeigen Open project: tableau/TabMigrate Class Usage Examples

Public Properties

Property	Type	Description
PageSize	int
ServerName	string
ServerProtocol	string
ServerUrlWithProtocol	string
SiteUrlSegement	string
UrlLogin	string
UrlLogout	string

Private Properties

Property	Type	Description
GetProtocolFromUrl	string
Url_DatasourceConnectionsList	string
ValidateTemplateReplaceComplete	bool

Public Methods

Method	Description
FromContentUrl ( string userContentUrl, int pageSize ) : TableauServerUrls,	Parse out the server-user and site name from the content URL
TableauServerUrls ( string protocol, string serverName, string siteUrlSegment, int pageSize, ServerVersion serverVersion ) : System	Constructor
Url_AppendFileUploadChunk ( TableauServerSignIn, logInInfo, string uploadSession ) : string	The URL to start a upload
Url_CreateProject ( TableauServerSignIn, session ) : string	URL for creating a project
Url_DatasourceDownload ( TableauServerSignIn, session, SiteDatasource, contentInfo ) : string	URL to download a datasource
Url_DatasourcesList ( TableauServerSignIn, session, int pageSize, int pageNumber = 1 ) : string	URL for the Datasources list
Url_DeleteDatasourceTag ( TableauServerSignIn, session, string datasourceId, string tagText ) : string	URL for deleting a tag from a datasource
Url_DeleteWorkbookTag ( TableauServerSignIn, session, string workbookId, string tagText ) : string	URL for deleting a tag from a workbook
Url_FinalizeDataSourcePublish ( TableauServerSignIn, logInInfo, string uploadSession, string datasourceType ) : string	URL to finish publishing a datasource
Url_FinalizeWorkbookPublish ( TableauServerSignIn, logInInfo, string uploadSession, string workbookType ) : string	URL to finish publishing a datasource
Url_GroupsList ( TableauServerSignIn, session, int pageSize, int pageNumber = 1 ) : string	URL for the Groups list
Url_InitiateFileUpload ( TableauServerSignIn, logInInfo ) : string	The URL to start na upload
Url_ProjectsList ( TableauServerSignIn, session, int pageSize, int pageNumber = 1 ) : string	URL for the Projects list
Url_SiteInfo ( TableauServerSignIn, logInInfo ) : string	The URL to get site info
Url_UpdateDatasource ( TableauServerSignIn, session, string datasourceId ) : string	URL for updating datasource metadata (e.g. owner id)
Url_UpdateWorkbook ( TableauServerSignIn, session, string workbookId ) : string	URL for updating workbook metadata (e.g. owners, show tabs)
Url_UsersList ( TableauServerSignIn, logInInfo, int pageSize, int pageNumber = 1 ) : string	URL for the Users list
Url_UsersListInGroup ( TableauServerSignIn, logInInfo, string groupId, int pageSize, int pageNumber = 1 ) : string	URL to get the list of Users in a Group
Url_WorkbookConnectionsList ( TableauServerSignIn, session, string workbookId ) : string	URL for the Workbook's data source connections list
Url_WorkbookDownload ( TableauServerSignIn, session, SiteWorkbook, contentInfo ) : string	URL to download a workbook
Url_WorkbooksListForUser ( TableauServerSignIn, session, string userId, int pageSize, int pageNumber = 1 ) : string	URL for the Workbooks list

Private Methods

Method	Description
GetProtocolFromUrl ( string url ) : string
Url_DatasourceConnectionsList ( TableauServerSignIn, session, string datasourceId ) : string	URL for a Datasource's connections list
ValidateTemplateReplaceComplete ( string str ) : bool

Method Details

FromContentUrl() public static method

Parse out the server-user and site name from the content URL

public static FromContentUrl ( string userContentUrl, int pageSize ) : TableauServerUrls,
userContentUrl	string	e.g. https://online.tableausoftware.com/t/tableausupport/workbooks
pageSize	int
return	TableauServerUrls,

TableauServerUrls() public method

Constructor

public TableauServerUrls ( string protocol, string serverName, string siteUrlSegment, int pageSize, ServerVersion serverVersion ) : System
protocol	string
serverName	string
siteUrlSegment	string
pageSize	int
serverVersion	ServerVersion
return	System

Url_AppendFileUploadChunk() public method

The URL to start a upload

public Url_AppendFileUploadChunk ( TableauServerSignIn, logInInfo, string uploadSession ) : string
logInInfo	TableauServerSignIn,
uploadSession	string
return	string

Url_CreateProject() public method

URL for creating a project

public Url_CreateProject ( TableauServerSignIn, session ) : string
session	TableauServerSignIn,
return	string

Url_DatasourceDownload() public method

URL to download a datasource

public Url_DatasourceDownload ( TableauServerSignIn, session, SiteDatasource, contentInfo ) : string
session	TableauServerSignIn,
contentInfo	SiteDatasource,
return	string

Url_DatasourcesList() public method

URL for the Datasources list

public Url_DatasourcesList ( TableauServerSignIn, session, int pageSize, int pageNumber = 1 ) : string
session	TableauServerSignIn,
pageSize	int
pageNumber	int
return	string

Url_DeleteDatasourceTag() public method

URL for deleting a tag from a datasource

public Url_DeleteDatasourceTag ( TableauServerSignIn, session, string datasourceId, string tagText ) : string
session	TableauServerSignIn,
datasourceId	string
tagText	string	Tag we want to delete
return	string

Url_DeleteWorkbookTag() public method

URL for deleting a tag from a workbook

public Url_DeleteWorkbookTag ( TableauServerSignIn, session, string workbookId, string tagText ) : string
session	TableauServerSignIn,
workbookId	string
tagText	string	Tag we want to delete
return	string

Url_FinalizeDataSourcePublish() public method

URL to finish publishing a datasource

public Url_FinalizeDataSourcePublish ( TableauServerSignIn, logInInfo, string uploadSession, string datasourceType ) : string
logInInfo	TableauServerSignIn,
uploadSession	string
datasourceType	string
return	string

Url_FinalizeWorkbookPublish() public method

URL to finish publishing a datasource

public Url_FinalizeWorkbookPublish ( TableauServerSignIn, logInInfo, string uploadSession, string workbookType ) : string
logInInfo	TableauServerSignIn,
uploadSession	string
workbookType	string
return	string

Url_GroupsList() public method

URL for the Groups list

public Url_GroupsList ( TableauServerSignIn, session, int pageSize, int pageNumber = 1 ) : string
session	TableauServerSignIn,
pageSize	int
pageNumber	int
return	string

Url_InitiateFileUpload() public method

The URL to start na upload

public Url_InitiateFileUpload ( TableauServerSignIn, logInInfo ) : string
logInInfo	TableauServerSignIn,
return	string

Url_ProjectsList() public method

URL for the Projects list

public Url_ProjectsList ( TableauServerSignIn, session, int pageSize, int pageNumber = 1 ) : string
session	TableauServerSignIn,
pageSize	int
pageNumber	int
return	string

Url_SiteInfo() public method

The URL to get site info

public Url_SiteInfo ( TableauServerSignIn, logInInfo ) : string
logInInfo	TableauServerSignIn,
return	string

Url_UpdateDatasource() public method

URL for updating datasource metadata (e.g. owner id)

public Url_UpdateDatasource ( TableauServerSignIn, session, string datasourceId ) : string
session	TableauServerSignIn,
datasourceId	string
return	string

Url_UpdateWorkbook() public method

URL for updating workbook metadata (e.g. owners, show tabs)

public Url_UpdateWorkbook ( TableauServerSignIn, session, string workbookId ) : string
session	TableauServerSignIn,
workbookId	string
return	string

Url_UsersList() public method

URL for the Users list

public Url_UsersList ( TableauServerSignIn, logInInfo, int pageSize, int pageNumber = 1 ) : string
logInInfo	TableauServerSignIn,
pageSize	int
pageNumber	int
return	string

Url_UsersListInGroup() public method

URL to get the list of Users in a Group

public Url_UsersListInGroup ( TableauServerSignIn, logInInfo, string groupId, int pageSize, int pageNumber = 1 ) : string
logInInfo	TableauServerSignIn,
groupId	string
pageSize	int
pageNumber	int
return	string

Url_WorkbookConnectionsList() public method

URL for the Workbook's data source connections list

public Url_WorkbookConnectionsList ( TableauServerSignIn, session, string workbookId ) : string
session	TableauServerSignIn,
workbookId	string
return	string

Url_WorkbookDownload() public method

URL to download a workbook

public Url_WorkbookDownload ( TableauServerSignIn, session, SiteWorkbook, contentInfo ) : string
session	TableauServerSignIn,
contentInfo	SiteWorkbook,
return	string

Url_WorkbooksListForUser() public method

URL for the Workbooks list

public Url_WorkbooksListForUser ( TableauServerSignIn, session, string userId, int pageSize, int pageNumber = 1 ) : string
session	TableauServerSignIn,
userId	string
pageSize	int
pageNumber	int
return	string

Property Details

PageSize public_oe property

public int PageSize
return	int

ServerName public_oe property

public string ServerName
return	string

ServerProtocol public_oe property

public string ServerProtocol
return	string

ServerUrlWithProtocol public_oe property

Server url with protocol

public string ServerUrlWithProtocol
return	string

SiteUrlSegement public_oe property

Part of the URL that designates the site id

public string SiteUrlSegement
return	string

UrlLogin public_oe property

Url for API login

public string UrlLogin
return	string

UrlLogout public_oe property

Url for log out

public string UrlLogout
return	string