Class: DatadogAPIClient::V2::DatasetReportScheduleResponseAttributes

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb

Overview

The configuration and derived state of a report schedule for a published dataset.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



71
72
73
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 71

def additional_properties
  @additional_properties
end

#cell_id ⇒ Object

The identifier of the notebook cell that published the dataset, or null if not set.



25
26
27
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 25

def cell_id
  @cell_id
end

#dataset_id ⇒ Object

The identifier of the dataset, or null if not set.



28
29
30
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 28

def dataset_id
  @dataset_id
end

#description ⇒ Object

The description of the report.



31
32
33
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 31

def description
  @description
end

#file_row_limit ⇒ Object

The maximum number of rows included in the attached CSV file, or null if not set.



34
35
36
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 34

def file_row_limit
  @file_row_limit
end

#inline_row_limit ⇒ Object

The maximum number of rows included inline in the email body, or null if not set.



37
38
39
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 37

def inline_row_limit
  @inline_row_limit
end

#next_recurrence ⇒ Object

The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.



41
42
43
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 41

def next_recurrence
  @next_recurrence
end

#notebook_id ⇒ Object

The identifier of the notebook containing the dataset cell, or null if not set.



44
45
46
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 44

def notebook_id
  @notebook_id
end

#recipients ⇒ Object

The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).



48
49
50
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 48

def recipients
  @recipients
end

#resource_id ⇒ Object

The identifier of the widget containing the dataset.



51
52
53
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 51

def resource_id
  @resource_id
end

#resource_type ⇒ Object

The type of resource targeted by a dataset report schedule.



54
55
56
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 54

def resource_type
  @resource_type
end

#rrule ⇒ Object

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.



57
58
59
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 57

def rrule
  @rrule
end

#status ⇒ Object

Whether the schedule is currently delivering reports (active) or paused (inactive).



60
61
62
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 60

def status
  @status
end

#timeframe ⇒ Object

The relative timeframe of data included in the report.



63
64
65
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 63

def timeframe
  @timeframe
end

#timezone ⇒ Object

The IANA time zone identifier the recurrence rule is evaluated in.



66
67
68
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 66

def timezone
  @timezone
end

#title ⇒ Object

The title of the report.



69
70
71
 
# File 'lib/datadog_api_client/v2/models/dataset_report_schedule_response_attributes.rb', line 69

def title
  @title
end