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

add subscriptions sample #1487

Open
wants to merge 24 commits into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
4a3d9a9
add subscriptions sample
jacalata Oct 4, 2024
b49eac5
feat(exceptions): separate failed signin error (#1478)
jorwoods Oct 10, 2024
9495fe8
docs: add docstrings to auth objects and endpoints (#1484)
jorwoods Oct 10, 2024
0af5512
Set FILESIZE_LIMIT_MB via environment variables (#1466)
Der-Henning Oct 10, 2024
c6dabdd
added PulseMetricDefine cap (#1490)
AlbertWangXu Oct 10, 2024
0efd735
Adding project permissions handling for databases, tables and virtual…
TrimPeachu Oct 10, 2024
f8728b2
docs: docstrings for Server and ServerInfo (#1494)
jorwoods Oct 11, 2024
89e1ddf
refactor request_options, add language param (#1481)
jacalata Oct 11, 2024
1b64987
docs: docstrings for user item and endpoint (#1485)
jorwoods Oct 11, 2024
9b1b940
ci: build on python 3.13 (#1492)
jorwoods Oct 14, 2024
d880d52
docs: workbook docstrings (#1488)
jorwoods Oct 15, 2024
9f59af1
chore: type hint default permissions endpoints (#1493)
jorwoods Oct 15, 2024
2ff9697
fix: handle 0 item response in querysets (#1501)
jorwoods Oct 17, 2024
e623511
ci: cache dependencies for faster builds (#1497)
jorwoods Oct 17, 2024
c361f8f
Feature: export custom views #999 (#1506)
renoyjohnm Oct 22, 2024
607fa8b
chore: remove py2 holdover code (#1496)
jorwoods Oct 22, 2024
60dfd4d
Update samples for Python 3.x compatibility (#1479)
bcantoni Oct 22, 2024
63ece82
chore: support VizqlDataApiAccess capability (#1504)
jorwoods Oct 22, 2024
b65d8d4
Remove sample code showing group name encoding (#1486)
jacalata Oct 23, 2024
3e38372
Update requests library for CVE CVE-2024-35195 (#1507)
jacalata Oct 23, 2024
878d593
docs: docstrings for site item and endpoint (#1495)
jorwoods Oct 23, 2024
c3ea910
Bring development and master into sync (#1509)
jacalata Oct 23, 2024
7195902
add subscriptions sample
jacalata Oct 4, 2024
7a36873
Merge branch 'jac/subscription-sample' of github.com:tableau/server-c…
jacalata Oct 30, 2024
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
Prev Previous commit
Next Next commit
docs: docstrings for site item and endpoint (#1495)
Co-authored-by: Jordan Woods <[email protected]>
  • Loading branch information
jorwoods and jorwoods authored Oct 23, 2024
commit 878d5934759939a9bd79689c2b8c3c7a1cee024f
66 changes: 66 additions & 0 deletions tableauserverclient/models/site_item.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,72 @@


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

Attributes
----------
name: str
The name of the site. The name of the default site is "".

content_url: str
The path to the site.

admin_mode: str
(Optional) For Tableau Server only. Specify ContentAndUsers to allow
site administrators to use the server interface and tabcmd commands to
add and remove users. (Specifying this option does not give site
administrators permissions to manage users using the REST API.) Specify
ContentOnly to prevent site administrators from adding or removing
users. (Server administrators can always add or remove users.)

user_quota: int
(Optional) Specifies the total number of users for the site. The number
can't exceed the number of licenses activated for the site; and if
tiered capacity attributes are set, then user_quota will equal the sum
of the tiered capacity values, and attempting to set user_quota will
cause an error.

tier_explorer_capacity: int
tier_creator_capacity: int
tier_viewer_capacity: int
(Optional) The maximum number of licenses for users with the Creator,
Explorer, or Viewer role, respectively, allowed on a site.

storage_quota: int
(Optional) Specifies the maximum amount of space for the new site, in
megabytes. If you set a quota and the site exceeds it, publishers will
be prevented from uploading new content until the site is under the
limit again.

disable_subscriptions: bool
(Optional) Specify true to prevent users from being able to subscribe
to workbooks on the specified site. The default is False.

subscribe_others_enabled: bool
(Optional) Specify false to prevent server administrators, site
administrators, and project or content owners from being able to
subscribe other users to workbooks on the specified site. The default
is True.

revision_history_enabled: bool
(Optional) Specify true to enable revision history for content resources
(workbooks and datasources). The default is False.

revision_limit: int
(Optional) Specifies the number of revisions of a content source
(workbook or data source) to allow. On Tableau Server, the default is
25.

state: str
Shows the current state of the site (Active or Suspended).

"""

_user_quota: Optional[int] = None
_tier_creator_capacity: Optional[int] = None
_tier_explorer_capacity: Optional[int] = None
Expand Down
Loading
Loading