|
7 | 7 | from defusedxml.ElementTree import fromstring
|
8 | 8 |
|
9 | 9 | from tableauserverclient.datetime_helpers import parse_datetime
|
10 |
| -from .exceptions import UnpopulatedPropertyError |
11 |
| -from .permissions_item import PermissionsRule |
12 |
| -from .tag_item import TagItem |
| 10 | +from tableauserverclient.models.exceptions import UnpopulatedPropertyError |
| 11 | +from tableauserverclient.models.permissions_item import PermissionsRule |
| 12 | +from tableauserverclient.models.tag_item import TagItem |
13 | 13 |
|
14 | 14 |
|
15 | 15 | class ViewItem:
|
| 16 | + """ |
| 17 | + Contains the members or attributes for the view resources on Tableau Server. |
| 18 | + The ViewItem class defines the information you can request or query from |
| 19 | + Tableau Server. The class members correspond to the attributes of a server |
| 20 | + request or response payload. |
| 21 | +
|
| 22 | + Attributes |
| 23 | + ---------- |
| 24 | + content_url: Optional[str], default None |
| 25 | + The name of the view as it would appear in a URL. |
| 26 | +
|
| 27 | + created_at: Optional[datetime], default None |
| 28 | + The date and time when the view was created. |
| 29 | +
|
| 30 | + id: Optional[str], default None |
| 31 | + The unique identifier for the view. |
| 32 | +
|
| 33 | + image: Optional[Callable[[], bytes]], default None |
| 34 | + The image of the view. You must first call the `views.populate_image` |
| 35 | + method to access the image. |
| 36 | +
|
| 37 | + name: Optional[str], default None |
| 38 | + The name of the view. |
| 39 | +
|
| 40 | + owner_id: Optional[str], default None |
| 41 | + The ID for the owner of the view. |
| 42 | +
|
| 43 | + pdf: Optional[Callable[[], bytes]], default None |
| 44 | + The PDF of the view. You must first call the `views.populate_pdf` |
| 45 | + method to access the PDF. |
| 46 | +
|
| 47 | + preview_image: Optional[Callable[[], bytes]], default None |
| 48 | + The preview image of the view. You must first call the |
| 49 | + `views.populate_preview_image` method to access the preview image. |
| 50 | +
|
| 51 | + project_id: Optional[str], default None |
| 52 | + The ID for the project that contains the view. |
| 53 | +
|
| 54 | + tags: set[str], default set() |
| 55 | + The tags associated with the view. |
| 56 | +
|
| 57 | + total_views: Optional[int], default None |
| 58 | + The total number of views for the view. |
| 59 | +
|
| 60 | + updated_at: Optional[datetime], default None |
| 61 | + The date and time when the view was last updated. |
| 62 | +
|
| 63 | + workbook_id: Optional[str], default None |
| 64 | + The ID for the workbook that contains the view. |
| 65 | +
|
| 66 | + """ |
| 67 | + |
16 | 68 | def __init__(self) -> None:
|
17 | 69 | self._content_url: Optional[str] = None
|
18 | 70 | self._created_at: Optional[datetime] = None
|
|
0 commit comments