com.datadog.api.client.v2.model

Class ReportScheduleResponseAttributes

java.lang.Object

com.datadog.api.client.v2.model.ReportScheduleResponseAttributes

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

The configuration and derived state of a report schedule.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_DELIVERY_FORMAT
static String	JSON_PROPERTY_DESCRIPTION
static String	JSON_PROPERTY_NEXT_RECURRENCE
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_STATUS
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
ReportScheduleResponseAttributes()
ReportScheduleResponseAttributes(String description, Long nextRecurrence, List<String> recipients, String resourceId, ReportScheduleResourceType resourceType, String rrule, ReportScheduleStatus status, String tabId, List<ReportScheduleTemplateVariable> templateVariables, String timeframe, String timezone, String title)

Method Summary

Modifier and Type	Method and Description
ReportScheduleResponseAttributes	addRecipientsItem(String recipientsItem)
ReportScheduleResponseAttributes	addTemplateVariablesItem(ReportScheduleTemplateVariable templateVariablesItem)
ReportScheduleResponseAttributes	deliveryFormat(ReportScheduleResponseAttributesDeliveryFormat deliveryFormat)
ReportScheduleResponseAttributes	description(String description)
boolean	equals(Object o) Return true if this ReportScheduleResponseAttributes 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.
org.openapitools.jackson.nullable.JsonNullable<ReportScheduleResponseAttributesDeliveryFormat>	getDeliveryFormat_JsonNullable()
ReportScheduleResponseAttributesDeliveryFormat	getDeliveryFormat() The delivery format for dashboard report schedules, or null if not set.
String	getDescription() The description of the report.
Long	getNextRecurrence() The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.
List<String>	getRecipients() The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).
String	getResourceId() The identifier of the resource rendered 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.
ReportScheduleStatus	getStatus() Whether the schedule is currently delivering reports (active) or paused ( inactive).
String	getTabId() The identifier of the dashboard tab rendered in the report, or null if not set.
List<ReportScheduleTemplateVariable>	getTemplateVariables() The dashboard template variables applied when rendering the report.
String	getTimeframe() The relative timeframe of data included in the report, or null if not set.
String	getTimezone() The IANA time zone identifier the recurrence rule is evaluated in.
String	getTitle() The title of the report.
int	hashCode()
ReportScheduleResponseAttributes	nextRecurrence(Long nextRecurrence)
ReportScheduleResponseAttributes	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
ReportScheduleResponseAttributes	recipients(List<String> recipients)
ReportScheduleResponseAttributes	resourceId(String resourceId)
ReportScheduleResponseAttributes	resourceType(ReportScheduleResourceType resourceType)
ReportScheduleResponseAttributes	rrule(String rrule)
void	setDeliveryFormat_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<ReportScheduleResponseAttributesDeliveryFormat> deliveryFormat)
void	setDeliveryFormat(ReportScheduleResponseAttributesDeliveryFormat deliveryFormat)
void	setDescription(String description)
void	setNextRecurrence(Long nextRecurrence)
void	setRecipients(List<String> recipients)
void	setResourceId(String resourceId)
void	setResourceType(ReportScheduleResourceType resourceType)
void	setRrule(String rrule)
void	setStatus(ReportScheduleStatus status)
void	setTabId(String tabId)
void	setTemplateVariables(List<ReportScheduleTemplateVariable> templateVariables)
void	setTimeframe(String timeframe)
void	setTimezone(String timezone)
void	setTitle(String title)
ReportScheduleResponseAttributes	status(ReportScheduleStatus status)
ReportScheduleResponseAttributes	tabId(String tabId)
ReportScheduleResponseAttributes	templateVariables(List<ReportScheduleTemplateVariable> templateVariables)
ReportScheduleResponseAttributes	timeframe(String timeframe)
ReportScheduleResponseAttributes	timezone(String timezone)
ReportScheduleResponseAttributes	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_NEXT_RECURRENCE

public static final String JSON_PROPERTY_NEXT_RECURRENCE

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_STATUS

public static final String JSON_PROPERTY_STATUS

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

ReportScheduleResponseAttributes

public ReportScheduleResponseAttributes()

ReportScheduleResponseAttributes

public ReportScheduleResponseAttributes(String description,
                                        Long nextRecurrence,
                                        List<String> recipients,
                                        String resourceId,
                                        ReportScheduleResourceType resourceType,
                                        String rrule,
                                        ReportScheduleStatus status,
                                        String tabId,
                                        List<ReportScheduleTemplateVariable> templateVariables,
                                        String timeframe,
                                        String timezone,
                                        String title)

Method Detail

deliveryFormat

public ReportScheduleResponseAttributes deliveryFormat(ReportScheduleResponseAttributesDeliveryFormat deliveryFormat)

getDeliveryFormat

@Nullable
public ReportScheduleResponseAttributesDeliveryFormat getDeliveryFormat()

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

Returns:

deliveryFormat

getDeliveryFormat_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<ReportScheduleResponseAttributesDeliveryFormat> getDeliveryFormat_JsonNullable()

setDeliveryFormat_JsonNullable

public void setDeliveryFormat_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<ReportScheduleResponseAttributesDeliveryFormat> deliveryFormat)

setDeliveryFormat

public void setDeliveryFormat(ReportScheduleResponseAttributesDeliveryFormat deliveryFormat)

description

public ReportScheduleResponseAttributes description(String description)

getDescription

public String getDescription()

The description of the report.

Returns:

description

setDescription

public void setDescription(String description)

nextRecurrence

public ReportScheduleResponseAttributes nextRecurrence(Long nextRecurrence)

getNextRecurrence

@Nullable
public Long getNextRecurrence()

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

Returns:

nextRecurrence

setNextRecurrence

public void setNextRecurrence(Long nextRecurrence)

recipients

public ReportScheduleResponseAttributes recipients(List<String> recipients)

addRecipientsItem

public ReportScheduleResponseAttributes addRecipientsItem(String recipientsItem)

getRecipients

public List<String> getRecipients()

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

Returns:

recipients

setRecipients

public void setRecipients(List<String> recipients)

resourceId

public ReportScheduleResponseAttributes resourceId(String resourceId)

getResourceId

public String getResourceId()

The identifier of the resource rendered in the report.

Returns:

resourceId

setResourceId

public void setResourceId(String resourceId)

resourceType

public ReportScheduleResponseAttributes 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 ReportScheduleResponseAttributes 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)

status

public ReportScheduleResponseAttributes status(ReportScheduleStatus status)

getStatus

public ReportScheduleStatus getStatus()

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

Returns:

status

setStatus

public void setStatus(ReportScheduleStatus status)

tabId

public ReportScheduleResponseAttributes tabId(String tabId)

getTabId

@Nullable
public String getTabId()

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

Returns:

tabId

setTabId

public void setTabId(String tabId)

templateVariables

public ReportScheduleResponseAttributes templateVariables(List<ReportScheduleTemplateVariable> templateVariables)

addTemplateVariablesItem

public ReportScheduleResponseAttributes 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 ReportScheduleResponseAttributes timeframe(String timeframe)

getTimeframe

@Nullable
public String getTimeframe()

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

Returns:

timeframe

setTimeframe

public void setTimeframe(String timeframe)

timezone

public ReportScheduleResponseAttributes 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 ReportScheduleResponseAttributes title(String title)

getTitle

public String getTitle()

The title of the report.

Returns:

title

setTitle

public void setTitle(String title)

putAdditionalProperty

public ReportScheduleResponseAttributes 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:

ReportScheduleResponseAttributes

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 ReportScheduleResponseAttributes 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