|
21 | 21 |
|
22 | 22 |
|
23 | 23 | class SiteItem:
|
| 24 | + """ |
| 25 | + The SiteItem class contains the members or attributes for the site resources |
| 26 | + on Tableau Server or Tableau Cloud. The SiteItem class defines the |
| 27 | + information you can request or query from Tableau Server or Tableau Cloud. |
| 28 | + The class members correspond to the attributes of a server request or |
| 29 | + response payload. |
| 30 | +
|
| 31 | + Attributes |
| 32 | + ---------- |
| 33 | + name: str |
| 34 | + The name of the site. The name of the default site is "". |
| 35 | +
|
| 36 | + content_url: str |
| 37 | + The path to the site. |
| 38 | +
|
| 39 | + admin_mode: str |
| 40 | + (Optional) For Tableau Server only. Specify ContentAndUsers to allow |
| 41 | + site administrators to use the server interface and tabcmd commands to |
| 42 | + add and remove users. (Specifying this option does not give site |
| 43 | + administrators permissions to manage users using the REST API.) Specify |
| 44 | + ContentOnly to prevent site administrators from adding or removing |
| 45 | + users. (Server administrators can always add or remove users.) |
| 46 | +
|
| 47 | + user_quota: int |
| 48 | + (Optional) Specifies the total number of users for the site. The number |
| 49 | + can't exceed the number of licenses activated for the site; and if |
| 50 | + tiered capacity attributes are set, then user_quota will equal the sum |
| 51 | + of the tiered capacity values, and attempting to set user_quota will |
| 52 | + cause an error. |
| 53 | +
|
| 54 | + tier_explorer_capacity: int |
| 55 | + tier_creator_capacity: int |
| 56 | + tier_viewer_capacity: int |
| 57 | + (Optional) The maximum number of licenses for users with the Creator, |
| 58 | + Explorer, or Viewer role, respectively, allowed on a site. |
| 59 | +
|
| 60 | + storage_quota: int |
| 61 | + (Optional) Specifies the maximum amount of space for the new site, in |
| 62 | + megabytes. If you set a quota and the site exceeds it, publishers will |
| 63 | + be prevented from uploading new content until the site is under the |
| 64 | + limit again. |
| 65 | +
|
| 66 | + disable_subscriptions: bool |
| 67 | + (Optional) Specify true to prevent users from being able to subscribe |
| 68 | + to workbooks on the specified site. The default is False. |
| 69 | +
|
| 70 | + subscribe_others_enabled: bool |
| 71 | + (Optional) Specify false to prevent server administrators, site |
| 72 | + administrators, and project or content owners from being able to |
| 73 | + subscribe other users to workbooks on the specified site. The default |
| 74 | + is True. |
| 75 | +
|
| 76 | + revision_history_enabled: bool |
| 77 | + (Optional) Specify true to enable revision history for content resources |
| 78 | + (workbooks and datasources). The default is False. |
| 79 | +
|
| 80 | + revision_limit: int |
| 81 | + (Optional) Specifies the number of revisions of a content source |
| 82 | + (workbook or data source) to allow. On Tableau Server, the default is |
| 83 | + 25. |
| 84 | +
|
| 85 | + state: str |
| 86 | + Shows the current state of the site (Active or Suspended). |
| 87 | +
|
| 88 | + """ |
| 89 | + |
24 | 90 | _user_quota: Optional[int] = None
|
25 | 91 | _tier_creator_capacity: Optional[int] = None
|
26 | 92 | _tier_explorer_capacity: Optional[int] = None
|
|
0 commit comments