com.datadog.api.client.v2.model

Class ReportScheduleCreateRequestAttributes

java.lang.Object

com.datadog.api.client.v2.model.ReportScheduleCreateRequestAttributes

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class ReportScheduleCreateRequestAttributes
extends Object

The configuration of the report schedule to create.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_DELIVERY_FORMAT
static String	JSON_PROPERTY_DESCRIPTION
static String	JSON_PROPERTY_RECIPIENTS
static String	JSON_PROPERTY_RESOURCE_ID
static String	JSON_PROPERTY_RESOURCE_TYPE
static String	JSON_PROPERTY_RRULE
static String	JSON_PROPERTY_TAB_ID
static String	JSON_PROPERTY_TEMPLATE_VARIABLES
static String	JSON_PROPERTY_TIMEFRAME
static String	JSON_PROPERTY_TIMEZONE
static String	JSON_PROPERTY_TITLE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ReportScheduleCreateRequestAttributes()
ReportScheduleCreateRequestAttributes(String description, List<String> recipients, String resourceId, ReportScheduleResourceType resourceType, String rrule, List<ReportScheduleTemplateVariable> templateVariables, String timeframe, String timezone, String title)

Method Summary

Modifier and Type	Method and Description
ReportScheduleCreateRequestAttributes	addRecipientsItem(String recipientsItem)
ReportScheduleCreateRequestAttributes	addTemplateVariablesItem(ReportScheduleTemplateVariable templateVariablesItem)
ReportScheduleCreateRequestAttributes	deliveryFormat(ReportScheduleDeliveryFormat deliveryFormat)
ReportScheduleCreateRequestAttributes	description(String description)
boolean	equals(Object o) Return true if this ReportScheduleCreateRequestAttributes object is equal to o.
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
ReportScheduleDeliveryFormat	getDeliveryFormat() How a PDF-export report is delivered.
String	getDescription() A description of the report, up to 4096 characters.
List<String>	getRecipients() The recipients of the report.
String	getResourceId() The identifier of the dashboard or integration dashboard to render in the report.
ReportScheduleResourceType	getResourceType() The type of dashboard resource the report schedule targets.
String	getRrule() The recurrence rule for the schedule, expressed as an iCalendar RRULE string.
UUID	getTabId() The identifier of the dashboard tab to render, when the dashboard has tabs.
List<ReportScheduleTemplateVariable>	getTemplateVariables() The dashboard template variables applied when rendering the report.
String	getTimeframe() The relative timeframe of data to include in the report.
String	getTimezone() The IANA time zone identifier the recurrence rule is evaluated in.
String	getTitle() The title of the report, between 1 and 78 characters.
int	hashCode()
ReportScheduleCreateRequestAttributes	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
ReportScheduleCreateRequestAttributes	recipients(List<String> recipients)
ReportScheduleCreateRequestAttributes	resourceId(String resourceId)
ReportScheduleCreateRequestAttributes	resourceType(ReportScheduleResourceType resourceType)
ReportScheduleCreateRequestAttributes	rrule(String rrule)
void	setDeliveryFormat(ReportScheduleDeliveryFormat deliveryFormat)
void	setDescription(String description)
void	setRecipients(List<String> recipients)
void	setResourceId(String resourceId)
void	setResourceType(ReportScheduleResourceType resourceType)
void	setRrule(String rrule)
void	setTabId(UUID tabId)
void	setTemplateVariables(List<ReportScheduleTemplateVariable> templateVariables)
void	setTimeframe(String timeframe)
void	setTimezone(String timezone)
void	setTitle(String title)
ReportScheduleCreateRequestAttributes	tabId(UUID tabId)
ReportScheduleCreateRequestAttributes	templateVariables(List<ReportScheduleTemplateVariable> templateVariables)
ReportScheduleCreateRequestAttributes	timeframe(String timeframe)
ReportScheduleCreateRequestAttributes	timezone(String timezone)
ReportScheduleCreateRequestAttributes	title(String title)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_DELIVERY_FORMAT

public static final String JSON_PROPERTY_DELIVERY_FORMAT

See Also:

Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

Constant Field Values

JSON_PROPERTY_RECIPIENTS

public static final String JSON_PROPERTY_RECIPIENTS

See Also:

Constant Field Values

JSON_PROPERTY_RESOURCE_ID

public static final String JSON_PROPERTY_RESOURCE_ID

See Also:

Constant Field Values

JSON_PROPERTY_RESOURCE_TYPE

public static final String JSON_PROPERTY_RESOURCE_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_RRULE

public static final String JSON_PROPERTY_RRULE

See Also:

Constant Field Values

JSON_PROPERTY_TAB_ID

public static final String JSON_PROPERTY_TAB_ID

See Also:

Constant Field Values

JSON_PROPERTY_TEMPLATE_VARIABLES

public static final String JSON_PROPERTY_TEMPLATE_VARIABLES

See Also:

Constant Field Values

JSON_PROPERTY_TIMEFRAME

public static final String JSON_PROPERTY_TIMEFRAME

See Also:

Constant Field Values

JSON_PROPERTY_TIMEZONE

public static final String JSON_PROPERTY_TIMEZONE

See Also:

Constant Field Values

JSON_PROPERTY_TITLE

public static final String JSON_PROPERTY_TITLE

See Also:

Constant Field Values

Constructor Detail

ReportScheduleCreateRequestAttributes

public ReportScheduleCreateRequestAttributes()

ReportScheduleCreateRequestAttributes

public ReportScheduleCreateRequestAttributes(String description,
                                             List<String> recipients,
                                             String resourceId,
                                             ReportScheduleResourceType resourceType,
                                             String rrule,
                                             List<ReportScheduleTemplateVariable> templateVariables,
                                             String timeframe,
                                             String timezone,
                                             String title)

Method Detail

deliveryFormat

public ReportScheduleCreateRequestAttributes deliveryFormat(ReportScheduleDeliveryFormat deliveryFormat)

getDeliveryFormat

@Nullable
public ReportScheduleDeliveryFormat getDeliveryFormat()

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

Returns:

deliveryFormat

setDeliveryFormat

public void setDeliveryFormat(ReportScheduleDeliveryFormat deliveryFormat)

description

public ReportScheduleCreateRequestAttributes description(String description)

getDescription

public String getDescription()

A description of the report, up to 4096 characters.

Returns:

description

setDescription

public void setDescription(String description)

recipients

public ReportScheduleCreateRequestAttributes recipients(List<String> recipients)

addRecipientsItem

public ReportScheduleCreateRequestAttributes addRecipientsItem(String recipientsItem)

getRecipients

public List<String> getRecipients()

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

Returns:

recipients

setRecipients

public void setRecipients(List<String> recipients)

resourceId

public ReportScheduleCreateRequestAttributes resourceId(String resourceId)

getResourceId

public String getResourceId()

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

Returns:

resourceId

setResourceId

public void setResourceId(String resourceId)

resourceType

public ReportScheduleCreateRequestAttributes resourceType(ReportScheduleResourceType resourceType)

getResourceType

public ReportScheduleResourceType getResourceType()

The type of dashboard resource the report schedule targets.

Returns:

resourceType

setResourceType

public void setResourceType(ReportScheduleResourceType resourceType)

rrule

public ReportScheduleCreateRequestAttributes rrule(String rrule)

getRrule

public String getRrule()

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

Returns:

rrule

setRrule

public void setRrule(String rrule)

tabId

public ReportScheduleCreateRequestAttributes tabId(UUID tabId)

getTabId

@Nullable
public UUID getTabId()

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

Returns:

tabId

setTabId

public void setTabId(UUID tabId)

templateVariables

public ReportScheduleCreateRequestAttributes templateVariables(List<ReportScheduleTemplateVariable> templateVariables)

addTemplateVariablesItem

public ReportScheduleCreateRequestAttributes addTemplateVariablesItem(ReportScheduleTemplateVariable templateVariablesItem)

getTemplateVariables

public List<ReportScheduleTemplateVariable> getTemplateVariables()

The dashboard template variables applied when rendering the report.

Returns:

templateVariables

setTemplateVariables

public void setTemplateVariables(List<ReportScheduleTemplateVariable> templateVariables)

timeframe

public ReportScheduleCreateRequestAttributes timeframe(String timeframe)

getTimeframe

public String getTimeframe()

The relative timeframe of data to include in the report.

Returns:

timeframe

setTimeframe

public void setTimeframe(String timeframe)

timezone

public ReportScheduleCreateRequestAttributes timezone(String timezone)

getTimezone

public String getTimezone()

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

Returns:

timezone

setTimezone

public void setTimezone(String timezone)

title

public ReportScheduleCreateRequestAttributes title(String title)

getTitle

public String getTitle()

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

Returns:

title

setTitle

public void setTitle(String title)

putAdditionalProperty

public ReportScheduleCreateRequestAttributes putAdditionalProperty(String key,
                                                                   Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - The arbitrary key to set

value - The associated value

Returns:

ReportScheduleCreateRequestAttributes

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

The additional properties

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - The arbitrary key to get

Returns:

The specific additional property for the given key

equals

public boolean equals(Object o)

Return true if this ReportScheduleCreateRequestAttributes object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object