Skip to content

Latest commit

 

History

History
47 lines (43 loc) · 4.12 KB

ScheduledPlan.md

File metadata and controls

47 lines (43 loc) · 4.12 KB

ScheduledPlan

Properties

Name Type Description Notes
name string Name of this scheduled plan [optional]
user_id string User Id which owns this scheduled plan [optional]
run_as_recipient bool Whether schedule is run as recipient (only applicable for email recipients) [optional]
enabled bool Whether the ScheduledPlan is enabled [optional]
look_id string Id of a look [optional]
dashboard_id string Id of a dashboard [optional]
lookml_dashboard_id string Id of a LookML dashboard [optional]
filters_string string Query string to run look or dashboard with [optional]
dashboard_filters string (DEPRECATED) Alias for filters_string field [optional]
require_results bool Delivery should occur if running the dashboard or look returns results [optional]
require_no_results bool Delivery should occur if the dashboard look does not return results [optional]
require_change bool Delivery should occur if data have changed since the last run [optional]
send_all_results bool Will run an unlimited query and send all results. [optional]
crontab string Vixie-Style crontab specification when to run [optional]
datagroup string Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string) [optional]
timezone string Timezone for interpreting the specified crontab (default is Looker instance timezone) [optional]
query_id string Query id [optional]
scheduled_plan_destination \Swagger\Client\Model\ScheduledPlanDestination[] Scheduled plan destinations [optional]
run_once bool Whether the plan in question should only be run once (usually for testing) [optional]
include_links bool Whether links back to Looker should be included in this ScheduledPlan [optional]
custom_url_base string Custom url domain for the scheduled entity [optional]
custom_url_params string Custom url path and parameters for the scheduled entity [optional]
custom_url_label string Custom url label for the scheduled entity [optional]
show_custom_url bool Whether to show custom link back instead of standard looker link [optional]
pdf_paper_size string The size of paper the PDF should be formatted to fit. Valid values are: "letter", "legal", "tabloid", "a0", "a1", "a2", "a3", "a4", "a5". [optional]
pdf_landscape bool Whether the PDF should be formatted for landscape orientation [optional]
embed bool Whether this schedule is in an embed context or not [optional]
color_theme string Color scheme of the dashboard if applicable [optional]
long_tables bool Whether or not to expand table vis to full length [optional]
inline_table_width int The pixel width at which we render the inline table visualizations [optional]
id string Unique Id [optional]
created_at \DateTime Date and time when ScheduledPlan was created [optional]
updated_at \DateTime Date and time when ScheduledPlan was last updated [optional]
title string Title [optional]
user \Swagger\Client\Model\UserPublic User who owns this ScheduledPlan [optional]
next_run_at \DateTime When the ScheduledPlan will next run (null if running once) [optional]
last_run_at \DateTime When the ScheduledPlan was last run [optional]
can map[string,bool] Operations the current user is able to perform on this object [optional]

[Back to Model list] [Back to API list] [Back to README]