Package com.datadog.api.client.v2.model

Class AnnotationInPage

java.lang.Object
com.datadog.api.client.v2.model.AnnotationInPage
@Generated("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 Details

  • Constructor Details

  • Method Details

    • 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