8000 docs: project docstrings (#1505) · tableau/server-client-python@f9341a4 · GitHub
[go: up one dir, main page]

Skip to content

Commit f9341a4

Browse files
authored
docs: project docstrings (#1505)
* docs: project docstrings * docs: add REST API links
1 parent 55d592a commit f9341a4

File tree

2 files changed

+638
-0
lines changed

2 files changed

+638
-0
lines changed

tableauserverclient/models/project_item.py

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,44 @@
99

1010

1111
class ProjectItem:
12+
"""
13+
The project resources for Tableau are defined in the ProjectItem class. The
14+
class corresponds to the project resources you can access using the Tableau
15+
Server REST API.
16+
17+
Parameters
18+
----------
19+
name : str
20+
Name of the project.
21+
22+
description : str
23+
Description of the project.
24+
25+
content_permissions : str
26+
Sets or shows the permissions for the content in the project. The
27+
options are either LockedToProject, ManagedByOwner or
28+
LockedToProjectWithoutNested.
29+
30+
parent_id : str
31+
The id of the parent project. Use this option to create project
32+
hierarchies. For information about managing projects, project
33+
hierarchies, and permissions, see
34+
https://help.tableau.com/current/server/en-us/projects.htm
35+
36+
samples : bool
37+
Set to True to include sample workbooks and data sources in the
38+
project. The default is False.
39+
40+
Attributes
41+
----------
42+
id : str
43+
The unique identifier for the project.
44+
45+
owner_id : str
46+
The unique identifier for the UserItem owner of the project.
47+
48+
"""
49+
1250
ERROR_MSG = "Project item must be populated with permissions first."
1351

1452
class ContentPermissions:

0 commit comments

Comments
 (0)
0