Package com.datadog.api.client.v1.model

Class Dashboard

java.lang.Object
com.datadog.api.client.v1.model.Dashboard
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") public class Dashboard extends Object
A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.

  • Field Details

  • Constructor Details

  • Method Details

    • getAuthorHandle

      @Nullable public String getAuthorHandle()
      Identifier of the dashboard author.
      Returns:
      authorHandle

    • getAuthorName

      @Nullable public String getAuthorName()
      Name of the dashboard author.
      Returns:
      authorName

    • getAuthorName_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getAuthorName_JsonNullable()

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Creation date of the dashboard.
      Returns:
      createdAt

    • defaultTimeframe

      public Dashboard defaultTimeframe(DashboardDefaultTimeframeSetting defaultTimeframe)

    • getDefaultTimeframe

      @Nullable public DashboardDefaultTimeframeSetting getDefaultTimeframe()
      The default timeframe applied when opening the dashboard. Set to null to clear the dashboard's default timeframe.
      Returns:
      defaultTimeframe

    • setDefaultTimeframe

      public void setDefaultTimeframe(DashboardDefaultTimeframeSetting defaultTimeframe)

    • description

      public Dashboard description(String description)

    • getDescription

      @Nullable public String getDescription()
      Description of the dashboard.
      Returns:
      description

    • getDescription_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getDescription_JsonNullable()

    • setDescription_JsonNullable

      public void setDescription_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> description)

    • setDescription

      public void setDescription(String description)

    • getId

      @Nullable public String getId()
      ID of the dashboard.
      Returns:
      id

    • isReadOnly

      public Dashboard isReadOnly(Boolean isReadOnly)

    • getIsReadOnly

      @Deprecated @Nullable public Boolean getIsReadOnly()
      Deprecated.
      Whether this dashboard is read-only. If True, only the author and admins can make changes to it.

      This property is deprecated; please use the Restriction Policies API instead to manage write authorization for individual dashboards.

      Returns:
      isReadOnly

    • setIsReadOnly

      @Deprecated public void setIsReadOnly(Boolean isReadOnly)
      Deprecated.

    • layoutType

      public Dashboard layoutType(DashboardLayoutType layoutType)

    • getLayoutType

      public DashboardLayoutType getLayoutType()
      Layout type of the dashboard.
      Returns:
      layoutType

    • setLayoutType

      public void setLayoutType(DashboardLayoutType layoutType)

    • getModifiedAt

      @Nullable public OffsetDateTime getModifiedAt()
      Modification date of the dashboard.
      Returns:
      modifiedAt

    • notifyList

      public Dashboard notifyList(List<String> notifyList)

    • addNotifyListItem

      public Dashboard addNotifyListItem(String notifyListItem)

    • getNotifyList

      @Nullable public List<String> getNotifyList()
      List of handles of users to notify when changes are made to this dashboard.
      Returns:
      notifyList

    • getNotifyList_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getNotifyList_JsonNullable()

    • setNotifyList_JsonNullable

      public void setNotifyList_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> notifyList)

    • setNotifyList

      public void setNotifyList(List<String> notifyList)

    • reflowType

      public Dashboard reflowType(DashboardReflowType reflowType)

    • getReflowType

      @Nullable public DashboardReflowType getReflowType()
      Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts.
      Returns:
      reflowType

    • setReflowType

      public void setReflowType(DashboardReflowType reflowType)

    • restrictedRoles

      public Dashboard restrictedRoles(List<String> restrictedRoles)

    • addRestrictedRolesItem

      public Dashboard addRestrictedRolesItem(String restrictedRolesItem)

    • getRestrictedRoles

      @Nullable public List<String> getRestrictedRoles()
      A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
      Returns:
      restrictedRoles

    • setRestrictedRoles

      public void setRestrictedRoles(List<String> restrictedRoles)

    • tabs

      public Dashboard tabs(List<DashboardTab> tabs)

    • addTabsItem

      public Dashboard addTabsItem(DashboardTab tabsItem)

    • getTabs

      @Nullable public List<DashboardTab> getTabs()
      List of tabs for organizing dashboard widgets into groups.
      Returns:
      tabs

    • getTabs_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<DashboardTab>> getTabs_JsonNullable()

    • setTabs_JsonNullable

      public void setTabs_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<DashboardTab>> tabs)

    • setTabs

      public void setTabs(List<DashboardTab> tabs)

    • tags

      public Dashboard tags(List<String> tags)

    • addTagsItem

      public Dashboard addTagsItem(String tagsItem)

    • getTags

      @Nullable public List<String> getTags()
      List of team names representing ownership of a dashboard.
      Returns:
      tags

    • getTags_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getTags_JsonNullable()

    • setTags_JsonNullable

      public void setTags_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> tags)

    • setTags

      public void setTags(List<String> tags)

    • templateVariablePresets

      public Dashboard templateVariablePresets(List<DashboardTemplateVariablePreset> templateVariablePresets)

    • addTemplateVariablePresetsItem

      public Dashboard addTemplateVariablePresetsItem(DashboardTemplateVariablePreset templateVariablePresetsItem)

    • getTemplateVariablePresets

      @Nullable public List<DashboardTemplateVariablePreset> getTemplateVariablePresets()
      Array of template variables saved views.
      Returns:
      templateVariablePresets

    • getTemplateVariablePresets_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<DashboardTemplateVariablePreset>> getTemplateVariablePresets_JsonNullable()

    • setTemplateVariablePresets_JsonNullable

      public void setTemplateVariablePresets_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<DashboardTemplateVariablePreset>> templateVariablePresets)

    • setTemplateVariablePresets

      public void setTemplateVariablePresets(List<DashboardTemplateVariablePreset> templateVariablePresets)

    • templateVariables

      public Dashboard templateVariables(List<DashboardTemplateVariable> templateVariables)

    • addTemplateVariablesItem

      public Dashboard addTemplateVariablesItem(DashboardTemplateVariable templateVariablesItem)

    • getTemplateVariables

      @Nullable public List<DashboardTemplateVariable> getTemplateVariables()
      List of template variables for this dashboard.
      Returns:
      templateVariables

    • getTemplateVariables_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<DashboardTemplateVariable>> getTemplateVariables_JsonNullable()

    • setTemplateVariables_JsonNullable

      public void setTemplateVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<DashboardTemplateVariable>> templateVariables)

    • setTemplateVariables

      public void setTemplateVariables(List<DashboardTemplateVariable> templateVariables)

    • title

      public Dashboard title(String title)

    • getTitle

      public String getTitle()
      Title of the dashboard.
      Returns:
      title

    • setTitle

      public void setTitle(String title)

    • getUrl

      @Nullable public String getUrl()
      The URL of the dashboard.
      Returns:
      url

    • widgets

      public Dashboard widgets(List<Widget> widgets)

    • addWidgetsItem

      public Dashboard addWidgetsItem(Widget widgetsItem)

    • getWidgets

      public List<Widget> getWidgets()
      List of widgets to display on the dashboard.
      Returns:
      widgets

    • setWidgets

      public void setWidgets(List<Widget> widgets)

    • putAdditionalProperty

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

    • 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 Dashboard 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