Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: project docstrings #1505

Merged
merged 2 commits into from
Jan 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions tableauserverclient/models/project_item.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,44 @@


class ProjectItem:
"""
The project resources for Tableau are defined in the ProjectItem class. The
class corresponds to the project resources you can access using the Tableau
Server REST API.

Parameters
----------
name : str
Name of the project.

description : str
Description of the project.

content_permissions : str
Sets or shows the permissions for the content in the project. The
options are either LockedToProject, ManagedByOwner or
LockedToProjectWithoutNested.

parent_id : str
The id of the parent project. Use this option to create project
hierarchies. For information about managing projects, project
hierarchies, and permissions, see
https://help.tableau.com/current/server/en-us/projects.htm

samples : bool
Set to True to include sample workbooks and data sources in the
project. The default is False.

Attributes
----------
id : str
The unique identifier for the project.

owner_id : str
The unique identifier for the UserItem owner of the project.

"""

ERROR_MSG = "Project item must be populated with permissions first."

class ContentPermissions:
Expand Down
Loading
Loading