Class: DatadogAPIClient::V2::ReportScheduleResponseAttributes

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

Overview

The configuration and derived state of a report schedule.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_propertiesObject

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#delivery_formatObject

The delivery format for dashboard report schedules, or null if not set.



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

def delivery_format
  @delivery_format
end

#descriptionObject

The description of the report.



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

def description
  @description
end

#next_recurrenceObject

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



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

def next_recurrence
  @next_recurrence
end

#recipientsObject

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



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

def recipients
  @recipients
end

#resource_idObject

The identifier of the resource rendered in the report.



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

def resource_id
  @resource_id
end

#resource_typeObject

The type of dashboard resource the report schedule targets.



40
41
42
# File 'lib/datadog_api_client/v2/models/report_schedule_response_attributes.rb', line 40

def resource_type
  @resource_type
end

#rruleObject

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



43
44
45
# File 'lib/datadog_api_client/v2/models/report_schedule_response_attributes.rb', line 43

def rrule
  @rrule
end

#statusObject

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



46
47
48
# File 'lib/datadog_api_client/v2/models/report_schedule_response_attributes.rb', line 46

def status
  @status
end

#tab_idObject

The identifier of the dashboard tab rendered in the report, or null if not set.



49
50
51
# File 'lib/datadog_api_client/v2/models/report_schedule_response_attributes.rb', line 49

def tab_id
  @tab_id
end

#template_variablesObject

The dashboard template variables applied when rendering the report.



52
53
54
# File 'lib/datadog_api_client/v2/models/report_schedule_response_attributes.rb', line 52

def template_variables
  @template_variables
end

#timeframeObject

The relative timeframe of data included in the report, or null if not set.



55
56
57
# File 'lib/datadog_api_client/v2/models/report_schedule_response_attributes.rb', line 55

def timeframe
  @timeframe
end

#timezoneObject

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



58
59
60
# File 'lib/datadog_api_client/v2/models/report_schedule_response_attributes.rb', line 58

def timezone
  @timezone
end

#titleObject

The title of the report.



61
62
63
# File 'lib/datadog_api_client/v2/models/report_schedule_response_attributes.rb', line 61

def title
  @title
end