mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2026-09-19 08:03:56 +00:00
f9d21e46b5
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
41 lines
2.3 KiB
Markdown
41 lines
2.3 KiB
Markdown
# DashboardSchedule
|
|
|
|
Snapshot schedule for a dashboard. A `repeat` value of `NONE` represents a one-time schedule.
|
|
|
|
## Properties
|
|
|
|
Name | Type | Description | Notes
|
|
------------ | ------------- | ------------- | -------------
|
|
**cron_spec** | [**DashboardScheduleCronSpec**](DashboardScheduleCronSpec.md) | |
|
|
**data_source** | [**DashboardScheduleDataSource**](DashboardScheduleDataSource.md) | |
|
|
**data_timespan** | [**DashboardScheduleTimespan**](DashboardScheduleTimespan.md) | |
|
|
**flag_enabled** | **bool** | When `true`, the schedule is active and snapshots are generated according to `cronSpec`. |
|
|
**flag_locked** | **bool** | When `true`, the schedule configuration is locked and cannot be edited through the web application. | [optional]
|
|
**flag_auto_share** | **bool** | When `true`, generated snapshots are automatically shared with schedule recipients. | [optional]
|
|
**flag_is_include_pii_user_data** | **bool** | When `true`, generated snapshots include personally identifiable user data when permitted by account policy. | [optional]
|
|
**flag_attach_pdf_to_email** | **bool** | When `true`, a PDF attachment is included in snapshot notification emails. | [optional]
|
|
**recipients** | **List[str]** | Email addresses of active dashboard account users who receive snapshot notifications. | [optional]
|
|
**expires_after** | **int** | Snapshot retention period in seconds. Allowed range is 24 hours to 5 years. | [optional]
|
|
**next_date** | **datetime** | UTC date of the next scheduled snapshot run. Computed by the server. | [optional] [readonly]
|
|
|
|
## Example
|
|
|
|
```python
|
|
from thousandeyes_sdk.dashboards.models.dashboard_schedule import DashboardSchedule
|
|
|
|
# TODO update the JSON string below
|
|
json = "{}"
|
|
# create an instance of DashboardSchedule from a JSON string
|
|
dashboard_schedule_instance = DashboardSchedule.from_json(json)
|
|
# print the JSON string representation of the object
|
|
print(DashboardSchedule.to_json())
|
|
|
|
# convert the object into a dict
|
|
dashboard_schedule_dict = dashboard_schedule_instance.to_dict()
|
|
# create an instance of DashboardSchedule from a dict
|
|
dashboard_schedule_from_dict = DashboardSchedule.from_dict(dashboard_schedule_dict)
|
|
```
|
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
|
|
|