Class: DatadogAPIClient::V2::ReportSchedulePatchRequestAttributes

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

Overview

The updated configuration of the report schedule. These values replace the existing ones; the targeted resource (resource_id and resource_type) cannot be changed.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

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.



27
28
29
 
# File 'lib/datadog_api_client/v2/models/report_schedule_patch_request_attributes.rb', line 27

def delivery_format
  @delivery_format
end

#description ⇒ Object

A description of the report, up to 4096 characters.



30
31
32
 
# File 'lib/datadog_api_client/v2/models/report_schedule_patch_request_attributes.rb', line 30

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}.



35
36
37
 
# File 'lib/datadog_api_client/v2/models/report_schedule_patch_request_attributes.rb', line 35

def recipients
  @recipients
end

#rrule ⇒ Object

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



38
39
40
 
# File 'lib/datadog_api_client/v2/models/report_schedule_patch_request_attributes.rb', line 38

def rrule
  @rrule
end

#tab_id ⇒ Object

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



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

def tab_id
  @tab_id
end

#template_variables ⇒ Object

The dashboard template variables applied when rendering the report.



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

def template_variables
  @template_variables
end

#timeframe ⇒ Object

The relative timeframe of data to include in the report.



47
48
49
 
# File 'lib/datadog_api_client/v2/models/report_schedule_patch_request_attributes.rb', line 47

def timeframe
  @timeframe
end

#timezone ⇒ Object

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



50
51
52
 
# File 'lib/datadog_api_client/v2/models/report_schedule_patch_request_attributes.rb', line 50

def timezone
  @timezone
end

#title ⇒ Object

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



53
54
55
 
# File 'lib/datadog_api_client/v2/models/report_schedule_patch_request_attributes.rb', line 53

def title
  @title
end