com.datadog.api.client.v2.model

Class DatasetReportScheduleResponseAttributes

java.lang.Object

com.datadog.api.client.v2.model.DatasetReportScheduleResponseAttributes

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

The configuration and derived state of a report schedule for a published dataset.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_CELL_ID
static String	JSON_PROPERTY_DATASET_ID
static String	JSON_PROPERTY_DESCRIPTION
static String	JSON_PROPERTY_FILE_ROW_LIMIT
static String	JSON_PROPERTY_INLINE_ROW_LIMIT
static String	JSON_PROPERTY_NEXT_RECURRENCE
static String	JSON_PROPERTY_NOTEBOOK_ID
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_TIMEFRAME
static String	JSON_PROPERTY_TIMEZONE
static String	JSON_PROPERTY_TITLE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
DatasetReportScheduleResponseAttributes()
DatasetReportScheduleResponseAttributes(String cellId, String datasetId, String description, Long fileRowLimit, Long inlineRowLimit, Long nextRecurrence, Long notebookId, List<String> recipients, String resourceId, DatasetReportScheduleResourceType resourceType, String rrule, ReportScheduleStatus status, String timeframe, String timezone, String title)

Method Summary

Modifier and Type	Method and Description
DatasetReportScheduleResponseAttributes	addRecipientsItem(String recipientsItem)
DatasetReportScheduleResponseAttributes	cellId(String cellId)
DatasetReportScheduleResponseAttributes	datasetId(String datasetId)
DatasetReportScheduleResponseAttributes	description(String description)
boolean	equals(Object o) Return true if this DatasetReportScheduleResponseAttributes object is equal to o.
DatasetReportScheduleResponseAttributes	fileRowLimit(Long fileRowLimit)
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
String	getCellId() The identifier of the notebook cell that published the dataset, or null if not set.
String	getDatasetId() The identifier of the dataset, or null if not set.
String	getDescription() The description of the report.
Long	getFileRowLimit() The maximum number of rows included in the attached CSV file, or null if not set.
Long	getInlineRowLimit() The maximum number of rows included inline in the email body, or null if not set.
Long	getNextRecurrence() The Unix timestamp, in milliseconds, of the next scheduled delivery, or null if none is scheduled.
Long	getNotebookId() The identifier of the notebook containing the dataset cell, or null if not set.
List<String>	getRecipients() The recipients of the report (email addresses, Slack channel references, or Microsoft Teams channel references).
String	getResourceId() The identifier of the widget containing the dataset.
DatasetReportScheduleResourceType	getResourceType() The type of resource targeted by a dataset report schedule.
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	getTimeframe() The relative timeframe of data included in the report.
String	getTimezone() The IANA time zone identifier the recurrence rule is evaluated in.
String	getTitle() The title of the report.
int	hashCode()
DatasetReportScheduleResponseAttributes	inlineRowLimit(Long inlineRowLimit)
DatasetReportScheduleResponseAttributes	nextRecurrence(Long nextRecurrence)
DatasetReportScheduleResponseAttributes	notebookId(Long notebookId)
DatasetReportScheduleResponseAttributes	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
DatasetReportScheduleResponseAttributes	recipients(List<String> recipients)
DatasetReportScheduleResponseAttributes	resourceId(String resourceId)
DatasetReportScheduleResponseAttributes	resourceType(DatasetReportScheduleResourceType resourceType)
DatasetReportScheduleResponseAttributes	rrule(String rrule)
void	setCellId(String cellId)
void	setDatasetId(String datasetId)
void	setDescription(String description)
void	setFileRowLimit(Long fileRowLimit)
void	setInlineRowLimit(Long inlineRowLimit)
void	setNextRecurrence(Long nextRecurrence)
void	setNotebookId(Long notebookId)
void	setRecipients(List<String> recipients)
void	setResourceId(String resourceId)
void	setResourceType(DatasetReportScheduleResourceType resourceType)
void	setRrule(String rrule)
void	setStatus(ReportScheduleStatus status)
void	setTimeframe(String timeframe)
void	setTimezone(String timezone)
void	setTitle(String title)
DatasetReportScheduleResponseAttributes	status(ReportScheduleStatus status)
DatasetReportScheduleResponseAttributes	timeframe(String timeframe)
DatasetReportScheduleResponseAttributes	timezone(String timezone)
DatasetReportScheduleResponseAttributes	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_CELL_ID

public static final String JSON_PROPERTY_CELL_ID

See Also:

Constant Field Values

JSON_PROPERTY_DATASET_ID

public static final String JSON_PROPERTY_DATASET_ID

See Also:

Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

Constant Field Values

JSON_PROPERTY_FILE_ROW_LIMIT

public static final String JSON_PROPERTY_FILE_ROW_LIMIT

See Also:

Constant Field Values

JSON_PROPERTY_INLINE_ROW_LIMIT

public static final String JSON_PROPERTY_INLINE_ROW_LIMIT

See Also:

Constant Field Values

JSON_PROPERTY_NEXT_RECURRENCE

public static final String JSON_PROPERTY_NEXT_RECURRENCE

See Also:

Constant Field Values

JSON_PROPERTY_NOTEBOOK_ID

public static final String JSON_PROPERTY_NOTEBOOK_ID

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

DatasetReportScheduleResponseAttributes

public DatasetReportScheduleResponseAttributes()

DatasetReportScheduleResponseAttributes

public DatasetReportScheduleResponseAttributes(String cellId,
                                               String datasetId,
                                               String description,
                                               Long fileRowLimit,
                                               Long inlineRowLimit,
                                               Long nextRecurrence,
                                               Long notebookId,
                                               List<String> recipients,
                                               String resourceId,
                                               DatasetReportScheduleResourceType resourceType,
                                               String rrule,
                                               ReportScheduleStatus status,
                                               String timeframe,
                                               String timezone,
                                               String title)

Method Detail

cellId

public DatasetReportScheduleResponseAttributes cellId(String cellId)

getCellId

@Nullable
public String getCellId()

The identifier of the notebook cell that published the dataset, or null if not set.

Returns:

cellId

setCellId

public void setCellId(String cellId)

datasetId

public DatasetReportScheduleResponseAttributes datasetId(String datasetId)

getDatasetId

@Nullable
public String getDatasetId()

The identifier of the dataset, or null if not set.

Returns:

datasetId

setDatasetId

public void setDatasetId(String datasetId)

description

public DatasetReportScheduleResponseAttributes description(String description)

getDescription

public String getDescription()

The description of the report.

Returns:

description

setDescription

public void setDescription(String description)

fileRowLimit

public DatasetReportScheduleResponseAttributes fileRowLimit(Long fileRowLimit)

getFileRowLimit

@Nullable
public Long getFileRowLimit()

The maximum number of rows included in the attached CSV file, or null if not set.

Returns:

fileRowLimit

setFileRowLimit

public void setFileRowLimit(Long fileRowLimit)

inlineRowLimit

public DatasetReportScheduleResponseAttributes inlineRowLimit(Long inlineRowLimit)

getInlineRowLimit

@Nullable
public Long getInlineRowLimit()

The maximum number of rows included inline in the email body, or null if not set.

Returns:

inlineRowLimit

setInlineRowLimit

public void setInlineRowLimit(Long inlineRowLimit)

nextRecurrence

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

notebookId

public DatasetReportScheduleResponseAttributes notebookId(Long notebookId)

getNotebookId

@Nullable
public Long getNotebookId()

The identifier of the notebook containing the dataset cell, or null if not set.

Returns:

notebookId

setNotebookId

public void setNotebookId(Long notebookId)

recipients

public DatasetReportScheduleResponseAttributes recipients(List<String> recipients)

addRecipientsItem

public DatasetReportScheduleResponseAttributes 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 DatasetReportScheduleResponseAttributes resourceId(String resourceId)

getResourceId

public String getResourceId()

The identifier of the widget containing the dataset.

Returns:

resourceId

setResourceId

public void setResourceId(String resourceId)

resourceType

public DatasetReportScheduleResponseAttributes resourceType(DatasetReportScheduleResourceType resourceType)

getResourceType

public DatasetReportScheduleResourceType getResourceType()

The type of resource targeted by a dataset report schedule.

Returns:

resourceType

setResourceType

public void setResourceType(DatasetReportScheduleResourceType resourceType)

rrule

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

timeframe

public DatasetReportScheduleResponseAttributes timeframe(String timeframe)

getTimeframe

public String getTimeframe()

The relative timeframe of data included in the report.

Returns:

timeframe

setTimeframe

public void setTimeframe(String timeframe)

timezone

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

getTitle

public String getTitle()

The title of the report.

Returns:

title

setTitle

public void setTitle(String title)

putAdditionalProperty

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

DatasetReportScheduleResponseAttributes

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