AnnotationInPage (datadog-api-client 2.56.0 API)

java.lang.Object
- com.datadog.api.client.v2.model.AnnotationInPage

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

A flat annotation object as it appears within a page annotations response.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_PROPERTY_AUTHOR_ID`
`static String`	`JSON_PROPERTY_COLOR`
`static String`	`JSON_PROPERTY_CREATED_AT`
`static String`	`JSON_PROPERTY_DESCRIPTION`
`static String`	`JSON_PROPERTY_END_TIME`
`static String`	`JSON_PROPERTY_ID`
`static String`	`JSON_PROPERTY_MODIFIED_AT`
`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
`AnnotationInPage()`
`AnnotationInPage(String authorId, AnnotationColor color, Long createdAt, String description, Long endTime, UUID id, Long modifiedAt, String pageId, Long startTime, AnnotationKind type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnnotationInPage`	`addWidgetIdsItem(String widgetIdsItem)`
`AnnotationInPage`	`authorId(String authorId)`
`AnnotationInPage`	`color(AnnotationColor color)`
`AnnotationInPage`	`createdAt(Long createdAt)`
`AnnotationInPage`	`description(String description)`
`AnnotationInPage`	`endTime(Long endTime)`
`boolean`	`equals(Object o)` Return true if this AnnotationInPage 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.
`String`	`getAuthorId()` Identifier of the user who created the annotation.
`AnnotationColor`	`getColor()` Color used to render the annotation in the UI.
`Long`	`getCreatedAt()` Creation time of the annotation in milliseconds since the Unix epoch.
`String`	`getDescription()` User-defined text attached to the annotation.
`Long`	`getEndTime()` End time of the annotation in milliseconds since the Unix epoch.
`UUID`	`getId()` Unique identifier of the annotation.
`Long`	`getModifiedAt()` Last modification 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()`
`AnnotationInPage`	`id(UUID id)`
`AnnotationInPage`	`modifiedAt(Long modifiedAt)`
`AnnotationInPage`	`pageId(String pageId)`
`AnnotationInPage`	`putAdditionalProperty(String key, Object value)` Set the additional (undeclared) property with the specified name and value.
`void`	`setAuthorId(String authorId)`
`void`	`setColor(AnnotationColor color)`
`void`	`setCreatedAt(Long createdAt)`
`void`	`setDescription(String description)`
`void`	`setEndTime(Long endTime)`
`void`	`setId(UUID id)`
`void`	`setModifiedAt(Long modifiedAt)`
`void`	`setPageId(String pageId)`
`void`	`setStartTime(Long startTime)`
`void`	`setType(AnnotationKind type)`
`void`	`setWidgetIds(List<String> widgetIds)`
`AnnotationInPage`	`startTime(Long startTime)`
`String`	`toString()`
`AnnotationInPage`	`type(AnnotationKind type)`
`AnnotationInPage`	`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_AUTHOR_ID

public static final String JSON_PROPERTY_AUTHOR_ID

See Also:: Constant Field Values

JSON_PROPERTY_COLOR

public static final String JSON_PROPERTY_COLOR

See Also:: Constant Field Values

JSON_PROPERTY_CREATED_AT

public static final String JSON_PROPERTY_CREATED_AT

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_ID

public static final String JSON_PROPERTY_ID

See Also:: Constant Field Values

JSON_PROPERTY_MODIFIED_AT

public static final String JSON_PROPERTY_MODIFIED_AT

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

AnnotationInPage
```
public AnnotationInPage()
```

AnnotationInPage

public AnnotationInPage(String authorId,
                        AnnotationColor color,
                        Long createdAt,
                        String description,
                        Long endTime,
                        UUID id,
                        Long modifiedAt,
                        String pageId,
                        Long startTime,
                        AnnotationKind type)

Method Detail
- authorId
```
public AnnotationInPage authorId(String authorId)
```
- getAuthorId
```
public String getAuthorId()
```
  Identifier of the user who created the annotation.
  
  Returns:
  
  authorId
- setAuthorId
```
public void setAuthorId(String authorId)
```
- color
```
public AnnotationInPage color(AnnotationColor color)
```
- getColor
```
public AnnotationColor getColor()
```
  Color used to render the annotation in the UI.
  
  Returns:
  
  color
- setColor
```
public void setColor(AnnotationColor color)
```
- createdAt
```
public AnnotationInPage createdAt(Long createdAt)
```
- getCreatedAt
```
public Long getCreatedAt()
```
  Creation time of the annotation in milliseconds since the Unix epoch.
  
  Returns:
  
  createdAt
- setCreatedAt
```
public void setCreatedAt(Long createdAt)
```
- description
```
public AnnotationInPage description(String description)
```
- getDescription
```
public String getDescription()
```
  User-defined text attached to the annotation.
  
  Returns:
  
  description
- setDescription
```
public void setDescription(String description)
```
- endTime
```
public AnnotationInPage endTime(Long endTime)
```
- getEndTime
```
@Nullable
public Long getEndTime()
```
  End time of the annotation in milliseconds since the Unix epoch. Null for pointInTime annotations.
  
  Returns:
  
  endTime
- setEndTime
```
public void setEndTime(Long endTime)
```
- id
```
public AnnotationInPage id(UUID id)
```
- getId
```
public UUID getId()
```
  Unique identifier of the annotation.
  
  Returns:
  
  id
- setId
```
public void setId(UUID id)
```
- modifiedAt
```
public AnnotationInPage modifiedAt(Long modifiedAt)
```
- getModifiedAt
```
public Long getModifiedAt()
```
  Last modification time of the annotation in milliseconds since the Unix epoch.
  
  Returns:
  
  modifiedAt
- setModifiedAt
```
public void setModifiedAt(Long modifiedAt)
```
- pageId
```
public AnnotationInPage 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 AnnotationInPage 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 AnnotationInPage 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 AnnotationInPage widgetIds(List<String> widgetIds)
```
- addWidgetIdsItem
```
public AnnotationInPage 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 AnnotationInPage 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:
  
  AnnotationInPage
- 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 AnnotationInPage 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

Class AnnotationInPage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unparsed

JSON_PROPERTY_AUTHOR_ID

JSON_PROPERTY_COLOR

JSON_PROPERTY_CREATED_AT

JSON_PROPERTY_DESCRIPTION

JSON_PROPERTY_END_TIME

JSON_PROPERTY_ID

JSON_PROPERTY_MODIFIED_AT

JSON_PROPERTY_PAGE_ID

JSON_PROPERTY_START_TIME

JSON_PROPERTY_TYPE

JSON_PROPERTY_WIDGET_IDS

Constructor Detail

AnnotationInPage

AnnotationInPage

Method Detail

authorId

getAuthorId

setAuthorId

color

getColor

setColor

createdAt

getCreatedAt

setCreatedAt

description

getDescription

setDescription

endTime

getEndTime

setEndTime

id

getId

setId

modifiedAt

getModifiedAt

setModifiedAt

pageId

getPageId

setPageId

startTime

getStartTime

setStartTime

type

getType

setType

widgetIds

addWidgetIdsItem

getWidgetIds

setWidgetIds

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString