8000 docs: docstrings for group endpoint and item by jorwoods · Pull Request #1499 · tableau/server-client-python · GitHub
[go: up one dir, main page]
Skip to content

docs: docstrings for group endpoint and item #1499

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 3, 2025
Merged

docs: docstrings for group endpoint and item #1499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 40 additions & 0 deletions tableauserverclient/models/group_item.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,46 @@


class GroupItem:
"""
The GroupItem class contains the attributes for the group resources on
Tableau Server. The GroupItem class defines the information you can request
or query from Tableau Server. The class members correspond to the attributes
of a server request or response payload.

Parameters
----------
name: str
The name of the group.

domain_name: str
The name of the Active Directory domain ("local" if local authentication is used).

Properties
----------
users: Pager[UserItem]
The users in the group. Must be populated with a call to `populate_users()`.

id: str
The unique identifier for the group.

minimum_site_role: str
The minimum site role for users in the group. Use the `UserItem.Roles` enum.
Users in the group cannot have their site role set lower than this value.

license_mode: str
The mode defining when to apply licenses for group members. When the
mode is onLogin, a license is granted for each group member when they
login to a site. When the mode is onSync, a license is granted for group
members each time the domain is synced.

Examples
--------
>>> # Create a new group item
>>> newgroup = TSC.GroupItem('My Group')


"""

tag_name: str = "group"

class LicenseMode:
Expand Down
Loading
Loading
0