com.datadog.api.client.v2.model

Class PrintReportRequestAttributes

java.lang.Object

com.datadog.api.client.v2.model.PrintReportRequestAttributes

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

The configuration for a print-only report. Specify exactly one of timeframe (for a relative time window) or both from_ts and to_ts (for an absolute time range).

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_FROM_TS
static String	JSON_PROPERTY_RESOURCE_ID
static String	JSON_PROPERTY_RESOURCE_TYPE
static String	JSON_PROPERTY_TEMPLATE_VARIABLES
static String	JSON_PROPERTY_TIMEFRAME
static String	JSON_PROPERTY_TIMEZONE
static String	JSON_PROPERTY_TO_TS
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
PrintReportRequestAttributes()
PrintReportRequestAttributes(String resourceId, ReportScheduleResourceType resourceType, List<ReportScheduleTemplateVariable> templateVariables, String timezone)

Method Summary

Modifier and Type	Method and Description
PrintReportRequestAttributes	addTemplateVariablesItem(ReportScheduleTemplateVariable templateVariablesItem)
boolean	equals(Object o) Return true if this PrintReportRequestAttributes object is equal to o.
PrintReportRequestAttributes	fromTs(Long fromTs)
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
Long	getFromTs() The start of an absolute time range, as a Unix timestamp in milliseconds.
String	getResourceId() The identifier of the dashboard or integration dashboard to render.
ReportScheduleResourceType	getResourceType() The type of dashboard resource the report schedule targets.
List<ReportScheduleTemplateVariable>	getTemplateVariables() The dashboard template variables applied when rendering the report.
String	getTimeframe() A relative time window (for example 1w or calendar_month).
String	getTimezone() The IANA time zone identifier used to evaluate the time window.
Long	getToTs() The end of an absolute time range, as a Unix timestamp in milliseconds.
int	hashCode()
PrintReportRequestAttributes	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
PrintReportRequestAttributes	resourceId(String resourceId)
PrintReportRequestAttributes	resourceType(ReportScheduleResourceType resourceType)
void	setFromTs(Long fromTs)
void	setResourceId(String resourceId)
void	setResourceType(ReportScheduleResourceType resourceType)
void	setTemplateVariables(List<ReportScheduleTemplateVariable> templateVariables)
void	setTimeframe(String timeframe)
void	setTimezone(String timezone)
void	setToTs(Long toTs)
PrintReportRequestAttributes	templateVariables(List<ReportScheduleTemplateVariable> templateVariables)
PrintReportRequestAttributes	timeframe(String timeframe)
PrintReportRequestAttributes	timezone(String timezone)
String	toString()
PrintReportRequestAttributes	toTs(Long toTs)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_FROM_TS

public static final String JSON_PROPERTY_FROM_TS

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

public static final String JSON_PROPERTY_TO_TS

See Also:

Constant Field Values

Constructor Detail

PrintReportRequestAttributes

public PrintReportRequestAttributes()

PrintReportRequestAttributes

public PrintReportRequestAttributes(String resourceId,
                                    ReportScheduleResourceType resourceType,
                                    List<ReportScheduleTemplateVariable> templateVariables,
                                    String timezone)

Method Detail

fromTs

public PrintReportRequestAttributes fromTs(Long fromTs)

getFromTs

@Nullable
public Long getFromTs()

The start of an absolute time range, as a Unix timestamp in milliseconds. Required when timeframe is omitted.

Returns:

fromTs

setFromTs

public void setFromTs(Long fromTs)

resourceId

public PrintReportRequestAttributes resourceId(String resourceId)

getResourceId

public String getResourceId()

The identifier of the dashboard or integration dashboard to render.

Returns:

resourceId

setResourceId

public void setResourceId(String resourceId)

resourceType

public PrintReportRequestAttributes resourceType(ReportScheduleResourceType resourceType)

getResourceType

public ReportScheduleResourceType getResourceType()

The type of dashboard resource the report schedule targets.

Returns:

resourceType

setResourceType

public void setResourceType(ReportScheduleResourceType resourceType)

templateVariables

public PrintReportRequestAttributes templateVariables(List<ReportScheduleTemplateVariable> templateVariables)

addTemplateVariablesItem

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

getTimeframe

@Nullable
public String getTimeframe()

A relative time window (for example 1w or calendar_month). Mutually exclusive with from_ts and to_ts.

Returns:

timeframe

setTimeframe

public void setTimeframe(String timeframe)

timezone

public PrintReportRequestAttributes timezone(String timezone)

getTimezone

public String getTimezone()

The IANA time zone identifier used to evaluate the time window.

Returns:

timezone

setTimezone

public void setTimezone(String timezone)

toTs

public PrintReportRequestAttributes toTs(Long toTs)

getToTs

@Nullable
public Long getToTs()

The end of an absolute time range, as a Unix timestamp in milliseconds. Required when timeframe is omitted.

Returns:

toTs

setToTs

public void setToTs(Long toTs)

putAdditionalProperty

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

PrintReportRequestAttributes

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