com.datadog.api.client.v2.model

Class AnnotationCreateAttributes

java.lang.Object

com.datadog.api.client.v2.model.AnnotationCreateAttributes

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

Attributes for creating or updating an annotation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_COLOR
static String	JSON_PROPERTY_DESCRIPTION
static String	JSON_PROPERTY_END_TIME
static String	JSON_PROPERTY_PAGE_ID
static String	JSON_PROPERTY_START_TIME
static String	JSON_PROPERTY_TYPE
static String	JSON_PROPERTY_WIDGET_IDS
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
AnnotationCreateAttributes()
AnnotationCreateAttributes(AnnotationColor color, String description, String pageId, Long startTime, AnnotationKind type)

Method Summary

Modifier and Type	Method and Description
AnnotationCreateAttributes	addWidgetIdsItem(String widgetIdsItem)
AnnotationCreateAttributes	color(AnnotationColor color)
AnnotationCreateAttributes	description(String description)
AnnotationCreateAttributes	endTime(Long endTime)
boolean	equals(Object o) Return true if this AnnotationCreateAttributes 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.
AnnotationColor	getColor() Color used to render the annotation in the UI.
String	getDescription() User-defined text attached to the annotation.
org.openapitools.jackson.nullable.JsonNullable<Long>	getEndTime_JsonNullable()
Long	getEndTime() End time of the annotation in milliseconds since the Unix epoch.
String	getPageId() ID of the page the annotation belongs to, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890).
Long	getStartTime() Start time of the annotation in milliseconds since the Unix epoch.
AnnotationKind	getType() Kind of annotation.
List<String>	getWidgetIds() IDs of widgets the annotation is associated with.
int	hashCode()
AnnotationCreateAttributes	pageId(String pageId)
AnnotationCreateAttributes	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setColor(AnnotationColor color)
void	setDescription(String description)
void	setEndTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> endTime)
void	setEndTime(Long endTime)
void	setPageId(String pageId)
void	setStartTime(Long startTime)
void	setType(AnnotationKind type)
void	setWidgetIds(List<String> widgetIds)
AnnotationCreateAttributes	startTime(Long startTime)
String	toString()
AnnotationCreateAttributes	type(AnnotationKind type)
AnnotationCreateAttributes	widgetIds(List<String> widgetIds)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_COLOR

public static final String JSON_PROPERTY_COLOR

See Also:

Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

Constant Field Values

JSON_PROPERTY_END_TIME

public static final String JSON_PROPERTY_END_TIME

See Also:

Constant Field Values

JSON_PROPERTY_PAGE_ID

public static final String JSON_PROPERTY_PAGE_ID

See Also:

Constant Field Values

JSON_PROPERTY_START_TIME

public static final String JSON_PROPERTY_START_TIME

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_WIDGET_IDS

public static final String JSON_PROPERTY_WIDGET_IDS

See Also:

Constant Field Values

Constructor Detail

AnnotationCreateAttributes

public AnnotationCreateAttributes()

AnnotationCreateAttributes

public AnnotationCreateAttributes(AnnotationColor color,
                                  String description,
                                  String pageId,
                                  Long startTime,
                                  AnnotationKind type)

Method Detail

color

public AnnotationCreateAttributes color(AnnotationColor color)

getColor

public AnnotationColor getColor()

Color used to render the annotation in the UI.

Returns:

color

setColor

public void setColor(AnnotationColor color)

description

public AnnotationCreateAttributes description(String description)

getDescription

public String getDescription()

User-defined text attached to the annotation.

Returns:

description

setDescription

public void setDescription(String description)

endTime

public AnnotationCreateAttributes endTime(Long endTime)

getEndTime

@Nullable
public Long getEndTime()

End time of the annotation in milliseconds since the Unix epoch. Required for timeRegion annotations; omit or set to null for pointInTime annotations.

Returns:

endTime

getEndTime_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Long> getEndTime_JsonNullable()

setEndTime_JsonNullable

public void setEndTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> endTime)

setEndTime

public void setEndTime(Long endTime)

pageId

public AnnotationCreateAttributes pageId(String pageId)

getPageId

public String getPageId()

ID of the page the annotation belongs to, prefixed with the page type and joined by a colon (for example, dashboard:abc-def-xyz or notebook:1234567890).

Returns:

pageId

setPageId

public void setPageId(String pageId)

startTime

public AnnotationCreateAttributes startTime(Long startTime)

getStartTime

public Long getStartTime()

Start time of the annotation in milliseconds since the Unix epoch.

Returns:

startTime

setStartTime

public void setStartTime(Long startTime)

type

public AnnotationCreateAttributes type(AnnotationKind type)

getType

public AnnotationKind getType()

Kind of annotation. pointInTime annotations mark a single moment in time, while timeRegion annotations span a window of time and require an end_time.

Returns:

type

setType

public void setType(AnnotationKind type)

widgetIds

public AnnotationCreateAttributes widgetIds(List<String> widgetIds)

addWidgetIdsItem

public AnnotationCreateAttributes addWidgetIdsItem(String widgetIdsItem)

getWidgetIds

@Nullable
public List<String> getWidgetIds()

IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.

Returns:

widgetIds

setWidgetIds

public void setWidgetIds(List<String> widgetIds)

putAdditionalProperty

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

AnnotationCreateAttributes

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