Class: DatadogAPIClient::V2::ReportScheduleCreateRequestAttributes

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

Overview

The configuration of the report schedule to create.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#delivery_format ⇒ Object

How a PDF-export report is delivered. pdf attaches a PDF file, png embeds an inline PNG image, and pdf_and_png delivers both.



26
27
28
 
# File 'lib/datadog_api_client/v2/models/report_schedule_create_request_attributes.rb', line 26

def delivery_format
  @delivery_format
end

#description ⇒ Object

A description of the report, up to 4096 characters.



29
30
31
 
# File 'lib/datadog_api_client/v2/models/report_schedule_create_request_attributes.rb', line 29

def description
  @description
end

#recipients ⇒ Object

The recipients of the report. Each entry is an email address, a Slack channel reference in the form slack:{team_id}.{channel_id}.{channel_name}, or a Microsoft Teams channel reference in the form teams:{tenant_id}|{team_id}|{channel_id}.



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

def recipients
  @recipients
end

#resource_id ⇒ Object

The identifier of the dashboard or integration dashboard to render in the report.



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

def resource_id
  @resource_id
end

#resource_type ⇒ Object

The type of dashboard resource the report schedule targets.



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

def resource_type
  @resource_type
end

#rrule ⇒ Object

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



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

def rrule
  @rrule
end

#tab_id ⇒ Object

The identifier of the dashboard tab to render, when the dashboard has tabs.



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

def tab_id
  @tab_id
end

#template_variables ⇒ Object

The dashboard template variables applied when rendering the report.



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

def template_variables
  @template_variables
end

#timeframe ⇒ Object

The relative timeframe of data to include in the report.



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

def timeframe
  @timeframe
end

#timezone ⇒ Object

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



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

def timezone
  @timezone
end

#title ⇒ Object

The title of the report, between 1 and 78 characters.



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

def title
  @title
end